Skip to content

Commit f296090

Browse files
committed
docs: add tarfile support
Signed-off-by: AtomicFS <vojtech.vesely@9elements.com>
1 parent a7495b7 commit f296090

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

cmd/firmware-action/recipes/config.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ type CommonOpts struct {
4545
// This has an influence on the IASL, GCC and host GCC version that is used to build
4646
// the target. You must match the source level and sdk_version.
4747
// Can also be a absolute or relative path to Dockerfile to build the image on the fly.
48+
// Can also be a path to tarfile.
4849
// NOTE: Updating the sdk_version might result in different binaries using the
4950
// same source code.
5051
// ANCHOR: CommonOptsSdkURLExamples
@@ -57,6 +58,7 @@ type CommonOpts struct {
5758
// file://my-image/Dockerfile
5859
// file:///home/user/my-image/Dockerfile
5960
// file:///home/user/my-image/
61+
// file:///home/user/ubuntu-latest.tar
6062
// ANCHOR_END: CommonOptsSdkURLExamples
6163
// NOTE:
6264
// 'file://' path cannot contain '..'

docs/src/firmware-action/offline_usage.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Offline usage
22

3+
4+
## Occasionally offline machines
5+
6+
This approach is useful for example when people travel. They run `firmware-action` beforehand to pull the necessary containers and then use this method to work offline.
7+
38
`firmware-action` under the hood uses [dagger](https://docs.dagger.io/) / docker. As such, the configuration contains entry `sdk_url` which specifies the docker image / container to use.
49

510
```admonish example
@@ -31,3 +36,16 @@ It will also be displayed every time `firmware-action` is executed as `INFO` mes
3136
```
3237

3338
Simply copy-paste the digest (or image reference) into your configuration file and `firmware-action` will not connect to the internet to fetch a container if one matching is already present.
39+
40+
41+
## Always offline machines
42+
43+
Besides running a offline docker registry, there is also a option to use tarballs.
44+
45+
`firmware-action` can import a tarfile and use it.
46+
47+
```admonish example
48+
~~~json
49+
"sdk_url": "file:///home/user/my-image/ubuntu-latest.tar"
50+
~~~
51+
```

0 commit comments

Comments
 (0)