Skip to main content
Version: v0.12

kusion mod push

Push a module to OCI registry

Synopsis

The push command packages the module as an OCI artifact and pushes it to the OCI registry using the version as the image tag.

kusion mod push MODULE_PATH OCI_REPOSITORY_URL [--creds CREDENTIALS]

Examples

  # Push a module of current OS arch to an OCI Registry using a token
kusion mod push /path/to/my-module oci://ghcr.io/org --creds <YOUR_TOKEN>

# Push a module of specific OS arch to an OCI Registry using a token
kusion mod push /path/to/my-module oci://ghcr.io/org --os-arch==darwin/arm64 --creds <YOUR_TOKEN>

# Push a module to an OCI Registry using a credentials in <YOUR_USERNAME>:<YOUR_TOKEN> format.
kusion mod push /path/to/my-module oci://ghcr.io/org --creds <YOUR_USERNAME>:<YOUR_TOKEN>

# Push a release candidate without marking it as the latest stable
kusion mod push /path/to/my-module oci://ghcr.io/org --latest=false

# Push a module with custom OCI annotations
kusion mod push /path/to/my-module oci://ghcr.io/org \
--annotation='org.opencontainers.image.documentation=https://app.org/docs'

# Push and sign a module with Cosign (the cosign binary must be present in PATH)
export COSIGN_PASSWORD=password
kusion mod push /path/to/my-module oci://ghcr.io/org \
--sign=cosign --cosign-key=/path/to/cosign.key

Options

  -a, --annotations strings   Set custom OCI annotations in '<KEY>=<VALUE>' format.
--cosign-key string The Cosign private key for signing the module.
--creds string The credentials token for the OCI registry in <YOUR_TOKEN> or <YOUR_USERNAME>:<YOUR_TOKEN> format.
-h, --help help for push
--insecure-registry If true, allows connecting to a OCI registry without TLS or with self-signed certificates.
--latest Tags the current version as the latest stable module version. (default true)
--os-arch string The os arch of the module e.g. 'darwin/arm64', 'linux/amd64'.
--sign string Signs the module with the specified provider.

Options inherited from parent commands

      --profile string          Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex) (default "none")
--profile-output string Name of the file to write the profile to (default "profile.pprof")

SEE ALSO

Auto generated by spf13/cobra on 12-Jun-2024