You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli-usage.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ This command creates a new SOCI-enabled image that packages the original image a
54
54
> [!NOTE]
55
55
> SOCI Index Manifest v2 is the recommended approach for production deployments as it provides immutable binding between the image and SOCI index, preventing runtime behavior changes.
-`xattr` : When true, adds DisableXAttrs annotation to SOCI index. This annotation often helps performance at pull time.
65
65
-```--all-platforms``` : Convert all platforms of a multi-platform image
66
66
-```--platform``` : Convert only the specified platform (e.g., linux/amd64)
67
+
-```--standalone``` : Run in standalone mode without a containerd runtime. Reads an OCI image layout (tar or directory) from disk and writes a converted OCI image layout without requiring a running containerd instance. See [Standalone mode](#standalone-mode) below.
68
+
-```--format``` : Output format for standalone mode: ```oci-archive``` (tar, default) or ```oci-dir``` (directory). Only used with ```--standalone```.
Standalone mode enables SOCI conversion without a running containerd daemon. This is useful in CI/CD pipelines and other environments where containerd is unavailable or running it would require privileged access.
83
+
84
+
In standalone mode, ```<source>``` and ```<dest>``` are file paths (not image references). The source can be an OCI image layout tar archive or directory. The output format is controlled by the ```--format``` flag.
85
+
86
+
Standalone mode does not require containerd, sudo, or any other daemon. You can use tools like [skopeo](https://github.com/containers/skopeo) or [crane](https://github.com/google/go-containerregistry/blob/main/cmd/crane) to download and push images.
87
+
88
+
> [!NOTE]
89
+
> The input tar or directory must be in **OCI image layout** format. Docker-style tarballs (e.g., from `docker save` or `crane pull` without `--format oci`) are not compatible.
> If containerd is not available (e.g., in CI/CD pipelines), you can use `soci convert --standalone` to convert OCI image layouts on disk without a running containerd instance. See the [CLI usage documentation](./cli-usage.md#standalone-mode) for details.
107
+
105
108
After this step, please check your registry to confirm the image and SOCI index are present.
106
109
You can go to your registry console or use your registry's CLI (e.g. for ECR, you
107
110
can use `aws ecr describe-images --repository-name rabbitmq --region $AWS_REGION`).
See [the getting started guide](./getting-started.md) for more information.
40
40
41
+
> **Note**
42
+
> If containerd is not available (e.g., in CI/CD pipelines), you can use `soci convert --standalone` to convert OCI image layouts on disk without a running containerd instance. See the [CLI usage documentation](./cli-usage.md#standalone-mode) for details.
43
+
41
44
## Continuing to Use SOCI Index Manifest v1
42
45
43
46
There are some use-cases where the dynamic nature of SOCI Index Manifest v1 adds significant value. For those users, SOCI Index Manifest v1 is still available in the SOCI snapshotter; however, it is disabled by default. By re-enabling it, you should be aware that adding a SOCI index to an existing image can change the runtime characteristics of the image. We strongly recommend that you migrate to SOCI-enabled images and SOCI Index Manifest V2 which immutably binds a SOCI index to a new image and allows you to manage changes to your production workloads through deployments, just like you would for any other change.
0 commit comments