Skip to content

Commit 6af5ddb

Browse files
ItxakaItxaka
authored
fix: Update container image prefix from docker to oci (#488)
- Changed `container_image` prefix from `docker://` to `oci:` in multiple documentation files to reflect the new image pulling method. - This change ensures compatibility with OCI standards and improves the image retrieval process. Signed-off-by: Itxaka <itxaka@kairos.io>
1 parent 48d2864 commit 6af5ddb

File tree

10 files changed

+41
-41
lines changed

10 files changed

+41
-41
lines changed

‎content/en/docs/Advanced/sys-extensions.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -220,15 +220,15 @@ kairos-agent sysext install <URI>
220220

221221
**Supported URI formats:**
222222

223-
- `https://` – Download a raw disk image from a remote server
224-
- `http://` – Same as above, unencrypted
225-
- `file://` – Load a local disk image file
226-
- `oci://` – Download from an OCI-compatible container registry
223+
- `https:` – Download a raw disk image from a remote server
224+
- `http:` – Same as above, unencrypted
225+
- `file:` – Load a local disk image file
226+
- `oci:` – Download from an OCI-compatible container registry
227227

228228
> ⚠️ **Important Notes:**
229-
> - `http(s)` and `file://` URIs must point directly to a raw disk image file.
230-
> - `oci://` support is **alpha-stage** and may change.
231-
> - When using `oci://`, the disk image must be **embedded inside the OCI image layer**.
229+
> - `http(s)` and `file:` URIs must point directly to a raw disk image file.
230+
> - `oci:` support is **alpha-stage** and may change.
231+
> - When using `oci:`, the disk image must be **embedded inside the OCI image layer**.
232232
233233
---
234234

‎content/en/docs/Development/development.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To build a Kairos ISO, you just call AuroraBoot with the generated OCI artifact:
3434

3535
```bash
3636
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v $PWD/build/:/output \
37-
quay.io/kairos/auroraboot:v0.5.0 build-iso --output /output/ docker:myBaseKairos:v1.0.0
37+
quay.io/kairos/auroraboot:v0.5.0 build-iso --output /output/ oci:myBaseKairos:v1.0.0
3838
```
3939

4040
You can see some example of builds in either the [kairos-init repo](https://github.com/kairos-io/kairos-init/blob/main/.github/workflows/test.yml), which builds a series of OCI containers of different base images, variants and platforms or on the [Kairos repo](https://github.com/kairos-io/kairos/tree/master/.github/workflows) itself which generates not only different types of platforms and variants and base images but also generates different types of artifacts, like ISOs, Trusted Boot ISOs, Trusted Boot upgrade artifacts, raw disk images and so on.

‎content/en/docs/Examples/airgap.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ docker run -v $PWD/config.yaml:/config.yaml \
104104
--rm -ti quay.io/kairos/auroraboot:{{< auroraBootVersion >}} \
105105
--set "disable_http_server=true" \
106106
--set "disable_netboot=true" \
107-
--set "container_image=docker://$IMAGE" \
107+
--set "container_image=oci:$IMAGE" \
108108
--set "iso.data=/tmp/data" \
109109
--cloud-config /config.yaml \
110110
--set "state_dir=/tmp/auroraboot"

‎content/en/docs/Examples/core.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For example, let's say you want to use a standard image. Your cloud config file
1818
#cloud-config
1919
install:
2020
# Here we specify the image that we want to deploy
21-
source: "docker:{{<oci variant="standard">}}"
21+
source: "oci:{{<oci variant="standard">}}"
2222
```
2323
2424
{{% alert title="Note" color="success" %}}
@@ -38,7 +38,7 @@ install:
3838
auto: true
3939
reboot: true
4040
# Here we specify the image that we want to deploy
41-
source: "docker:{{<oci variant="standard">}}"
41+
source: "oci:{{<oci variant="standard">}}"
4242

4343
hostname: "test"
4444
users:

‎content/en/docs/Examples/k3s-stages.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ $ docker build -t k3s-stage-kairos .
8080
Again, this tutorial does not cover this part deeply as there already are docs that provide a deep insight into custom images such as the the [AuroraBoot page]({{< ref "auroraboot.md" >}}).
8181
8282
```bash
83-
$ docker run -v "$PWD"/build-iso:/tmp/auroraboot -v /var/run/docker.sock:/var/run/docker.sock --rm -ti quay.io/kairos/auroraboot --set container_image="docker://k3s-stage-kairos" --set "disable_http_server=true" --set "disable_netboot=true" --set "state_dir=/tmp/auroraboot"
83+
$ docker run -v "$PWD"/build-iso:/tmp/auroraboot -v /var/run/docker.sock:/var/run/docker.sock --rm -ti quay.io/kairos/auroraboot --set container_image="oci:k3s-stage-kairos" --set "disable_http_server=true" --set "disable_netboot=true" --set "state_dir=/tmp/auroraboot"
8484
2:38PM INF Pulling container image 'k3s-stage-kairos' to '/tmp/auroraboot/temp-rootfs' (local: true)
8585
2:38PM INF Generating iso 'kairos' from '/tmp/auroraboot/temp-rootfs' to '/tmp/auroraboot/build'
8686
```

‎content/en/docs/Examples/kdump.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ $ docker build -t kdump-kairos .
8787
Again, this tutorial does not cover this part deeply as there are docs providing a deep insight onto this like the [AuroraBoot page]({{< ref "auroraboot.md" >}})
8888

8989
```bash
90-
$ docker run -v "$PWD"/build-iso:/tmp/auroraboot -v /var/run/docker.sock:/var/run/docker.sock --rm -ti quay.io/kairos/auroraboot --set container_image="docker://kdump-kairos" --set "disable_http_server=true" --set "disable_netboot=true" --set "state_dir=/tmp/auroraboot"
90+
$ docker run -v "$PWD"/build-iso:/tmp/auroraboot -v /var/run/docker.sock:/var/run/docker.sock --rm -ti quay.io/kairos/auroraboot --set container_image="oci:kdump-kairos" --set "disable_http_server=true" --set "disable_netboot=true" --set "state_dir=/tmp/auroraboot"
9191
2:38PM INF Pulling container image 'kdump-kairos' to '/tmp/auroraboot/temp-rootfs' (local: true)
9292
2:38PM INF Generating iso 'kairos' from '/tmp/auroraboot/temp-rootfs' to '/tmp/auroraboot/build'
9393
```

‎content/en/docs/Examples/virtual-box.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ buildISO() {
105105
--boot-branding "KairosAI" \
106106
--overlay-iso /config \
107107
--extend-cmdline "rd.immucore.debug rd.debug rd.shell" \
108-
oci://kairos-localai
108+
oci:kairos-localai
109109
}
110110

111111
fixPermissions() {

‎content/en/docs/Installation/automated.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ $ docker run -v $PWD/cloud_init.yaml:/cloud_init.yaml \
112112
-v $PWD/build:/tmp/auroraboot \
113113
-v /var/run/docker.sock:/var/run/docker.sock \
114114
--rm -ti quay.io/kairos/auroraboot \
115-
--set container_image=docker://$IMAGE \
115+
--set container_image=oci:$IMAGE \
116116
--set "disable_http_server=true" \
117117
--set "disable_netboot=true" \
118118
--cloud-config /cloud_init.yaml \

‎content/en/docs/Reference/auroraboot.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -131,15 +131,15 @@ docker run --rm -ti --net host quay.io/kairos/auroraboot \
131131
{{% /tab %}}
132132
{{% tab header="Container Image, with dockerd" %}}
133133

134-
By indicating a `container_image` prefixed with `docker://`, AuroraBoot will pull the image from the local daemon and start to serve it for network booting.
134+
By indicating a `container_image` prefixed with `oci:`, AuroraBoot will pull the image from the local daemon and start to serve it for network booting.
135135

136136
This implies that the host has a docker daemon, and we have to give access to its socket with `-v /var/run/docker.sock:/var/run/docker.sock`.
137137

138138
```bash
139139
docker pull {{<oci variant="standard">}}
140140
# This will use the container image from the host's docker daemon
141141
docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock --net host quay.io/kairos/auroraboot \
142-
--set "container_image=docker://{{<oci variant="standard">}}"
142+
--set "container_image=oci:{{<oci variant="standard">}}"
143143
```
144144
{{% /tab %}}
145145
{{% tab header="Github releases" %}}
@@ -376,27 +376,27 @@ listen_addr: ":8080"
376376
cloud_config: |
377377
```
378378
379-
| Option | Description |
380-
|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
381-
| `artifact_version` | Corresponding artifact versions from the Kairos release page (e.g. Kubernetes version included). |
382-
| `release_version` | Version of the release in GitHub. |
383-
| `flavor` | The Kairos flavor to use. See [the Kairos support matrix]({{< relref "../reference/image_matrix" >}}) for a list. |
384-
| `repository` | Github repository to use. This can either be `kairos-io/kairos` or `kairos-io/provider-kairos` for images with `k3s` prior to v2.4.0. |
385-
| `container_image` | Container image. If prefixed with `docker://` it will try to pull from the local docker daemon. If a `container_image` is specified, `artifact_version`, `flavor` and `release_version` are ignored. |
386-
| `disable_netboot` | Disable netboot. |
387-
| `disable_http_server` | Disable http server for serving offline generated ISOs. |
388-
| `netboot_http_port` | Specify a netboot HTTP port (defaults to `8090`). |
389-
| `state_dir` | Specify a directory that will be used by auroraboot to download artifacts and reuse the same to cache artifacts. |
390-
| `listen_addr` | Default http binding port for offline ISO generation. |
391-
| `cloud_config` | Cloud config path to use for the machines. A URL can be specified, use `-` to pass-by the cloud-config from _STDIN_ |
392-
| `iso.data` | Defines a path to be embedded into the resulting iso. When booting, the files will be accessible at `/run/initramfs/live` |
393-
| `netboot.cmdline` | Override the automatically generated cmdline with a custom one to use during netboot. `config_url` and `rootfs` are automatically constructed. A reasonable value can be `netboot.cmdline=rd.neednet=1 ip=dhcp rd.cos.disable netboot install-mode console=tty0` |
379+
| Option | Description |
380+
|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
381+
| `artifact_version` | Corresponding artifact versions from the Kairos release page (e.g. Kubernetes version included). |
382+
| `release_version` | Version of the release in GitHub. |
383+
| `flavor` | The Kairos flavor to use. See [the Kairos support matrix]({{< relref "../reference/image_matrix" >}}) for a list. |
384+
| `repository` | Github repository to use. This can either be `kairos-io/kairos` or `kairos-io/provider-kairos` for images with `k3s` prior to v2.4.0. |
385+
| `container_image` | Container image. It will try to pull from the local docker daemon first and fallback to remote if not found. If a `container_image` is specified, `artifact_version`, `flavor` and `release_version` are ignored. |
386+
| `disable_netboot` | Disable netboot. |
387+
| `disable_http_server` | Disable http server for serving offline generated ISOs. |
388+
| `netboot_http_port` | Specify a netboot HTTP port (defaults to `8090`). |
389+
| `state_dir` | Specify a directory that will be used by auroraboot to download artifacts and reuse the same to cache artifacts. |
390+
| `listen_addr` | Default http binding port for offline ISO generation. |
391+
| `cloud_config` | Cloud config path to use for the machines. A URL can be specified, use `-` to pass-by the cloud-config from _STDIN_ |
392+
| `iso.data` | Defines a path to be embedded into the resulting iso. When booting, the files will be accessible at `/run/initramfs/live` |
393+
| `netboot.cmdline` | Override the automatically generated cmdline with a custom one to use during netboot. `config_url` and `rootfs` are automatically constructed. A reasonable value can be `netboot.cmdline=rd.neednet=1 ip=dhcp rd.cos.disable netboot install-mode console=tty0` |
394394
| `disk.state_size` | Set the minimum size (in MB) for the state partition in raw disk images. By default, the state partition is sized to 3 times the size of the current image plus some additional space for system files. Use this option to override the default size if you need to accommodate larger future images. |
395-
| `disk.efi` | Generate an EFI-compatible raw disk image (suitable for AWS and QEMU). When set to `true`, the image will be created with EFI boot support. |
396-
| `disk.size` | Set the final size (in MB) of the generated disk image. By default, the image size is calculated based on the actual data size. Use this option to create a larger disk image (e.g. `disk.size=16000` will create a 16GB image). |
397-
| `disk.bios` | Generate a BIOS-compatible raw disk image. When set to `true`, the image will be created with legacy BIOS boot support instead of EFI. |
398-
| `disk.vhd` | Generate an Azure-compatible VHD image. When set to `true`, the image will be created in VHD format suitable for Azure cloud platform. |
399-
| `disk.gce` | Generate a Google Cloud Engine (GCE) compatible image. When set to `true`, the image will be created in a format suitable for Google Cloud Platform. |
395+
| `disk.efi` | Generate an EFI-compatible raw disk image (suitable for AWS and QEMU). When set to `true`, the image will be created with EFI boot support. |
396+
| `disk.size` | Set the final size (in MB) of the generated disk image. By default, the image size is calculated based on the actual data size. Use this option to create a larger disk image (e.g. `disk.size=16000` will create a 16GB image). |
397+
| `disk.bios` | Generate a BIOS-compatible raw disk image. When set to `true`, the image will be created with legacy BIOS boot support instead of EFI. |
398+
| `disk.vhd` | Generate an Azure-compatible VHD image. When set to `true`, the image will be created in VHD format suitable for Azure cloud platform. |
399+
| `disk.gce` | Generate a Google Cloud Engine (GCE) compatible image. When set to `true`, the image will be created in a format suitable for Google Cloud Platform. |
400400
To use the configuration file with AuroraBoot, run AuroraBoot specifying the file or URL of the config as first argument:
401401

402402
```bash
@@ -524,7 +524,7 @@ docker run -v "$PWD"/config.yaml:/config.yaml \
524524
-v "$PWD"/build:/tmp/auroraboot \
525525
-v /var/run/docker.sock:/var/run/docker.sock \
526526
--rm -ti quay.io/kairos/auroraboot \
527-
--set container_image=docker://<IMAGE> \
527+
--set container_image=oci:<IMAGE> \
528528
--set "disable_http_server=true" \
529529
--set "disable_netboot=true" \
530530
--cloud-config /config.yaml \
@@ -539,7 +539,7 @@ Build the custom ISO with the cloud config:
539539
docker run -v "$PWD"/config.yaml:/config.yaml \
540540
-v "$PWD"/build:/tmp/auroraboot \
541541
--rm -ti quay.io/kairos/auroraboot \
542-
--set container_image={{<oci variant="core">}} \
542+
--set container_image=oci:{{<oci variant="core">}} \
543543
--set "disable_http_server=true" \
544544
--set "disable_netboot=true" \
545545
--cloud-config /config.yaml \

0 commit comments

Comments
 (0)