Skip to content

Latest commit

 

History

History
4635 lines (2337 loc) · 170 KB

reference.md

File metadata and controls

4635 lines (2337 loc) · 170 KB

Commands Overview

Release commands

Chart commands

Secret commands

Dependency commands

Repo commands

TypeScript commands

Other commands

Commands

release install

Deploy a chart to Kubernetes.

Usage:

nelm release install [options...] [-n namespace] [-r release] [chart-dir|chart-repo-name/chart-name|chart-archive|chart-archive-url]

Options:

  • --auto-rollback (default: false)

    Automatically rollback the release on failure. Var: $NELM_RELEASE_INSTALL_AUTO_ROLLBACK

  • --chart-version (default: "")

    Choose a remote chart version, otherwise the latest version is used. Vars: $NELM_CHART_VERSION, $NELM_RELEASE_INSTALL_CHART_VERSION

  • --delete-propagation (default: "Background")

    Default delete propagation strategy. Vars: $NELM_DELETE_PROPAGATION, $NELM_RELEASE_INSTALL_DELETE_PROPAGATION

  • --force-adoption (default: false)

    Always adopt resources, even if they belong to a different Helm release. Vars: $NELM_FORCE_ADOPTION, $NELM_RELEASE_INSTALL_FORCE_ADOPTION

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Defaults to the one recorded in the chart's .werf-data. Vars: $NELM_NAMESPACE, $NELM_RELEASE_INSTALL_NAMESPACE

  • --no-create-namespace (default: false)

    Don't create the release namespace. Vars: $NELM_NO_CREATE_NAMESPACE, $NELM_RELEASE_INSTALL_NO_CREATE_NAMESPACE

  • --no-install-crds (default: false)

    Don't install CRDs from "crds/" directories of installed charts. Var: $NELM_RELEASE_INSTALL_NO_INSTALL_CRDS

  • --no-notes (default: false)

    Don't show release notes at the end of the release. Var: $NELM_RELEASE_INSTALL_NO_NOTES

  • --no-remove-manual-changes (default: false)

    Don't remove fields added manually to the resource in the cluster if fields aren't present in the manifest. Vars: $NELM_NO_REMOVE_MANUAL_CHANGES, $NELM_RELEASE_INSTALL_NO_REMOVE_MANUAL_CHANGES

  • --plan-lifetime (default: 2h0m0s)

    How long plan artifact is valid. Var: $NELM_RELEASE_INSTALL_PLAN_LIFETIME

  • --provenance-keyring (default: "")

    Path to keyring containing public keys to verify chart provenance. Vars: $NELM_PROVENANCE_KEYRING, $NELM_RELEASE_INSTALL_PROVENANCE_KEYRING

  • --provenance-strategy (default: "never")

    Strategy for provenance verifying. Vars: $NELM_PROVENANCE_STRATEGY, $NELM_RELEASE_INSTALL_PROVENANCE_STRATEGY

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Defaults to the one recorded in the chart's .werf-data. Vars: $NELM_RELEASE, $NELM_RELEASE_INSTALL_RELEASE

  • --release-info-annotations (default: {})

    Add annotations to release metadata. Vars: $NELM_RELEASE_INFO_ANNOTATIONS_*, $NELM_RELEASE_INSTALL_RELEASE_INFO_ANNOTATIONS_*

  • --release-labels (default: {})

    Add labels to the release. What kind of labels depends on the storage driver. Vars: $NELM_RELEASE_LABELS_*, $NELM_RELEASE_INSTALL_RELEASE_LABELS_*

  • --save-graph-to (default: "")

    Save the Graphviz install graph to a file. Var: $NELM_RELEASE_INSTALL_SAVE_GRAPH_TO

  • --save-report-to (default: "")

    Save the install report to a file. Var: $NELM_RELEASE_INSTALL_SAVE_REPORT_TO

  • --show-subchart-notes (default: false)

    Show NOTES.txt of subcharts after the release. Var: $NELM_RELEASE_INSTALL_SHOW_SUBCHART_NOTES

  • --templates-allow-dns (default: false)

    Allow performing DNS requests in templating. Vars: $NELM_TEMPLATES_ALLOW_DNS, $NELM_RELEASE_INSTALL_TEMPLATES_ALLOW_DNS

  • --timeout (default: 0s)

    Fail if not finished in time. Vars: $NELM_TIMEOUT, $NELM_RELEASE_INSTALL_TIMEOUT

  • --use-plan (default: "")

    Use the gzip-compressed JSON plan file from the specified path during release install. Var: $NELM_RELEASE_INSTALL_USE_PLAN

Values options:

  • --no-default-values (default: false)

    Ignore values.yaml of the top-level chart. Vars: $NELM_NO_DEFAULT_VALUES, $NELM_RELEASE_INSTALL_NO_DEFAULT_VALUES

  • --set (default: [])

    Set new values, where the key is the value path and the value is the value. Vars: $NELM_SET, $NELM_RELEASE_INSTALL_SET

  • --set-file (default: [])

    Set new values, where the key is the value path and the value is the path to the file with the value content. Vars: $NELM_SET_FILE, $NELM_RELEASE_INSTALL_SET_FILE

  • --set-json (default: [])

    Set new values, where the key is the value path and the value is JSON. Vars: $NELM_SET_JSON, $NELM_RELEASE_INSTALL_SET_JSON

  • --set-literal (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a literal string. Vars: $NELM_SET_LITERAL, $NELM_RELEASE_INSTALL_SET_LITERAL

  • --set-root-json (default: [])

    Set new keys in the global context ($), where the key is the value path and the value is JSON. This is meant to be generated inside the program, so use --set-json instead, unless you know what you are doing. Vars: $NELM_SET_ROOT_JSON, $NELM_RELEASE_INSTALL_SET_ROOT_JSON

  • --set-string (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a string. Vars: $NELM_SET_STRING, $NELM_RELEASE_INSTALL_SET_STRING

  • --values (default: [])

    Additional values files. Vars: $NELM_VALUES, $NELM_RELEASE_INSTALL_VALUES

Secret options:

  • --no-decrypt-secrets (default: false)

    Do not decrypt secrets and secret values, pass them as is. Vars: $NELM_NO_DECRYPT_SECRETS, $NELM_RELEASE_INSTALL_NO_DECRYPT_SECRETS

  • --no-default-secret-values (default: false)

    Ignore secret-values.yaml of the top-level chart and its subcharts. Vars: $NELM_NO_DEFAULT_SECRET_VALUES, $NELM_RELEASE_INSTALL_NO_DEFAULT_SECRET_VALUES

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_RELEASE_INSTALL_SECRET_KEY

  • --secret-values (default: [])

    Secret values files paths. Vars: $NELM_SECRET_VALUES, $NELM_RELEASE_INSTALL_SECRET_VALUES

Resource validation options:

  • --no-resource-validation (default: false)

    Disable resource validation. Vars: $NELM_NO_RESOURCE_VALIDATION, $NELM_RELEASE_INSTALL_NO_RESOURCE_VALIDATION

  • --no-values-schema-validation (default: false)

    Disable values validation against JSON schema. Vars: $NELM_NO_VALUES_SCHEMA_VALIDATION, $NELM_RELEASE_INSTALL_NO_VALUES_SCHEMA_VALIDATION

  • --resource-validation-cache-lifetime (default: 48h0m0s)

    How long local schema cache will be valid. Vars: $NELM_RESOURCE_VALIDATION_CACHE_LIFETIME, $NELM_RELEASE_INSTALL_RESOURCE_VALIDATION_CACHE_LIFETIME

  • --resource-validation-extra-schema (default: [])

    Extra json schema sources to validate resources, preferred over the json schemas embedded into the binary. Which source served a resource kind is cached for --resource-validation-cache-lifetime, so a schema that only appears in these sources later takes over once that entry expires, whereas changing this option resets the cache at once. Must be a valid go template defining a http(s) URL, or an absolute path on local file system. Example: https://raw\.githubusercontent\.com/yannh/kubernetes\-json\-schema/master/\{\{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json. Vars: $NELM_RESOURCE_VALIDATION_EXTRA_SCHEMA_*, $NELM_RELEASE_INSTALL_RESOURCE_VALIDATION_EXTRA_SCHEMA_*

  • --resource-validation-skip (default: [])

    Skip resource validation for resources with specified attributes. Format: key1=value1,key2=value2. Supported keys: group, version, kind, name, namespace. Example: kind=Deployment,name=my-app. Vars: $NELM_RESOURCE_VALIDATION_SKIP, $NELM_RELEASE_INSTALL_RESOURCE_VALIDATION_SKIP

Patch options:

  • --annotations (default: {})

    Add annotations to all resources. Vars: $NELM_ANNOTATIONS_*, $NELM_RELEASE_INSTALL_ANNOTATIONS_*

  • --app-version (default: "")

    Set appVersion of Chart.yaml. Vars: $NELM_APP_VERSION, $NELM_RELEASE_INSTALL_APP_VERSION

  • --labels (default: {})

    Add labels to all resources. Vars: $NELM_LABELS_*, $NELM_RELEASE_INSTALL_LABELS_*

  • --no-default-patches (default: false)

    Ignore patches.yaml of the top-level chart and subcharts. Vars: $NELM_NO_DEFAULT_PATCHES, $NELM_RELEASE_INSTALL_NO_DEFAULT_PATCHES

  • --patches (default: [])

    Additional patches files (render patches for rendered resources, diff patches for drift detection). Vars: $NELM_PATCHES, $NELM_RELEASE_INSTALL_PATCHES

  • --runtime-annotations (default: {})

    Add annotations which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_ANNOTATIONS_*, $NELM_RELEASE_INSTALL_RUNTIME_ANNOTATIONS_*

  • --runtime-labels (default: {})

    Add labels which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_LABELS_*, $NELM_RELEASE_INSTALL_RUNTIME_LABELS_*

TypeScript options:

  • --ignore-bundle-js (default: false)

    Do not use the existing bundle.js file. Requires TypeScript source files to rebuild. Vars: $NELM_IGNORE_BUNDLE_JS, $NELM_RELEASE_INSTALL_IGNORE_BUNDLE_JS

  • --node-binary-path (default: "")

    Path to the Node.js binary to use instead of the one in PATH. Vars: $NELM_NODE_BINARY_PATH, $NELM_RELEASE_INSTALL_NODE_BINARY_PATH

Progress options:

  • --no-final-tracking (default: false)

    By default disable tracking operations that have no create/update/delete resource operations after them, which are most tracking operations, to speed up the release. Vars: $NELM_NO_FINAL_TRACKING, $NELM_RELEASE_INSTALL_NO_FINAL_TRACKING

  • --no-pod-logs (default: false)

    Disable Pod logs collection and printing. Vars: $NELM_NO_POD_LOGS, $NELM_RELEASE_INSTALL_NO_POD_LOGS

  • --no-show-progress (default: false)

    Don't show logs, events and real-time info about release resources. Vars: $NELM_NO_SHOW_PROGRESS, $NELM_RELEASE_INSTALL_NO_SHOW_PROGRESS

  • --progress-interval (default: 5s)

    How often to print new logs, events and real-time info about release resources. Vars: $NELM_PROGRESS_INTERVAL, $NELM_RELEASE_INSTALL_PROGRESS_INTERVAL

  • --resource-creation-timeout (default: 0s)

    Fail if resource creation tracking did not finish in time. Vars: $NELM_RESOURCE_CREATION_TIMEOUT, $NELM_RELEASE_INSTALL_RESOURCE_CREATION_TIMEOUT

  • --resource-deletion-timeout (default: 0s)

    Fail if resource deletion tracking did not finish in time. Vars: $NELM_RESOURCE_DELETION_TIMEOUT, $NELM_RELEASE_INSTALL_RESOURCE_DELETION_TIMEOUT

  • --resource-readiness-timeout (default: 0s)

    Fail if resource readiness tracking did not finish in time. Vars: $NELM_RESOURCE_READINESS_TIMEOUT, $NELM_RELEASE_INSTALL_RESOURCE_READINESS_TIMEOUT

Chart repository options:

  • --chart-repo-basic-password (default: "")

    Basic auth password to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_PASSWORD, $NELM_RELEASE_INSTALL_CHART_REPO_BASIC_PASSWORD

  • --chart-repo-basic-username (default: "")

    Basic auth username to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_USERNAME, $NELM_RELEASE_INSTALL_CHART_REPO_BASIC_USERNAME

  • --chart-repo-ca (default: "")

    Path to TLS CA file for connecting to chart repository. Vars: $NELM_CHART_REPO_CA, $NELM_RELEASE_INSTALL_CHART_REPO_CA

  • --chart-repo-cert (default: "")

    Path to TLS client cert file for connecting to chart repository. Vars: $NELM_CHART_REPO_CERT, $NELM_RELEASE_INSTALL_CHART_REPO_CERT

  • --chart-repo-key (default: "")

    Path to TLS client key file for connecting to chart repository. Vars: $NELM_CHART_REPO_KEY, $NELM_RELEASE_INSTALL_CHART_REPO_KEY

  • --chart-repo-pass-creds (default: false)

    Allow sending chart repository credentials to domains different from the chart repository domain when downloading charts. Vars: $NELM_CHART_REPO_PASS_CREDS, $NELM_RELEASE_INSTALL_CHART_REPO_PASS_CREDS

  • --chart-repo-request-timeout (default: 0s)

    Set timeout for all requests to chart repository. A request includes its whole body, so the timeout also bounds a whole blob download or upload. Vars: $NELM_CHART_REPO_REQUEST_TIMEOUT, $NELM_RELEASE_INSTALL_CHART_REPO_REQUEST_TIMEOUT

  • --chart-repo-url (default: "")

    Set URL of chart repo to be used to look for chart. Vars: $NELM_CHART_REPO_URL, $NELM_RELEASE_INSTALL_CHART_REPO_URL

  • --docker-config (default: "~/.docker")

    Docker config directory path. Vars: $DOCKER_CONFIG, $NELM_DOCKER_CONFIG, $NELM_RELEASE_INSTALL_DOCKER_CONFIG

  • --insecure-chart-repos (default: false)

    Allow insecure HTTP connections to chart repository. Vars: $NELM_INSECURE_CHART_REPOS, $NELM_RELEASE_INSTALL_INSECURE_CHART_REPOS

  • --no-update-chart-repos (default: false)

    Don't update chart repositories index. Vars: $NELM_NO_UPDATE_CHART_REPOS, $NELM_RELEASE_INSTALL_NO_UPDATE_CHART_REPOS

  • --no-verify-chart-repos-tls (default: false)

    Don't verify TLS certificates of chart repository. Vars: $NELM_NO_VERIFY_CHART_REPOS_TLS, $NELM_RELEASE_INSTALL_NO_VERIFY_CHART_REPOS_TLS

  • --oci-chart-repos-creds (default: "")

    Credentials to access OCI chart repositories. Vars: $NELM_OCI_CHART_REPOS_CREDS, $NELM_RELEASE_INSTALL_OCI_CHART_REPOS_CREDS

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_RELEASE_INSTALL_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_RELEASE_INSTALL_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_RELEASE_INSTALL_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_RELEASE_INSTALL_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_RELEASE_INSTALL_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_RELEASE_INSTALL_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_RELEASE_INSTALL_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_RELEASE_INSTALL_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_RELEASE_INSTALL_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_RELEASE_INSTALL_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_RELEASE_INSTALL_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_RELEASE_INSTALL_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_RELEASE_INSTALL_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_RELEASE_INSTALL_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_RELEASE_INSTALL_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_RELEASE_INSTALL_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_RELEASE_INSTALL_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_RELEASE_INSTALL_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_RELEASE_INSTALL_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_RELEASE_INSTALL_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_RELEASE_INSTALL_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_RELEASE_INSTALL_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_RELEASE_INSTALL_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_RELEASE_INSTALL_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_RELEASE_INSTALL_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_RELEASE_INSTALL_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_RELEASE_INSTALL_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_RELEASE_INSTALL_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_INSTALL_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_INSTALL_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_INSTALL_LOG_WIDTH

  • --release-history-limit (default: 10)

    Limit the number of releases in release history. When limit is exceeded the oldest releases are deleted. Release resources are not affected. Var: $NELM_RELEASE_HISTORY_LIMIT

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

release rollback

Rollback to a previously deployed release. Choose the last successful revision (except the very last revision), by default.

Usage:

nelm release rollback [options...] -n namespace -r release [revision]

Options:

  • --delete-propagation (default: "Background")

    Default delete propagation strategy. Vars: $NELM_DELETE_PROPAGATION, $NELM_RELEASE_ROLLBACK_DELETE_PROPAGATION

  • --force-adoption (default: false)

    Always adopt resources, even if they belong to a different Helm release. Vars: $NELM_FORCE_ADOPTION, $NELM_RELEASE_ROLLBACK_FORCE_ADOPTION

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Vars: $NELM_NAMESPACE, $NELM_RELEASE_ROLLBACK_NAMESPACE

  • --no-notes (default: false)

    Don't show release notes at the end of the release. Var: $NELM_RELEASE_ROLLBACK_NO_NOTES

  • --no-remove-manual-changes (default: false)

    Don't remove fields added manually to the resource in the cluster if fields aren't present in the manifest. Vars: $NELM_NO_REMOVE_MANUAL_CHANGES, $NELM_RELEASE_ROLLBACK_NO_REMOVE_MANUAL_CHANGES

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Vars: $NELM_RELEASE, $NELM_RELEASE_ROLLBACK_RELEASE

  • --release-info-annotations (default: {})

    Add annotations to release metadata. Vars: $NELM_RELEASE_INFO_ANNOTATIONS_*, $NELM_RELEASE_ROLLBACK_RELEASE_INFO_ANNOTATIONS_*

  • --release-labels (default: {})

    Add labels to the release. What kind of labels depends on the storage driver. Vars: $NELM_RELEASE_LABELS_*, $NELM_RELEASE_ROLLBACK_RELEASE_LABELS_*

  • --save-graph-to (default: "")

    Save the Graphviz rollback graph to a file. Var: $NELM_RELEASE_ROLLBACK_SAVE_GRAPH_TO

  • --save-report-to (default: "")

    Save the rollback report to a file. Var: $NELM_RELEASE_ROLLBACK_SAVE_REPORT_TO

  • --timeout (default: 0s)

    Fail if not finished in time. Vars: $NELM_TIMEOUT, $NELM_RELEASE_ROLLBACK_TIMEOUT

Resource validation options:

  • --no-resource-validation (default: false)

    Disable resource validation. Vars: $NELM_NO_RESOURCE_VALIDATION, $NELM_RELEASE_ROLLBACK_NO_RESOURCE_VALIDATION

  • --no-values-schema-validation (default: false)

    Disable values validation against JSON schema. Vars: $NELM_NO_VALUES_SCHEMA_VALIDATION, $NELM_RELEASE_ROLLBACK_NO_VALUES_SCHEMA_VALIDATION

  • --resource-validation-cache-lifetime (default: 48h0m0s)

    How long local schema cache will be valid. Vars: $NELM_RESOURCE_VALIDATION_CACHE_LIFETIME, $NELM_RELEASE_ROLLBACK_RESOURCE_VALIDATION_CACHE_LIFETIME

  • --resource-validation-extra-schema (default: [])

    Extra json schema sources to validate resources, preferred over the json schemas embedded into the binary. Which source served a resource kind is cached for --resource-validation-cache-lifetime, so a schema that only appears in these sources later takes over once that entry expires, whereas changing this option resets the cache at once. Must be a valid go template defining a http(s) URL, or an absolute path on local file system. Example: https://raw\.githubusercontent\.com/yannh/kubernetes\-json\-schema/master/\{\{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json. Vars: $NELM_RESOURCE_VALIDATION_EXTRA_SCHEMA_*, $NELM_RELEASE_ROLLBACK_RESOURCE_VALIDATION_EXTRA_SCHEMA_*

  • --resource-validation-skip (default: [])

    Skip resource validation for resources with specified attributes. Format: key1=value1,key2=value2. Supported keys: group, version, kind, name, namespace. Example: kind=Deployment,name=my-app. Vars: $NELM_RESOURCE_VALIDATION_SKIP, $NELM_RELEASE_ROLLBACK_RESOURCE_VALIDATION_SKIP

Patch options:

  • --no-default-patches (default: false)

    Ignore patches.yaml of the top-level chart and subcharts. Vars: $NELM_NO_DEFAULT_PATCHES, $NELM_RELEASE_ROLLBACK_NO_DEFAULT_PATCHES

  • --patches (default: [])

    Additional patches files (diff patches for drift detection). Vars: $NELM_PATCHES, $NELM_RELEASE_ROLLBACK_PATCHES

  • --runtime-annotations (default: {})

    Add annotations which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_ANNOTATIONS_*, $NELM_RELEASE_ROLLBACK_RUNTIME_ANNOTATIONS_*

  • --runtime-labels (default: {})

    Add labels which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_LABELS_*, $NELM_RELEASE_ROLLBACK_RUNTIME_LABELS_*

Progress options:

  • --no-final-tracking (default: false)

    By default disable tracking operations that have no create/update/delete resource operations after them, which are most tracking operations, to speed up the release. Vars: $NELM_NO_FINAL_TRACKING, $NELM_RELEASE_ROLLBACK_NO_FINAL_TRACKING

  • --no-pod-logs (default: false)

    Disable Pod logs collection and printing. Vars: $NELM_NO_POD_LOGS, $NELM_RELEASE_ROLLBACK_NO_POD_LOGS

  • --no-show-progress (default: false)

    Don't show logs, events and real-time info about release resources. Vars: $NELM_NO_SHOW_PROGRESS, $NELM_RELEASE_ROLLBACK_NO_SHOW_PROGRESS

  • --progress-interval (default: 5s)

    How often to print new logs, events and real-time info about release resources. Vars: $NELM_PROGRESS_INTERVAL, $NELM_RELEASE_ROLLBACK_PROGRESS_INTERVAL

  • --resource-creation-timeout (default: 0s)

    Fail if resource creation tracking did not finish in time. Vars: $NELM_RESOURCE_CREATION_TIMEOUT, $NELM_RELEASE_ROLLBACK_RESOURCE_CREATION_TIMEOUT

  • --resource-deletion-timeout (default: 0s)

    Fail if resource deletion tracking did not finish in time. Vars: $NELM_RESOURCE_DELETION_TIMEOUT, $NELM_RELEASE_ROLLBACK_RESOURCE_DELETION_TIMEOUT

  • --resource-readiness-timeout (default: 0s)

    Fail if resource readiness tracking did not finish in time. Vars: $NELM_RESOURCE_READINESS_TIMEOUT, $NELM_RELEASE_ROLLBACK_RESOURCE_READINESS_TIMEOUT

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_RELEASE_ROLLBACK_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_RELEASE_ROLLBACK_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_RELEASE_ROLLBACK_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_RELEASE_ROLLBACK_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_RELEASE_ROLLBACK_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_RELEASE_ROLLBACK_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_RELEASE_ROLLBACK_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_RELEASE_ROLLBACK_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_RELEASE_ROLLBACK_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_RELEASE_ROLLBACK_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_RELEASE_ROLLBACK_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_RELEASE_ROLLBACK_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_RELEASE_ROLLBACK_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_RELEASE_ROLLBACK_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_RELEASE_ROLLBACK_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_RELEASE_ROLLBACK_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_RELEASE_ROLLBACK_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_RELEASE_ROLLBACK_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_RELEASE_ROLLBACK_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_RELEASE_ROLLBACK_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_RELEASE_ROLLBACK_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_RELEASE_ROLLBACK_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_RELEASE_ROLLBACK_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_RELEASE_ROLLBACK_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_RELEASE_ROLLBACK_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_RELEASE_ROLLBACK_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_RELEASE_ROLLBACK_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_RELEASE_ROLLBACK_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_ROLLBACK_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_ROLLBACK_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_ROLLBACK_LOG_WIDTH

  • --release-history-limit (default: 10)

    Limit the number of releases in release history. When limit is exceeded the oldest releases are deleted. Release resources are not affected. Var: $NELM_RELEASE_HISTORY_LIMIT

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

release plan install

Plan a release install to Kubernetes.

Usage:

nelm release plan install [options...] [-n namespace] [-r release] [chart-dir|chart-repo-name/chart-name|chart-archive|chart-archive-url]

Options:

  • --chart-version (default: "")

    Choose a remote chart version, otherwise the latest version is used. Vars: $NELM_CHART_VERSION, $NELM_RELEASE_PLAN_INSTALL_CHART_VERSION

  • --delete-propagation (default: "Background")

    Default delete propagation strategy. Vars: $NELM_DELETE_PROPAGATION, $NELM_RELEASE_PLAN_INSTALL_DELETE_PROPAGATION

  • --diff-context-lines (default: 3)

    Show N lines of context around diffs. Var: $NELM_RELEASE_PLAN_INSTALL_DIFF_CONTEXT_LINES

  • --exit-code (default: false)

    Return exit code 0 if no changes, 1 if error, 2 if resource changes planned, 3 if no resource changes planned, but release still should be installed. Var: $NELM_RELEASE_PLAN_INSTALL_EXIT_CODE

  • --force-adoption (default: false)

    Always adopt resources, even if they belong to a different Helm release. Vars: $NELM_FORCE_ADOPTION, $NELM_RELEASE_PLAN_INSTALL_FORCE_ADOPTION

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Defaults to the one recorded in the chart's .werf-data. Vars: $NELM_NAMESPACE, $NELM_RELEASE_PLAN_INSTALL_NAMESPACE

  • --no-install-crds (default: false)

    Don't install CRDs from "crds/" directories of installed charts. Var: $NELM_RELEASE_PLAN_INSTALL_NO_INSTALL_CRDS

  • --no-remove-manual-changes (default: false)

    Don't remove fields added manually to the resource in the cluster if fields aren't present in the manifest. Vars: $NELM_NO_REMOVE_MANUAL_CHANGES, $NELM_RELEASE_PLAN_INSTALL_NO_REMOVE_MANUAL_CHANGES

  • --provenance-keyring (default: "")

    Path to keyring containing public keys to verify chart provenance. Vars: $NELM_PROVENANCE_KEYRING, $NELM_RELEASE_PLAN_INSTALL_PROVENANCE_KEYRING

  • --provenance-strategy (default: "never")

    Strategy for provenance verifying. Vars: $NELM_PROVENANCE_STRATEGY, $NELM_RELEASE_PLAN_INSTALL_PROVENANCE_STRATEGY

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Defaults to the one recorded in the chart's .werf-data. Vars: $NELM_RELEASE, $NELM_RELEASE_PLAN_INSTALL_RELEASE

  • --release-info-annotations (default: {})

    Add annotations to release metadata. Vars: $NELM_RELEASE_INFO_ANNOTATIONS_*, $NELM_RELEASE_PLAN_INSTALL_RELEASE_INFO_ANNOTATIONS_*

  • --release-labels (default: {})

    Add labels to the release. What kind of labels depends on the storage driver. Vars: $NELM_RELEASE_LABELS_*, $NELM_RELEASE_PLAN_INSTALL_RELEASE_LABELS_*

  • --save-graph-to (default: "")

    Save the Graphviz install graph to a file. Var: $NELM_RELEASE_PLAN_INSTALL_SAVE_GRAPH_TO

  • --save-plan (default: "")

    Save the gzip-compressed JSON install plan to the specified file. Var: $NELM_RELEASE_PLAN_INSTALL_SAVE_PLAN

  • --show-insignificant-diffs (default: false)

    Show insignificant diff lines. Var: $NELM_RELEASE_PLAN_INSTALL_SHOW_INSIGNIFICANT_DIFFS

  • --show-sensitive-diffs (default: false)

    Show sensitive diff lines. Var: $NELM_RELEASE_PLAN_INSTALL_SHOW_SENSITIVE_DIFFS

  • --show-verbose-crd-diffs (default: false)

    Show verbose CRD diff lines. Var: $NELM_RELEASE_PLAN_INSTALL_SHOW_VERBOSE_CRD_DIFFS

  • --templates-allow-dns (default: false)

    Allow performing DNS requests in templating. Vars: $NELM_TEMPLATES_ALLOW_DNS, $NELM_RELEASE_PLAN_INSTALL_TEMPLATES_ALLOW_DNS

  • --timeout (default: 0s)

    Fail if not finished in time. Vars: $NELM_TIMEOUT, $NELM_RELEASE_PLAN_INSTALL_TIMEOUT

Values options:

  • --no-default-values (default: false)

    Ignore values.yaml of the top-level chart. Vars: $NELM_NO_DEFAULT_VALUES, $NELM_RELEASE_PLAN_INSTALL_NO_DEFAULT_VALUES

  • --set (default: [])

    Set new values, where the key is the value path and the value is the value. Vars: $NELM_SET, $NELM_RELEASE_PLAN_INSTALL_SET

  • --set-file (default: [])

    Set new values, where the key is the value path and the value is the path to the file with the value content. Vars: $NELM_SET_FILE, $NELM_RELEASE_PLAN_INSTALL_SET_FILE

  • --set-json (default: [])

    Set new values, where the key is the value path and the value is JSON. Vars: $NELM_SET_JSON, $NELM_RELEASE_PLAN_INSTALL_SET_JSON

  • --set-literal (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a literal string. Vars: $NELM_SET_LITERAL, $NELM_RELEASE_PLAN_INSTALL_SET_LITERAL

  • --set-root-json (default: [])

    Set new keys in the global context ($), where the key is the value path and the value is JSON. This is meant to be generated inside the program, so use --set-json instead, unless you know what you are doing. Vars: $NELM_SET_ROOT_JSON, $NELM_RELEASE_PLAN_INSTALL_SET_ROOT_JSON

  • --set-string (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a string. Vars: $NELM_SET_STRING, $NELM_RELEASE_PLAN_INSTALL_SET_STRING

  • --values (default: [])

    Additional values files. Vars: $NELM_VALUES, $NELM_RELEASE_PLAN_INSTALL_VALUES

Secret options:

  • --no-decrypt-secrets (default: false)

    Do not decrypt secrets and secret values, pass them as is. Vars: $NELM_NO_DECRYPT_SECRETS, $NELM_RELEASE_PLAN_INSTALL_NO_DECRYPT_SECRETS

  • --no-default-secret-values (default: false)

    Ignore secret-values.yaml of the top-level chart and its subcharts. Vars: $NELM_NO_DEFAULT_SECRET_VALUES, $NELM_RELEASE_PLAN_INSTALL_NO_DEFAULT_SECRET_VALUES

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_RELEASE_PLAN_INSTALL_SECRET_KEY

  • --secret-values (default: [])

    Secret values files paths. Vars: $NELM_SECRET_VALUES, $NELM_RELEASE_PLAN_INSTALL_SECRET_VALUES

Resource validation options:

  • --no-resource-validation (default: false)

    Disable resource validation. Vars: $NELM_NO_RESOURCE_VALIDATION, $NELM_RELEASE_PLAN_INSTALL_NO_RESOURCE_VALIDATION

  • --no-values-schema-validation (default: false)

    Disable values validation against JSON schema. Vars: $NELM_NO_VALUES_SCHEMA_VALIDATION, $NELM_RELEASE_PLAN_INSTALL_NO_VALUES_SCHEMA_VALIDATION

  • --resource-validation-cache-lifetime (default: 48h0m0s)

    How long local schema cache will be valid. Vars: $NELM_RESOURCE_VALIDATION_CACHE_LIFETIME, $NELM_RELEASE_PLAN_INSTALL_RESOURCE_VALIDATION_CACHE_LIFETIME

  • --resource-validation-extra-schema (default: [])

    Extra json schema sources to validate resources, preferred over the json schemas embedded into the binary. Which source served a resource kind is cached for --resource-validation-cache-lifetime, so a schema that only appears in these sources later takes over once that entry expires, whereas changing this option resets the cache at once. Must be a valid go template defining a http(s) URL, or an absolute path on local file system. Example: https://raw\.githubusercontent\.com/yannh/kubernetes\-json\-schema/master/\{\{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json. Vars: $NELM_RESOURCE_VALIDATION_EXTRA_SCHEMA_*, $NELM_RELEASE_PLAN_INSTALL_RESOURCE_VALIDATION_EXTRA_SCHEMA_*

  • --resource-validation-skip (default: [])

    Skip resource validation for resources with specified attributes. Format: key1=value1,key2=value2. Supported keys: group, version, kind, name, namespace. Example: kind=Deployment,name=my-app. Vars: $NELM_RESOURCE_VALIDATION_SKIP, $NELM_RELEASE_PLAN_INSTALL_RESOURCE_VALIDATION_SKIP

Patch options:

  • --annotations (default: {})

    Add annotations to all resources. Vars: $NELM_ANNOTATIONS_*, $NELM_RELEASE_PLAN_INSTALL_ANNOTATIONS_*

  • --app-version (default: "")

    Set appVersion of Chart.yaml. Vars: $NELM_APP_VERSION, $NELM_RELEASE_PLAN_INSTALL_APP_VERSION

  • --labels (default: {})

    Add labels to all resources. Vars: $NELM_LABELS_*, $NELM_RELEASE_PLAN_INSTALL_LABELS_*

  • --no-default-patches (default: false)

    Ignore patches.yaml of the top-level chart and subcharts. Vars: $NELM_NO_DEFAULT_PATCHES, $NELM_RELEASE_PLAN_INSTALL_NO_DEFAULT_PATCHES

  • --patches (default: [])

    Additional patches files (render patches for rendered resources, diff patches for drift detection). Vars: $NELM_PATCHES, $NELM_RELEASE_PLAN_INSTALL_PATCHES

  • --runtime-annotations (default: {})

    Add annotations which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_ANNOTATIONS_*, $NELM_RELEASE_PLAN_INSTALL_RUNTIME_ANNOTATIONS_*

  • --runtime-labels (default: {})

    Add labels which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_LABELS_*, $NELM_RELEASE_PLAN_INSTALL_RUNTIME_LABELS_*

TypeScript options:

  • --ignore-bundle-js (default: false)

    Do not use the existing bundle.js file. Requires TypeScript source files to rebuild. Vars: $NELM_IGNORE_BUNDLE_JS, $NELM_RELEASE_PLAN_INSTALL_IGNORE_BUNDLE_JS

  • --node-binary-path (default: "")

    Path to the Node.js binary to use instead of the one in PATH. Vars: $NELM_NODE_BINARY_PATH, $NELM_RELEASE_PLAN_INSTALL_NODE_BINARY_PATH

Progress options:

  • --no-final-tracking (default: false)

    By default disable tracking operations that have no create/update/delete resource operations after them, which are most tracking operations, to speed up the release. Vars: $NELM_NO_FINAL_TRACKING, $NELM_RELEASE_PLAN_INSTALL_NO_FINAL_TRACKING

Chart repository options:

  • --chart-repo-basic-password (default: "")

    Basic auth password to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_PASSWORD, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_BASIC_PASSWORD

  • --chart-repo-basic-username (default: "")

    Basic auth username to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_USERNAME, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_BASIC_USERNAME

  • --chart-repo-ca (default: "")

    Path to TLS CA file for connecting to chart repository. Vars: $NELM_CHART_REPO_CA, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_CA

  • --chart-repo-cert (default: "")

    Path to TLS client cert file for connecting to chart repository. Vars: $NELM_CHART_REPO_CERT, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_CERT

  • --chart-repo-key (default: "")

    Path to TLS client key file for connecting to chart repository. Vars: $NELM_CHART_REPO_KEY, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_KEY

  • --chart-repo-pass-creds (default: false)

    Allow sending chart repository credentials to domains different from the chart repository domain when downloading charts. Vars: $NELM_CHART_REPO_PASS_CREDS, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_PASS_CREDS

  • --chart-repo-request-timeout (default: 0s)

    Set timeout for all requests to chart repository. A request includes its whole body, so the timeout also bounds a whole blob download or upload. Vars: $NELM_CHART_REPO_REQUEST_TIMEOUT, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_REQUEST_TIMEOUT

  • --chart-repo-url (default: "")

    Set URL of chart repo to be used to look for chart. Vars: $NELM_CHART_REPO_URL, $NELM_RELEASE_PLAN_INSTALL_CHART_REPO_URL

  • --docker-config (default: "~/.docker")

    Docker config directory path. Vars: $DOCKER_CONFIG, $NELM_DOCKER_CONFIG, $NELM_RELEASE_PLAN_INSTALL_DOCKER_CONFIG

  • --insecure-chart-repos (default: false)

    Allow insecure HTTP connections to chart repository. Vars: $NELM_INSECURE_CHART_REPOS, $NELM_RELEASE_PLAN_INSTALL_INSECURE_CHART_REPOS

  • --no-update-chart-repos (default: false)

    Don't update chart repositories index. Vars: $NELM_NO_UPDATE_CHART_REPOS, $NELM_RELEASE_PLAN_INSTALL_NO_UPDATE_CHART_REPOS

  • --no-verify-chart-repos-tls (default: false)

    Don't verify TLS certificates of chart repository. Vars: $NELM_NO_VERIFY_CHART_REPOS_TLS, $NELM_RELEASE_PLAN_INSTALL_NO_VERIFY_CHART_REPOS_TLS

  • --oci-chart-repos-creds (default: "")

    Credentials to access OCI chart repositories. Vars: $NELM_OCI_CHART_REPOS_CREDS, $NELM_RELEASE_PLAN_INSTALL_OCI_CHART_REPOS_CREDS

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_RELEASE_PLAN_INSTALL_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_RELEASE_PLAN_INSTALL_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_RELEASE_PLAN_INSTALL_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_RELEASE_PLAN_INSTALL_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_RELEASE_PLAN_INSTALL_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_RELEASE_PLAN_INSTALL_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_RELEASE_PLAN_INSTALL_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_RELEASE_PLAN_INSTALL_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_RELEASE_PLAN_INSTALL_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_RELEASE_PLAN_INSTALL_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_RELEASE_PLAN_INSTALL_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_RELEASE_PLAN_INSTALL_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_RELEASE_PLAN_INSTALL_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_RELEASE_PLAN_INSTALL_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_RELEASE_PLAN_INSTALL_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_RELEASE_PLAN_INSTALL_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_RELEASE_PLAN_INSTALL_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_RELEASE_PLAN_INSTALL_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_RELEASE_PLAN_INSTALL_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_RELEASE_PLAN_INSTALL_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_RELEASE_PLAN_INSTALL_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_RELEASE_PLAN_INSTALL_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_RELEASE_PLAN_INSTALL_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_RELEASE_PLAN_INSTALL_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_RELEASE_PLAN_INSTALL_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_RELEASE_PLAN_INSTALL_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_RELEASE_PLAN_INSTALL_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_RELEASE_PLAN_INSTALL_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_PLAN_INSTALL_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_PLAN_INSTALL_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_PLAN_INSTALL_LOG_WIDTH

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

release uninstall

Uninstall a Helm Release from Kubernetes.

Usage:

nelm release uninstall [options...] -n namespace -r release

Options:

  • --delete-namespace (default: false)

    Delete the release namespace. Var: $NELM_RELEASE_UNINSTALL_DELETE_NAMESPACE

  • --delete-propagation (default: "Background")

    Default delete propagation strategy. Vars: $NELM_DELETE_PROPAGATION, $NELM_RELEASE_UNINSTALL_DELETE_PROPAGATION

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Vars: $NELM_NAMESPACE, $NELM_RELEASE_UNINSTALL_NAMESPACE

  • --no-remove-manual-changes (default: false)

    Don't remove fields added manually to the resource in the cluster if fields aren't present in the manifest. Vars: $NELM_NO_REMOVE_MANUAL_CHANGES, $NELM_RELEASE_UNINSTALL_NO_REMOVE_MANUAL_CHANGES

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Vars: $NELM_RELEASE, $NELM_RELEASE_UNINSTALL_RELEASE

  • --save-graph-to (default: "")

    Save the Graphviz uninstall graph to a file. Var: $NELM_RELEASE_UNINSTALL_SAVE_GRAPH_TO

  • --save-report-to (default: "")

    Save the uninstall report to a file. Var: $NELM_RELEASE_UNINSTALL_SAVE_REPORT_TO

  • --timeout (default: 0s)

    Fail if not finished in time. Vars: $NELM_TIMEOUT, $NELM_RELEASE_UNINSTALL_TIMEOUT

Patch options:

  • --no-default-patches (default: false)

    Ignore patches.yaml of the top-level chart and subcharts. Vars: $NELM_NO_DEFAULT_PATCHES, $NELM_RELEASE_UNINSTALL_NO_DEFAULT_PATCHES

  • --patches (default: [])

    Additional patches files (diff patches for drift detection). Vars: $NELM_PATCHES, $NELM_RELEASE_UNINSTALL_PATCHES

Progress options:

  • --no-final-tracking (default: false)

    By default disable tracking operations that have no create/update/delete resource operations after them, which are most tracking operations, to speed up the release. Vars: $NELM_NO_FINAL_TRACKING, $NELM_RELEASE_UNINSTALL_NO_FINAL_TRACKING

  • --no-pod-logs (default: false)

    Disable Pod logs collection and printing. Vars: $NELM_NO_POD_LOGS, $NELM_RELEASE_UNINSTALL_NO_POD_LOGS

  • --no-show-progress (default: false)

    Don't show logs, events and real-time info about release resources. Vars: $NELM_NO_SHOW_PROGRESS, $NELM_RELEASE_UNINSTALL_NO_SHOW_PROGRESS

  • --progress-interval (default: 5s)

    How often to print new logs, events and real-time info about release resources. Vars: $NELM_PROGRESS_INTERVAL, $NELM_RELEASE_UNINSTALL_PROGRESS_INTERVAL

  • --resource-creation-timeout (default: 0s)

    Fail if resource creation tracking did not finish in time. Vars: $NELM_RESOURCE_CREATION_TIMEOUT, $NELM_RELEASE_UNINSTALL_RESOURCE_CREATION_TIMEOUT

  • --resource-deletion-timeout (default: 0s)

    Fail if resource deletion tracking did not finish in time. Vars: $NELM_RESOURCE_DELETION_TIMEOUT, $NELM_RELEASE_UNINSTALL_RESOURCE_DELETION_TIMEOUT

  • --resource-readiness-timeout (default: 0s)

    Fail if resource readiness tracking did not finish in time. Vars: $NELM_RESOURCE_READINESS_TIMEOUT, $NELM_RELEASE_UNINSTALL_RESOURCE_READINESS_TIMEOUT

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_RELEASE_UNINSTALL_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_RELEASE_UNINSTALL_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_RELEASE_UNINSTALL_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_RELEASE_UNINSTALL_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_RELEASE_UNINSTALL_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_RELEASE_UNINSTALL_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_RELEASE_UNINSTALL_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_RELEASE_UNINSTALL_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_RELEASE_UNINSTALL_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_RELEASE_UNINSTALL_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_RELEASE_UNINSTALL_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_RELEASE_UNINSTALL_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_RELEASE_UNINSTALL_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_RELEASE_UNINSTALL_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_RELEASE_UNINSTALL_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_RELEASE_UNINSTALL_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_RELEASE_UNINSTALL_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_RELEASE_UNINSTALL_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_RELEASE_UNINSTALL_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_RELEASE_UNINSTALL_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_RELEASE_UNINSTALL_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_RELEASE_UNINSTALL_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_RELEASE_UNINSTALL_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_RELEASE_UNINSTALL_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_RELEASE_UNINSTALL_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_RELEASE_UNINSTALL_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_RELEASE_UNINSTALL_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_RELEASE_UNINSTALL_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_UNINSTALL_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_UNINSTALL_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_UNINSTALL_LOG_WIDTH

  • --release-history-limit (default: 10)

    Limit the number of releases in release history. When limit is exceeded the oldest releases are deleted. Release resources are not affected. Var: $NELM_RELEASE_HISTORY_LIMIT

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

release history

Show release history.

Usage:

nelm release history [options...] -n namespace -r release 

Options:

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Vars: $NELM_NAMESPACE, $NELM_RELEASE_HISTORY_NAMESPACE

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Vars: $NELM_RELEASE, $NELM_RELEASE_HISTORY_RELEASE

  • --revisions-limit (default: 0)

    Maximum number of revisions to show. 0 means no limit. Vars: $NELM_REVISIONS_LIMIT, $NELM_RELEASE_HISTORY_REVISIONS_LIMIT

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_RELEASE_HISTORY_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_RELEASE_HISTORY_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_RELEASE_HISTORY_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_RELEASE_HISTORY_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_RELEASE_HISTORY_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_RELEASE_HISTORY_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_RELEASE_HISTORY_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_RELEASE_HISTORY_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_RELEASE_HISTORY_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_RELEASE_HISTORY_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_RELEASE_HISTORY_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_RELEASE_HISTORY_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_RELEASE_HISTORY_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_RELEASE_HISTORY_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_RELEASE_HISTORY_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_RELEASE_HISTORY_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_RELEASE_HISTORY_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_RELEASE_HISTORY_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_RELEASE_HISTORY_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_RELEASE_HISTORY_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_RELEASE_HISTORY_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_RELEASE_HISTORY_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_RELEASE_HISTORY_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_RELEASE_HISTORY_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_RELEASE_HISTORY_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_RELEASE_HISTORY_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_RELEASE_HISTORY_KUBE_QPS_LIMIT

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_HISTORY_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_HISTORY_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_HISTORY_LOG_WIDTH

  • --output-format (default: "table")

    Result output format. Vars: $NELM_OUTPUT_FORMAT, $NELM_RELEASE_HISTORY_OUTPUT_FORMAT

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

release list

List all deployed releases.

Usage:

nelm release list [options...] [-n namespace]

Options:

  • -n, --namespace (default: "")

    The release namespace. Query all namespaces if not specified. Vars: $NELM_NAMESPACE, $NELM_RELEASE_LIST_NAMESPACE

  • --release-label-selector (default: "")

    Kubernetes label selector for stored revisions; list the latest matching revision of each release. Vars: $NELM_RELEASE_LABEL_SELECTOR, $NELM_RELEASE_LIST_RELEASE_LABEL_SELECTOR

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_RELEASE_LIST_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_RELEASE_LIST_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_RELEASE_LIST_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_RELEASE_LIST_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_RELEASE_LIST_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_RELEASE_LIST_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_RELEASE_LIST_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_RELEASE_LIST_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_RELEASE_LIST_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_RELEASE_LIST_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_RELEASE_LIST_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_RELEASE_LIST_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_RELEASE_LIST_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_RELEASE_LIST_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_RELEASE_LIST_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_RELEASE_LIST_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_RELEASE_LIST_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_RELEASE_LIST_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_RELEASE_LIST_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_RELEASE_LIST_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_RELEASE_LIST_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_RELEASE_LIST_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_RELEASE_LIST_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_RELEASE_LIST_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_RELEASE_LIST_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_RELEASE_LIST_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_RELEASE_LIST_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_RELEASE_LIST_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_LIST_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_LIST_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_LIST_LOG_WIDTH

  • --output-format (default: "table")

    Result output format. Vars: $NELM_OUTPUT_FORMAT, $NELM_RELEASE_LIST_OUTPUT_FORMAT

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

release get

Get information about a deployed release.

Usage:

nelm release get [options...] -n namespace -r release [revision]

Options:

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Vars: $NELM_NAMESPACE, $NELM_RELEASE_GET_NAMESPACE

  • --print-values (default: false)

    Print Values of the last Helm release. Var: $NELM_RELEASE_GET_PRINT_VALUES

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Vars: $NELM_RELEASE, $NELM_RELEASE_GET_RELEASE

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_RELEASE_GET_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_RELEASE_GET_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_RELEASE_GET_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_RELEASE_GET_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_RELEASE_GET_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_RELEASE_GET_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_RELEASE_GET_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_RELEASE_GET_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_RELEASE_GET_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_RELEASE_GET_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_RELEASE_GET_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_RELEASE_GET_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_RELEASE_GET_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_RELEASE_GET_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_RELEASE_GET_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_RELEASE_GET_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_RELEASE_GET_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_RELEASE_GET_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_RELEASE_GET_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_RELEASE_GET_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_RELEASE_GET_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_RELEASE_GET_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_RELEASE_GET_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_RELEASE_GET_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_RELEASE_GET_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_RELEASE_GET_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_RELEASE_GET_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_RELEASE_GET_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_GET_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_GET_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_GET_LOG_WIDTH

  • --output-format (default: "yaml")

    Result output format. Vars: $NELM_OUTPUT_FORMAT, $NELM_RELEASE_GET_OUTPUT_FORMAT

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

release plan show

Show plan artifact planned changes.

Usage:

nelm release plan show [options...] plan.json

Options:

  • --secret-key (default: "")

    Secret key for decrypting the plan artifact. Vars: $NELM_SECRET_KEY, $NELM_RELEASE_PLAN_SHOW_SECRET_KEY

  • --secret-work-dir (default: "")

    Working directory for secret operations. Vars: $NELM_SECRET_WORK_DIR, $NELM_RELEASE_PLAN_SHOW_SECRET_WORK_DIR

  • --show-insignificant-diffs (default: false)

    Show insignificant diff lines. Var: $NELM_RELEASE_PLAN_SHOW_SHOW_INSIGNIFICANT_DIFFS

  • --show-sensitive-diffs (default: false)

    Show sensitive diff lines. Var: $NELM_RELEASE_PLAN_SHOW_SHOW_SENSITIVE_DIFFS

  • --show-verbose-crd-diffs (default: false)

    Show verbose CRD diff lines. Var: $NELM_RELEASE_PLAN_SHOW_SHOW_VERBOSE_CRD_DIFFS

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_RELEASE_PLAN_SHOW_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_RELEASE_PLAN_SHOW_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_RELEASE_PLAN_SHOW_LOG_WIDTH

  • --temp-dir (default: "")

    Temporary directory for operation. Vars: $NELM_TEMP_DIR, $NELM_RELEASE_PLAN_SHOW_TEMP_DIR

chart lint

Lint a chart.

Usage:

nelm chart lint [options...] [chart-dir|chart-repo-name/chart-name|chart-archive|chart-archive-url]

Options:

  • --chart-version (default: "")

    Choose a remote chart version, otherwise the latest version is used. Vars: $NELM_CHART_VERSION, $NELM_CHART_LINT_CHART_VERSION

  • --delete-propagation (default: "Background")

    Default delete propagation strategy. Vars: $NELM_DELETE_PROPAGATION, $NELM_CHART_LINT_DELETE_PROPAGATION

  • --extra-apiversions (default: [])

    Extra Kubernetes API versions passed to $.Capabilities.APIVersions. Vars: $NELM_EXTRA_APIVERSIONS_*, $NELM_CHART_LINT_EXTRA_APIVERSIONS_*

  • --force-adoption (default: false)

    Always adopt resources, even if they belong to a different Helm release. Vars: $NELM_FORCE_ADOPTION, $NELM_CHART_LINT_FORCE_ADOPTION

  • --kube-version (default: "1.36.0")

    Kubernetes version stub for non-remote mode. Var: $NELM_CHART_LINT_KUBE_VERSION

  • --lookup-resources (default: [])

    Manifest files used as a cluster stub for the lookup template function in non-remote mode. Multi-document and kind:List supported. Namespaced resources must set metadata.namespace, otherwise namespace-scoped lookups ignore the requested namespace. Vars: $NELM_LOOKUP_RESOURCES_*, $NELM_CHART_LINT_LOOKUP_RESOURCES_*

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Defaults to the one recorded in the chart's .werf-data, else to a stub. Vars: $NELM_NAMESPACE, $NELM_CHART_LINT_NAMESPACE

  • --no-remove-manual-changes (default: false)

    Don't remove fields added manually to the resource in the cluster if fields aren't present in the manifest. Vars: $NELM_NO_REMOVE_MANUAL_CHANGES, $NELM_CHART_LINT_NO_REMOVE_MANUAL_CHANGES

  • --provenance-keyring (default: "")

    Path to keyring containing public keys to verify chart provenance. Vars: $NELM_PROVENANCE_KEYRING, $NELM_CHART_LINT_PROVENANCE_KEYRING

  • --provenance-strategy (default: "never")

    Strategy for provenance verifying. Vars: $NELM_PROVENANCE_STRATEGY, $NELM_CHART_LINT_PROVENANCE_STRATEGY

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Defaults to the one recorded in the chart's .werf-data, else to a stub. Vars: $NELM_RELEASE, $NELM_CHART_LINT_RELEASE

  • --remote (default: false)

    Allow cluster access for additional checks. Var: $NELM_CHART_LINT_REMOTE

  • --templates-allow-dns (default: false)

    Allow performing DNS requests in templating. Vars: $NELM_TEMPLATES_ALLOW_DNS, $NELM_CHART_LINT_TEMPLATES_ALLOW_DNS

Values options:

  • --no-default-values (default: false)

    Ignore values.yaml of the top-level chart. Vars: $NELM_NO_DEFAULT_VALUES, $NELM_CHART_LINT_NO_DEFAULT_VALUES

  • --set (default: [])

    Set new values, where the key is the value path and the value is the value. Vars: $NELM_SET, $NELM_CHART_LINT_SET

  • --set-file (default: [])

    Set new values, where the key is the value path and the value is the path to the file with the value content. Vars: $NELM_SET_FILE, $NELM_CHART_LINT_SET_FILE

  • --set-json (default: [])

    Set new values, where the key is the value path and the value is JSON. Vars: $NELM_SET_JSON, $NELM_CHART_LINT_SET_JSON

  • --set-literal (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a literal string. Vars: $NELM_SET_LITERAL, $NELM_CHART_LINT_SET_LITERAL

  • --set-root-json (default: [])

    Set new keys in the global context ($), where the key is the value path and the value is JSON. This is meant to be generated inside the program, so use --set-json instead, unless you know what you are doing. Vars: $NELM_SET_ROOT_JSON, $NELM_CHART_LINT_SET_ROOT_JSON

  • --set-string (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a string. Vars: $NELM_SET_STRING, $NELM_CHART_LINT_SET_STRING

  • --values (default: [])

    Additional values files. Vars: $NELM_VALUES, $NELM_CHART_LINT_VALUES

Secret options:

  • --no-decrypt-secrets (default: false)

    Do not decrypt secrets and secret values, pass them as is. Vars: $NELM_NO_DECRYPT_SECRETS, $NELM_CHART_LINT_NO_DECRYPT_SECRETS

  • --no-default-secret-values (default: false)

    Ignore secret-values.yaml of the top-level chart and its subcharts. Vars: $NELM_NO_DEFAULT_SECRET_VALUES, $NELM_CHART_LINT_NO_DEFAULT_SECRET_VALUES

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_LINT_SECRET_KEY

  • --secret-values (default: [])

    Secret values files paths. Vars: $NELM_SECRET_VALUES, $NELM_CHART_LINT_SECRET_VALUES

Resource validation options:

  • --no-resource-validation (default: false)

    Disable resource validation. Vars: $NELM_NO_RESOURCE_VALIDATION, $NELM_CHART_LINT_NO_RESOURCE_VALIDATION

  • --no-values-schema-validation (default: false)

    Disable values validation against JSON schema. Vars: $NELM_NO_VALUES_SCHEMA_VALIDATION, $NELM_CHART_LINT_NO_VALUES_SCHEMA_VALIDATION

  • --resource-validation-cache-lifetime (default: 48h0m0s)

    How long local schema cache will be valid. Vars: $NELM_RESOURCE_VALIDATION_CACHE_LIFETIME, $NELM_CHART_LINT_RESOURCE_VALIDATION_CACHE_LIFETIME

  • --resource-validation-extra-schema (default: [])

    Extra json schema sources to validate resources, preferred over the json schemas embedded into the binary. Which source served a resource kind is cached for --resource-validation-cache-lifetime, so a schema that only appears in these sources later takes over once that entry expires, whereas changing this option resets the cache at once. Must be a valid go template defining a http(s) URL, or an absolute path on local file system. Example: https://raw\.githubusercontent\.com/yannh/kubernetes\-json\-schema/master/\{\{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json. Vars: $NELM_RESOURCE_VALIDATION_EXTRA_SCHEMA_*, $NELM_CHART_LINT_RESOURCE_VALIDATION_EXTRA_SCHEMA_*

  • --resource-validation-skip (default: [])

    Skip resource validation for resources with specified attributes. Format: key1=value1,key2=value2. Supported keys: group, version, kind, name, namespace. Example: kind=Deployment,name=my-app. Vars: $NELM_RESOURCE_VALIDATION_SKIP, $NELM_CHART_LINT_RESOURCE_VALIDATION_SKIP

Patch options:

  • --annotations (default: {})

    Add annotations to all resources. Vars: $NELM_ANNOTATIONS_*, $NELM_CHART_LINT_ANNOTATIONS_*

  • --app-version (default: "")

    Set appVersion of Chart.yaml. Vars: $NELM_APP_VERSION, $NELM_CHART_LINT_APP_VERSION

  • --labels (default: {})

    Add labels to all resources. Vars: $NELM_LABELS_*, $NELM_CHART_LINT_LABELS_*

  • --no-default-patches (default: false)

    Ignore patches.yaml of the top-level chart and subcharts. Vars: $NELM_NO_DEFAULT_PATCHES, $NELM_CHART_LINT_NO_DEFAULT_PATCHES

  • --patches (default: [])

    Additional patches files (render patches for rendered resources, diff patches for drift detection). Vars: $NELM_PATCHES, $NELM_CHART_LINT_PATCHES

  • --runtime-annotations (default: {})

    Add annotations which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_ANNOTATIONS_*, $NELM_CHART_LINT_RUNTIME_ANNOTATIONS_*

  • --runtime-labels (default: {})

    Add labels which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_LABELS_*, $NELM_CHART_LINT_RUNTIME_LABELS_*

TypeScript options:

  • --ignore-bundle-js (default: false)

    Do not use the existing bundle.js file. Requires TypeScript source files to rebuild. Vars: $NELM_IGNORE_BUNDLE_JS, $NELM_CHART_LINT_IGNORE_BUNDLE_JS

  • --node-binary-path (default: "")

    Path to the Node.js binary to use instead of the one in PATH. Vars: $NELM_NODE_BINARY_PATH, $NELM_CHART_LINT_NODE_BINARY_PATH

Progress options:

  • --no-final-tracking (default: false)

    By default disable tracking operations that have no create/update/delete resource operations after them, which are most tracking operations, to speed up the release. Vars: $NELM_NO_FINAL_TRACKING, $NELM_CHART_LINT_NO_FINAL_TRACKING

Chart repository options:

  • --chart-repo-basic-password (default: "")

    Basic auth password to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_PASSWORD, $NELM_CHART_LINT_CHART_REPO_BASIC_PASSWORD

  • --chart-repo-basic-username (default: "")

    Basic auth username to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_USERNAME, $NELM_CHART_LINT_CHART_REPO_BASIC_USERNAME

  • --chart-repo-ca (default: "")

    Path to TLS CA file for connecting to chart repository. Vars: $NELM_CHART_REPO_CA, $NELM_CHART_LINT_CHART_REPO_CA

  • --chart-repo-cert (default: "")

    Path to TLS client cert file for connecting to chart repository. Vars: $NELM_CHART_REPO_CERT, $NELM_CHART_LINT_CHART_REPO_CERT

  • --chart-repo-key (default: "")

    Path to TLS client key file for connecting to chart repository. Vars: $NELM_CHART_REPO_KEY, $NELM_CHART_LINT_CHART_REPO_KEY

  • --chart-repo-pass-creds (default: false)

    Allow sending chart repository credentials to domains different from the chart repository domain when downloading charts. Vars: $NELM_CHART_REPO_PASS_CREDS, $NELM_CHART_LINT_CHART_REPO_PASS_CREDS

  • --chart-repo-request-timeout (default: 0s)

    Set timeout for all requests to chart repository. A request includes its whole body, so the timeout also bounds a whole blob download or upload. Vars: $NELM_CHART_REPO_REQUEST_TIMEOUT, $NELM_CHART_LINT_CHART_REPO_REQUEST_TIMEOUT

  • --chart-repo-url (default: "")

    Set URL of chart repo to be used to look for chart. Vars: $NELM_CHART_REPO_URL, $NELM_CHART_LINT_CHART_REPO_URL

  • --docker-config (default: "~/.docker")

    Docker config directory path. Vars: $DOCKER_CONFIG, $NELM_DOCKER_CONFIG, $NELM_CHART_LINT_DOCKER_CONFIG

  • --insecure-chart-repos (default: false)

    Allow insecure HTTP connections to chart repository. Vars: $NELM_INSECURE_CHART_REPOS, $NELM_CHART_LINT_INSECURE_CHART_REPOS

  • --no-update-chart-repos (default: false)

    Don't update chart repositories index. Vars: $NELM_NO_UPDATE_CHART_REPOS, $NELM_CHART_LINT_NO_UPDATE_CHART_REPOS

  • --no-verify-chart-repos-tls (default: false)

    Don't verify TLS certificates of chart repository. Vars: $NELM_NO_VERIFY_CHART_REPOS_TLS, $NELM_CHART_LINT_NO_VERIFY_CHART_REPOS_TLS

  • --oci-chart-repos-creds (default: "")

    Credentials to access OCI chart repositories. Vars: $NELM_OCI_CHART_REPOS_CREDS, $NELM_CHART_LINT_OCI_CHART_REPOS_CREDS

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_CHART_LINT_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_CHART_LINT_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_CHART_LINT_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_CHART_LINT_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_CHART_LINT_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_CHART_LINT_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_CHART_LINT_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_CHART_LINT_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_CHART_LINT_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_CHART_LINT_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_CHART_LINT_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_CHART_LINT_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_CHART_LINT_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_CHART_LINT_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_CHART_LINT_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_CHART_LINT_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_CHART_LINT_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_CHART_LINT_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_CHART_LINT_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_CHART_LINT_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_CHART_LINT_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_CHART_LINT_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_CHART_LINT_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_CHART_LINT_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_CHART_LINT_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_CHART_LINT_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_CHART_LINT_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_CHART_LINT_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_LINT_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_LINT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_LINT_LOG_WIDTH

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart render

Render a chart.

Usage:

nelm chart render [options...] [chart-dir|chart-repo-name/chart-name|chart-archive|chart-archive-url]

Options:

  • --chart-version (default: "")

    Choose a remote chart version, otherwise the latest version is used. Vars: $NELM_CHART_VERSION, $NELM_CHART_RENDER_CHART_VERSION

  • --extra-apiversions (default: [])

    Extra Kubernetes API versions passed to $.Capabilities.APIVersions. Vars: $NELM_EXTRA_APIVERSIONS_*, $NELM_CHART_RENDER_EXTRA_APIVERSIONS_*

  • --kube-version (default: "1.36.0")

    Kubernetes version stub for non-remote mode. Var: $NELM_CHART_RENDER_KUBE_VERSION

  • --lookup-resources (default: [])

    Manifest files used as a cluster stub for the lookup template function in non-remote mode. Multi-document and kind:List supported. Namespaced resources must set metadata.namespace, otherwise namespace-scoped lookups ignore the requested namespace. Vars: $NELM_LOOKUP_RESOURCES_*, $NELM_CHART_RENDER_LOOKUP_RESOURCES_*

  • -n, --namespace (default: "")

    The release namespace. Resources with no namespace will be deployed here. Defaults to the one recorded in the chart's .werf-data, else to a stub. Vars: $NELM_NAMESPACE, $NELM_CHART_RENDER_NAMESPACE

  • --provenance-keyring (default: "")

    Path to keyring containing public keys to verify chart provenance. Vars: $NELM_PROVENANCE_KEYRING, $NELM_CHART_RENDER_PROVENANCE_KEYRING

  • --provenance-strategy (default: "never")

    Strategy for provenance verifying. Vars: $NELM_PROVENANCE_STRATEGY, $NELM_CHART_RENDER_PROVENANCE_STRATEGY

  • -r, --release (default: "")

    The release name. Must be unique within the release namespace. Defaults to the one recorded in the chart's .werf-data, else to a stub. Vars: $NELM_RELEASE, $NELM_CHART_RENDER_RELEASE

  • --remote (default: false)

    Allow cluster access to retrieve Kubernetes version, capabilities and other dynamic data. Var: $NELM_CHART_RENDER_REMOTE

  • --save-output-to (default: "")

    Save output with rendered manifests to a file. Var: $NELM_CHART_RENDER_SAVE_OUTPUT_TO

  • --show-crds (default: false)

    Show CRDs from "crds/" directories in the output. Var: $NELM_CHART_RENDER_SHOW_CRDS

  • --show-only (default: [])

    Show manifests only from specified template files. The render result has corresponding template paths specified before each resource manifest. Var: $NELM_CHART_RENDER_SHOW_ONLY_*

  • --templates-allow-dns (default: false)

    Allow performing DNS requests in templating. Vars: $NELM_TEMPLATES_ALLOW_DNS, $NELM_CHART_RENDER_TEMPLATES_ALLOW_DNS

Values options:

  • --no-default-values (default: false)

    Ignore values.yaml of the top-level chart. Vars: $NELM_NO_DEFAULT_VALUES, $NELM_CHART_RENDER_NO_DEFAULT_VALUES

  • --set (default: [])

    Set new values, where the key is the value path and the value is the value. Vars: $NELM_SET, $NELM_CHART_RENDER_SET

  • --set-file (default: [])

    Set new values, where the key is the value path and the value is the path to the file with the value content. Vars: $NELM_SET_FILE, $NELM_CHART_RENDER_SET_FILE

  • --set-json (default: [])

    Set new values, where the key is the value path and the value is JSON. Vars: $NELM_SET_JSON, $NELM_CHART_RENDER_SET_JSON

  • --set-literal (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a literal string. Vars: $NELM_SET_LITERAL, $NELM_CHART_RENDER_SET_LITERAL

  • --set-root-json (default: [])

    Set new keys in the global context ($), where the key is the value path and the value is JSON. This is meant to be generated inside the program, so use --set-json instead, unless you know what you are doing. Vars: $NELM_SET_ROOT_JSON, $NELM_CHART_RENDER_SET_ROOT_JSON

  • --set-string (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a string. Vars: $NELM_SET_STRING, $NELM_CHART_RENDER_SET_STRING

  • --values (default: [])

    Additional values files. Vars: $NELM_VALUES, $NELM_CHART_RENDER_VALUES

Secret options:

  • --no-decrypt-secrets (default: false)

    Do not decrypt secrets and secret values, pass them as is. Vars: $NELM_NO_DECRYPT_SECRETS, $NELM_CHART_RENDER_NO_DECRYPT_SECRETS

  • --no-default-secret-values (default: false)

    Ignore secret-values.yaml of the top-level chart and its subcharts. Vars: $NELM_NO_DEFAULT_SECRET_VALUES, $NELM_CHART_RENDER_NO_DEFAULT_SECRET_VALUES

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_RENDER_SECRET_KEY

  • --secret-values (default: [])

    Secret values files paths. Vars: $NELM_SECRET_VALUES, $NELM_CHART_RENDER_SECRET_VALUES

Resource validation options:

  • --no-values-schema-validation (default: false)

    Disable values validation against JSON schema. Vars: $NELM_NO_VALUES_SCHEMA_VALIDATION, $NELM_CHART_RENDER_NO_VALUES_SCHEMA_VALIDATION

Patch options:

  • --annotations (default: {})

    Add annotations to all resources. Vars: $NELM_ANNOTATIONS_*, $NELM_CHART_RENDER_ANNOTATIONS_*

  • --app-version (default: "")

    Set appVersion of Chart.yaml. Vars: $NELM_APP_VERSION, $NELM_CHART_RENDER_APP_VERSION

  • --labels (default: {})

    Add labels to all resources. Vars: $NELM_LABELS_*, $NELM_CHART_RENDER_LABELS_*

  • --no-default-patches (default: false)

    Ignore patches.yaml of the top-level chart and subcharts. Vars: $NELM_NO_DEFAULT_PATCHES, $NELM_CHART_RENDER_NO_DEFAULT_PATCHES

  • --patches (default: [])

    Additional patches files (render patches for rendered resources, diff patches for drift detection). Vars: $NELM_PATCHES, $NELM_CHART_RENDER_PATCHES

  • --runtime-annotations (default: {})

    Add annotations which will not trigger resource updates to all resources. Vars: $NELM_RUNTIME_ANNOTATIONS_*, $NELM_CHART_RENDER_RUNTIME_ANNOTATIONS_*

TypeScript options:

  • --ignore-bundle-js (default: false)

    Do not use the existing bundle.js file. Requires TypeScript source files to rebuild. Vars: $NELM_IGNORE_BUNDLE_JS, $NELM_CHART_RENDER_IGNORE_BUNDLE_JS

  • --node-binary-path (default: "")

    Path to the Node.js binary to use instead of the one in PATH. Vars: $NELM_NODE_BINARY_PATH, $NELM_CHART_RENDER_NODE_BINARY_PATH

Chart repository options:

  • --chart-repo-basic-password (default: "")

    Basic auth password to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_PASSWORD, $NELM_CHART_RENDER_CHART_REPO_BASIC_PASSWORD

  • --chart-repo-basic-username (default: "")

    Basic auth username to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_USERNAME, $NELM_CHART_RENDER_CHART_REPO_BASIC_USERNAME

  • --chart-repo-ca (default: "")

    Path to TLS CA file for connecting to chart repository. Vars: $NELM_CHART_REPO_CA, $NELM_CHART_RENDER_CHART_REPO_CA

  • --chart-repo-cert (default: "")

    Path to TLS client cert file for connecting to chart repository. Vars: $NELM_CHART_REPO_CERT, $NELM_CHART_RENDER_CHART_REPO_CERT

  • --chart-repo-key (default: "")

    Path to TLS client key file for connecting to chart repository. Vars: $NELM_CHART_REPO_KEY, $NELM_CHART_RENDER_CHART_REPO_KEY

  • --chart-repo-pass-creds (default: false)

    Allow sending chart repository credentials to domains different from the chart repository domain when downloading charts. Vars: $NELM_CHART_REPO_PASS_CREDS, $NELM_CHART_RENDER_CHART_REPO_PASS_CREDS

  • --chart-repo-request-timeout (default: 0s)

    Set timeout for all requests to chart repository. A request includes its whole body, so the timeout also bounds a whole blob download or upload. Vars: $NELM_CHART_REPO_REQUEST_TIMEOUT, $NELM_CHART_RENDER_CHART_REPO_REQUEST_TIMEOUT

  • --chart-repo-url (default: "")

    Set URL of chart repo to be used to look for chart. Vars: $NELM_CHART_REPO_URL, $NELM_CHART_RENDER_CHART_REPO_URL

  • --docker-config (default: "~/.docker")

    Docker config directory path. Vars: $DOCKER_CONFIG, $NELM_DOCKER_CONFIG, $NELM_CHART_RENDER_DOCKER_CONFIG

  • --insecure-chart-repos (default: false)

    Allow insecure HTTP connections to chart repository. Vars: $NELM_INSECURE_CHART_REPOS, $NELM_CHART_RENDER_INSECURE_CHART_REPOS

  • --no-update-chart-repos (default: false)

    Don't update chart repositories index. Vars: $NELM_NO_UPDATE_CHART_REPOS, $NELM_CHART_RENDER_NO_UPDATE_CHART_REPOS

  • --no-verify-chart-repos-tls (default: false)

    Don't verify TLS certificates of chart repository. Vars: $NELM_NO_VERIFY_CHART_REPOS_TLS, $NELM_CHART_RENDER_NO_VERIFY_CHART_REPOS_TLS

  • --oci-chart-repos-creds (default: "")

    Credentials to access OCI chart repositories. Vars: $NELM_OCI_CHART_REPOS_CREDS, $NELM_CHART_RENDER_OCI_CHART_REPOS_CREDS

Kubernetes connection options:

  • --kube-api-server (default: "")

    Kubernetes API server address. Vars: $NELM_KUBE_API_SERVER, $NELM_CHART_RENDER_KUBE_API_SERVER

  • --kube-api-server-tls-name (default: "")

    Server name for Kubernetes API TLS validation, if different from the hostname of Kubernetes API server. Vars: $NELM_KUBE_API_SERVER_TLS_NAME, $NELM_CHART_RENDER_KUBE_API_SERVER_TLS_NAME

  • --kube-auth-password (default: "")

    Basic auth password for Kubernetes API. Vars: $NELM_KUBE_AUTH_PASSWORD, $NELM_CHART_RENDER_KUBE_AUTH_PASSWORD

  • --kube-auth-provider (default: "")

    Auth provider name for authentication in Kubernetes. Vars: $NELM_KUBE_AUTH_PROVIDER, $NELM_CHART_RENDER_KUBE_AUTH_PROVIDER

  • --kube-auth-provider-config (default: {})

    Auth provider config for authentication in Kubernetes API. Vars: $NELM_KUBE_AUTH_PROVIDER_CONFIG, $NELM_CHART_RENDER_KUBE_AUTH_PROVIDER_CONFIG

  • --kube-auth-username (default: "")

    Basic auth username for Kubernetes API. Vars: $NELM_KUBE_AUTH_USERNAME, $NELM_CHART_RENDER_KUBE_AUTH_USERNAME

  • --kube-ca (default: "")

    Path to Kubernetes API server TLS CA file. Vars: $NELM_KUBE_CA, $NELM_CHART_RENDER_KUBE_CA

  • --kube-ca-data (default: "")

    Pass Kubernetes API server TLS CA data. Vars: $NELM_KUBE_CA_DATA, $NELM_CHART_RENDER_KUBE_CA_DATA

  • --kube-cert (default: "")

    Path to PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT, $NELM_CHART_RENDER_KUBE_CERT

  • --kube-cert-data (default: "")

    Pass PEM-encoded TLS client cert for connecting to Kubernetes API. Vars: $NELM_KUBE_CERT_DATA, $NELM_CHART_RENDER_KUBE_CERT_DATA

  • --kube-config (default: [])

    Kubeconfig path(s). If multiple specified, their contents are merged. Vars: $KUBECONFIG, $NELM_KUBE_CONFIG_*, $NELM_CHART_RENDER_KUBE_CONFIG_*

  • --kube-config-base64 (default: "")

    Pass Kubeconfig file content encoded as base64. Vars: $NELM_KUBE_CONFIG_BASE_64, $NELM_CHART_RENDER_KUBE_CONFIG_BASE_64

  • --kube-context (default: "")

    Use specified Kubeconfig context. Vars: $NELM_KUBE_CONTEXT, $NELM_CHART_RENDER_KUBE_CONTEXT

  • --kube-context-cluster (default: "")

    Use cluster from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_CLUSTER, $NELM_CHART_RENDER_KUBE_CONTEXT_CLUSTER

  • --kube-context-user (default: "")

    Use user from Kubeconfig for current context. Vars: $NELM_KUBE_CONTEXT_USER, $NELM_CHART_RENDER_KUBE_CONTEXT_USER

  • --kube-impersonate-group (default: [])

    Sets Impersonate-Group headers when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_GROUP, $NELM_CHART_RENDER_KUBE_IMPERSONATE_GROUP

  • --kube-impersonate-uid (default: "")

    Sets Impersonate-Uid header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_UID, $NELM_CHART_RENDER_KUBE_IMPERSONATE_UID

  • --kube-impersonate-user (default: "")

    Sets Impersonate-User header when authenticating in Kubernetes. Vars: $NELM_KUBE_IMPERSONATE_USER, $NELM_CHART_RENDER_KUBE_IMPERSONATE_USER

  • --kube-key (default: "")

    Path to PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY, $NELM_CHART_RENDER_KUBE_KEY

  • --kube-key-data (default: "")

    Pass PEM-encoded TLS client key for connecting to Kubernetes API. Vars: $NELM_KUBE_KEY_DATA, $NELM_CHART_RENDER_KUBE_KEY_DATA

  • --kube-proxy-url (default: "")

    Proxy URL to use for proxying all requests to Kubernetes API. Vars: $NELM_KUBE_PROXY_URL, $NELM_CHART_RENDER_KUBE_PROXY_URL

  • --kube-request-timeout (default: 0s)

    Timeout for all requests to Kubernetes API. Vars: $NELM_KUBE_REQUEST_TIMEOUT, $NELM_CHART_RENDER_KUBE_REQUEST_TIMEOUT

  • --kube-token (default: "")

    Bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN, $NELM_CHART_RENDER_KUBE_TOKEN

  • --kube-token-path (default: "")

    Path to file with bearer token for authentication in Kubernetes. Vars: $NELM_KUBE_TOKEN_PATH, $NELM_CHART_RENDER_KUBE_TOKEN_PATH

  • --no-verify-kube-tls (default: false)

    Don't verify TLS certificates of Kubernetes API. Vars: $NELM_NO_VERIFY_KUBE_TLS, $NELM_CHART_RENDER_NO_VERIFY_KUBE_TLS

Performance options:

  • --kube-burst-limit (default: 100)

    Burst limit for requests to Kubernetes. Vars: $NELM_KUBE_BURST_LIMIT, $NELM_CHART_RENDER_KUBE_BURST_LIMIT

  • --kube-qps-limit (default: 30)

    Queries Per Second limit for requests to Kubernetes. Vars: $NELM_KUBE_QPS_LIMIT, $NELM_CHART_RENDER_KUBE_QPS_LIMIT

  • --network-parallelism (default: 30)

    Limit of network-related tasks to run in parallel. Vars: $NELM_NETWORK_PARALLELISM, $NELM_CHART_RENDER_NETWORK_PARALLELISM

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_RENDER_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_RENDER_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_RENDER_LOG_WIDTH

  • --release-storage (default: "")

    How releases should be stored. Var: $NELM_RELEASE_STORAGE

  • --release-storage-sql-connection (default: "")

    SQL connection string for MySQL release storage driver. Var: $NELM_RELEASE_STORAGE_SQL_CONNECTION

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart download

Retrieve a package from a package repository, and download it locally.

This is useful for fetching packages to inspect, modify, or repackage. It can also be used to perform cryptographic verification of a chart without installing the chart.

There are options for unpacking the chart after download. This will create a directory for the chart and uncompress into that directory.

If the --verify flag is specified, the requested chart MUST have a provenance file, and MUST pass the verification process. Failure in any part of this will result in an error, and the chart will not be saved locally.

Usage:

nelm chart download [chart URL | repo/chartname] [...] [flags]

Other options:

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --ca-file (default: "")

    verify certificates of HTTPS-enabled servers using this CA bundle

  • --cert-file (default: "")

    identify HTTPS client using this SSL certificate file

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • -d, --destination (default: ".")

    location to write the chart. If this and untardir are specified, untardir is appended to this

  • --devel (default: false)

    use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.

  • --insecure-skip-tls-verify (default: false)

    skip tls certificate checks for the chart download

  • --key-file (default: "")

    identify HTTPS client using this SSL key file

  • --keyring (default: "~/.gnupg/pubring.gpg")

    location of public keys used for verification

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • --pass-credentials (default: false)

    pass credentials to all domains

  • --password (default: "")

    chart repository password where to locate the requested chart

  • --plain-http (default: false)

    use insecure HTTP connections for the chart download

  • --prov (default: false)

    fetch the provenance file, but don't perform verification

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repo (default: "")

    chart repository url where to locate the requested chart

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

  • --untar (default: false)

    if set to true, will untar the chart after downloading it

  • --untardir (default: ".")

    if untar is specified, this flag specifies the name of the directory into which the chart is expanded

  • --username (default: "")

    chart repository username where to locate the requested chart

  • --verify (default: false)

    verify the package before using it

  • --version (default: "")

    specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used

chart upload

Upload a chart archive to the OCI repository REMOTE/<chart name>, where REMOTE is oci://HOST[/PATH], under the chart version and the --tag tags, with a "+" in a tag pushed as "_". The provenance file <chart-archive>.prov is uploaded with the chart if it exists. A tag equal to the tag of an image from the helm.sh/images annotation of the chart in the same repository is refused before anything is uploaded. Loopback registries, like localhost:5000, are reached over plain HTTP unless TLS options are given.

Usage:

nelm chart upload [options...] chart-archive remote

Options:

  • --tag (default: [])

    Additional tag pointing to the uploaded chart, besides its version tag. Vars: $NELM_TAG, $NELM_CHART_UPLOAD_TAG

Chart repository options:

  • --chart-repo-basic-password (default: "")

    Basic auth password to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_PASSWORD, $NELM_CHART_UPLOAD_CHART_REPO_BASIC_PASSWORD

  • --chart-repo-basic-username (default: "")

    Basic auth username to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_USERNAME, $NELM_CHART_UPLOAD_CHART_REPO_BASIC_USERNAME

  • --chart-repo-ca (default: "")

    Path to TLS CA file for connecting to chart repository. Vars: $NELM_CHART_REPO_CA, $NELM_CHART_UPLOAD_CHART_REPO_CA

  • --chart-repo-cert (default: "")

    Path to TLS client cert file for connecting to chart repository. Vars: $NELM_CHART_REPO_CERT, $NELM_CHART_UPLOAD_CHART_REPO_CERT

  • --chart-repo-key (default: "")

    Path to TLS client key file for connecting to chart repository. Vars: $NELM_CHART_REPO_KEY, $NELM_CHART_UPLOAD_CHART_REPO_KEY

  • --chart-repo-request-timeout (default: 0s)

    Set timeout for all requests to chart repository. A request includes its whole body, so the timeout also bounds a whole blob download or upload. Vars: $NELM_CHART_REPO_REQUEST_TIMEOUT, $NELM_CHART_UPLOAD_CHART_REPO_REQUEST_TIMEOUT

  • --insecure-chart-repos (default: false)

    Allow insecure HTTP connections to chart repository. Vars: $NELM_INSECURE_CHART_REPOS, $NELM_CHART_UPLOAD_INSECURE_CHART_REPOS

  • --no-verify-chart-repos-tls (default: false)

    Don't verify TLS certificates of chart repository. Vars: $NELM_NO_VERIFY_CHART_REPOS_TLS, $NELM_CHART_UPLOAD_NO_VERIFY_CHART_REPOS_TLS

  • --oci-chart-repos-creds (default: "")

    Credentials to access OCI chart repositories. Vars: $NELM_OCI_CHART_REPOS_CREDS, $NELM_CHART_UPLOAD_OCI_CHART_REPOS_CREDS

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_UPLOAD_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_UPLOAD_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_UPLOAD_LOG_WIDTH

chart copy

Copy a chart with every image listed in its helm.sh/images annotation. FROM and TO are either an OCI repository, oci://REPO[:TAG] (docker://REPO[:TAG] or REPO[:TAG] also work), or an archive, archive:PATH or a path ending in .tar, .tar.gz or .tgz. A source repository without a tag means the "latest" tag. An archive is written as an OCI image layout; legacy bundle archives are also read. Copied to a repository, the chart is renamed to the repository basename and its images are copied into the repository by digest, keeping their tags. With TAG the chart version is TAG if it is a semver version (without the "v" prefix), or 0.0.0-<unix time>-<TAG slug> otherwise, and the chart is pushed under the version and TAG, with a "+" in either pushed as "_"; without TAG the chart keeps its version and is pushed under it and the source tag, if any (a legacy bundle archive has none). Images of chart dependencies are copied too, non-distributable layers included; referrers of the images, like signatures and SBOMs, are not copied. Loopback registries, like localhost:5000, are reached over plain HTTP.

Usage:

nelm chart copy FROM TO

Options:

  • --archive-max-expanded-size (default: "64Gi")

    Maximum size the source archive may decompress to, nested image tarballs included, and, separately, the maximum size extracted from its tars, e.g. 64Gi. Temporary files may take up to about twice as much. Vars: $NELM_ARCHIVE_MAX_EXPANDED_SIZE, $NELM_CHART_COPY_ARCHIVE_MAX_EXPANDED_SIZE

  • --sign (default: false)

    Sign the copy if it changes the chart. Without it, the provenance of a changed chart is dropped. Vars: $NELM_SIGN, $NELM_CHART_COPY_SIGN

  • --sign-key (default: "")

    Name of the key to sign with. Vars: $NELM_SIGN_KEY, $NELM_CHART_COPY_SIGN_KEY

  • --sign-keyring (default: "")

    Path to the keyring with the signing key. Vars: $NELM_SIGN_KEYRING, $NELM_CHART_COPY_SIGN_KEYRING

  • --sign-passphrase-file (default: "")

    Path to a file with the passphrase of the signing key, "-" for stdin. Vars: $NELM_SIGN_PASSPHRASE_FILE, $NELM_CHART_COPY_SIGN_PASSPHRASE_FILE

Chart repository options:

  • --chart-repo-basic-password (default: "")

    Basic auth password to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_PASSWORD, $NELM_CHART_COPY_CHART_REPO_BASIC_PASSWORD

  • --chart-repo-basic-username (default: "")

    Basic auth username to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_USERNAME, $NELM_CHART_COPY_CHART_REPO_BASIC_USERNAME

  • --chart-repo-ca (default: "")

    Path to TLS CA file for connecting to chart repository. Vars: $NELM_CHART_REPO_CA, $NELM_CHART_COPY_CHART_REPO_CA

  • --chart-repo-cert (default: "")

    Path to TLS client cert file for connecting to chart repository. Vars: $NELM_CHART_REPO_CERT, $NELM_CHART_COPY_CHART_REPO_CERT

  • --chart-repo-key (default: "")

    Path to TLS client key file for connecting to chart repository. Vars: $NELM_CHART_REPO_KEY, $NELM_CHART_COPY_CHART_REPO_KEY

  • --chart-repo-pass-creds (default: false)

    Allow sending chart repository credentials to domains different from the chart repository domain when downloading charts. Vars: $NELM_CHART_REPO_PASS_CREDS, $NELM_CHART_COPY_CHART_REPO_PASS_CREDS

  • --chart-repo-request-timeout (default: 0s)

    Set timeout for all requests to chart repository. A request includes its whole body, so the timeout also bounds a whole blob download or upload. Vars: $NELM_CHART_REPO_REQUEST_TIMEOUT, $NELM_CHART_COPY_CHART_REPO_REQUEST_TIMEOUT

  • --chart-repo-url (default: "")

    Set URL of chart repo to be used to look for chart. Vars: $NELM_CHART_REPO_URL, $NELM_CHART_COPY_CHART_REPO_URL

  • --insecure-chart-repos (default: false)

    Allow insecure HTTP connections to chart repository. Vars: $NELM_INSECURE_CHART_REPOS, $NELM_CHART_COPY_INSECURE_CHART_REPOS

  • --no-verify-chart-repos-tls (default: false)

    Don't verify TLS certificates of chart repository. Vars: $NELM_NO_VERIFY_CHART_REPOS_TLS, $NELM_CHART_COPY_NO_VERIFY_CHART_REPOS_TLS

  • --oci-chart-repos-creds (default: "")

    Credentials to access OCI chart repositories. Vars: $NELM_OCI_CHART_REPOS_CREDS, $NELM_CHART_COPY_OCI_CHART_REPOS_CREDS

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_COPY_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_COPY_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_COPY_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Reading an archive needs space for about the decompressed archive and twice its images. Var: $NELM_TEMP_DIR

chart pack

Pack a chart directory into a versioned chart archive. The publish-time inputs (values, secret values, set values, patches and default switches) are stored in .werf-data of the chart, on top of the ones the chart directory already has.

Usage:

nelm chart pack [options...] [chart-dir]

Options:

  • --dependency-update (default: false)

    Update Chart.lock and charts/ of the chart directory from Chart.yaml before packing. Vars: $NELM_DEPENDENCY_UPDATE, $NELM_CHART_PACK_DEPENDENCY_UPDATE

  • --destination (default: ".")

    The directory to save the chart archive to. Vars: $NELM_DESTINATION, $NELM_CHART_PACK_DESTINATION

  • --sign (default: false)

    Sign the chart archive with a PGP private key and save the provenance file next to it. Vars: $NELM_SIGN, $NELM_CHART_PACK_SIGN

  • --sign-key (default: "")

    Name of the key to sign the chart archive with. Vars: $NELM_SIGN_KEY, $NELM_CHART_PACK_SIGN_KEY

  • --sign-keyring (default: "")

    Path to keyring containing the key to sign the chart archive with. Vars: $NELM_SIGN_KEYRING, $NELM_CHART_PACK_SIGN_KEYRING

  • --sign-passphrase-file (default: "")

    Path to file with the passphrase of the signing key, "-" to read it from stdin. Prompted for if not set. Vars: $NELM_SIGN_PASSPHRASE_FILE, $NELM_CHART_PACK_SIGN_PASSPHRASE_FILE

Values options:

  • --no-default-values (default: false)

    Ignore values.yaml of the top-level chart. Vars: $NELM_NO_DEFAULT_VALUES, $NELM_CHART_PACK_NO_DEFAULT_VALUES

  • --reset-values (default: false)

    Drop all publish-time inputs stored in .werf-data of the chart by previous packs (values, secret values, set values, patches, default switches, release defaults, extra values, annotations, labels and images) before storing the ones of this pack. Vars: $NELM_RESET_VALUES, $NELM_CHART_PACK_RESET_VALUES

  • --set (default: [])

    Set new values, where the key is the value path and the value is the value. Vars: $NELM_SET, $NELM_CHART_PACK_SET

  • --set-file (default: [])

    Set new values, where the key is the value path and the value is the path to the file with the value content. Vars: $NELM_SET_FILE, $NELM_CHART_PACK_SET_FILE

  • --set-json (default: [])

    Set new values, where the key is the value path and the value is JSON. Vars: $NELM_SET_JSON, $NELM_CHART_PACK_SET_JSON

  • --set-literal (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a literal string. Vars: $NELM_SET_LITERAL, $NELM_CHART_PACK_SET_LITERAL

  • --set-root-json (default: [])

    Set new keys in the global context ($), where the key is the value path and the value is JSON. This is meant to be generated inside the program, so use --set-json instead, unless you know what you are doing. Vars: $NELM_SET_ROOT_JSON, $NELM_CHART_PACK_SET_ROOT_JSON

  • --set-string (default: [])

    Set new values, where the key is the value path and the value is the value. The value will always become a string. Vars: $NELM_SET_STRING, $NELM_CHART_PACK_SET_STRING

  • --values (default: [])

    Additional values files. Vars: $NELM_VALUES, $NELM_CHART_PACK_VALUES

Secret options:

  • --no-default-secret-values (default: false)

    Ignore secret-values.yaml of the top-level chart. Vars: $NELM_NO_DEFAULT_SECRET_VALUES, $NELM_CHART_PACK_NO_DEFAULT_SECRET_VALUES

  • --secret-values (default: [])

    Secret values files paths. Vars: $NELM_SECRET_VALUES, $NELM_CHART_PACK_SECRET_VALUES

Patch options:

  • --app-version (default: "")

    Set appVersion of Chart.yaml. Vars: $NELM_APP_VERSION, $NELM_CHART_PACK_APP_VERSION

  • --chart-name (default: "")

    Set name of Chart.yaml. Vars: $NELM_CHART_NAME, $NELM_CHART_PACK_CHART_NAME

  • --chart-version (default: "")

    Set version of Chart.yaml. Vars: $NELM_CHART_VERSION, $NELM_CHART_PACK_CHART_VERSION

  • --no-default-patches (default: false)

    Ignore patches.yaml of the top-level chart and subcharts. Vars: $NELM_NO_DEFAULT_PATCHES, $NELM_CHART_PACK_NO_DEFAULT_PATCHES

  • --patches (default: [])

    Additional patches files (render patches for rendered resources, diff patches for drift detection). Vars: $NELM_PATCHES, $NELM_CHART_PACK_PATCHES

TypeScript options:

  • --ts-no-rebuild (default: false)

    Reuse the existing TypeScript bundle instead of rebuilding it. Vars: $NELM_TS_NO_REBUILD, $NELM_CHART_PACK_TS_NO_REBUILD

Chart repository options:

  • --chart-repo-basic-password (default: "")

    Basic auth password to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_PASSWORD, $NELM_CHART_PACK_CHART_REPO_BASIC_PASSWORD

  • --chart-repo-basic-username (default: "")

    Basic auth username to authenticate in chart repository. Vars: $NELM_CHART_REPO_BASIC_USERNAME, $NELM_CHART_PACK_CHART_REPO_BASIC_USERNAME

  • --chart-repo-ca (default: "")

    Path to TLS CA file for connecting to chart repository. Vars: $NELM_CHART_REPO_CA, $NELM_CHART_PACK_CHART_REPO_CA

  • --chart-repo-cert (default: "")

    Path to TLS client cert file for connecting to chart repository. Vars: $NELM_CHART_REPO_CERT, $NELM_CHART_PACK_CHART_REPO_CERT

  • --chart-repo-key (default: "")

    Path to TLS client key file for connecting to chart repository. Vars: $NELM_CHART_REPO_KEY, $NELM_CHART_PACK_CHART_REPO_KEY

  • --chart-repo-request-timeout (default: 0s)

    Set timeout for all requests to chart repository. A request includes its whole body, so the timeout also bounds a whole blob download or upload. Vars: $NELM_CHART_REPO_REQUEST_TIMEOUT, $NELM_CHART_PACK_CHART_REPO_REQUEST_TIMEOUT

  • --docker-config (default: "~/.docker")

    Docker config directory path. Vars: $DOCKER_CONFIG, $NELM_DOCKER_CONFIG, $NELM_CHART_PACK_DOCKER_CONFIG

  • --insecure-chart-repos (default: false)

    Allow insecure HTTP connections to chart repository. Vars: $NELM_INSECURE_CHART_REPOS, $NELM_CHART_PACK_INSECURE_CHART_REPOS

  • --no-update-chart-repos (default: false)

    Don't update chart repositories index. Vars: $NELM_NO_UPDATE_CHART_REPOS, $NELM_CHART_PACK_NO_UPDATE_CHART_REPOS

  • --no-verify-chart-repos-tls (default: false)

    Don't verify TLS certificates of chart repository. Vars: $NELM_NO_VERIFY_CHART_REPOS_TLS, $NELM_CHART_PACK_NO_VERIFY_CHART_REPOS_TLS

  • --oci-chart-repos-creds (default: "")

    Credentials to access OCI chart repositories. Vars: $NELM_OCI_CHART_REPOS_CREDS, $NELM_CHART_PACK_OCI_CHART_REPOS_CREDS

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_PACK_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_PACK_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_PACK_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, use the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart secret key create

Create a new chart secret key.

Usage:

nelm chart secret key create [options...]

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_SECRET_KEY_CREATE_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_SECRET_KEY_CREATE_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_SECRET_KEY_CREATE_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart secret values-file edit

Interactively edit encrypted values file.

Usage:

nelm chart secret values-file edit [options...] --secret-key secret-key values-file

Options:

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_SECRET_VALUES_FILE_EDIT_SECRET_KEY

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_SECRET_VALUES_FILE_EDIT_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_SECRET_VALUES_FILE_EDIT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_SECRET_VALUES_FILE_EDIT_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart secret values-file encrypt

Encrypt values file and print result to stdout.

Usage:

nelm chart secret values-file encrypt [options...] --secret-key secret-key values-file

Options:

  • --save-output-to (default: "")

    Save encrypted output to a file. Var: $NELM_CHART_SECRET_VALUES_FILE_ENCRYPT_SAVE_OUTPUT_TO

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_SECRET_VALUES_FILE_ENCRYPT_SECRET_KEY

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_SECRET_VALUES_FILE_ENCRYPT_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_SECRET_VALUES_FILE_ENCRYPT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_SECRET_VALUES_FILE_ENCRYPT_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart secret values-file decrypt

Decrypt values file and print result to stdout.

Usage:

nelm chart secret values-file decrypt [options...] --secret-key secret-key values-file

Options:

  • --save-output-to (default: "")

    Save decrypted output to a file. Var: $NELM_CHART_SECRET_VALUES_FILE_DECRYPT_SAVE_OUTPUT_TO

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_SECRET_VALUES_FILE_DECRYPT_SECRET_KEY

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_SECRET_VALUES_FILE_DECRYPT_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_SECRET_VALUES_FILE_DECRYPT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_SECRET_VALUES_FILE_DECRYPT_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart secret file edit

Interactively edit encrypted file.

Usage:

nelm chart secret file edit [options...] --secret-key secret-key file

Options:

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_SECRET_FILE_EDIT_SECRET_KEY

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Vars: $NELM_COLOR_MODE, $NELM_CHART_SECRET_FILE_EDIT_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_SECRET_FILE_EDIT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_SECRET_FILE_EDIT_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart secret file encrypt

Encrypt file and print result to stdout.

Usage:

nelm chart secret file encrypt [options...] --secret-key secret-key file

Options:

  • --save-output-to (default: "")

    Save encrypted output to a file. Var: $NELM_CHART_SECRET_FILE_ENCRYPT_SAVE_OUTPUT_TO

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_SECRET_FILE_ENCRYPT_SECRET_KEY

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_SECRET_FILE_ENCRYPT_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_SECRET_FILE_ENCRYPT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_SECRET_FILE_ENCRYPT_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart secret file decrypt

Decrypt file and print result to stdout.

Usage:

nelm chart secret file decrypt [options...] --secret-key secret-key file

Options:

  • --save-output-to (default: "")

    Save decrypted output to a file. Var: $NELM_CHART_SECRET_FILE_DECRYPT_SAVE_OUTPUT_TO

  • --secret-key (default: "")

    Secret key. Vars: $NELM_SECRET_KEY, $NELM_CHART_SECRET_FILE_DECRYPT_SECRET_KEY

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_SECRET_FILE_DECRYPT_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_SECRET_FILE_DECRYPT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_SECRET_FILE_DECRYPT_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart dependency download

Download chart dependencies from Chart.lock.

Usage:

nelm chart dependency download CHART [flags]

Other options:

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --ca-file (default: "")

    verify certificates of HTTPS-enabled servers using this CA bundle

  • --cert-file (default: "")

    identify HTTPS client using this SSL certificate file

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • --insecure-skip-tls-verify (default: false)

    skip tls certificate checks for the chart download

  • --key-file (default: "")

    identify HTTPS client using this SSL key file

  • --keyring (default: "~/.gnupg/pubring.gpg")

    keyring containing public keys

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • --password (default: "")

    chart repository password where to locate the requested chart

  • --plain-http (default: false)

    use insecure HTTP connections for the chart download

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

  • --skip-refresh (default: false)

    do not refresh the local repository cache

  • --username (default: "")

    chart repository username where to locate the requested chart

  • --verify (default: false)

    verify the packages against signatures

chart dependency update

Update the on-disk dependencies to mirror Chart.yaml.

This command verifies that the required charts, as expressed in 'Chart.yaml', are present in 'charts/' and are at an acceptable version. It will pull down the latest charts that satisfy the dependencies, and clean up old dependencies.

On successful update, this will generate a lock file that can be used to rebuild the dependencies to an exact version.

Dependencies are not required to be represented in 'Chart.yaml'. For that reason, an update command will not remove charts unless they are (a) present in the Chart.yaml file, but (b) at the wrong version.

Usage:

nelm chart dependency update CHART [flags]

Other options:

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --ca-file (default: "")

    verify certificates of HTTPS-enabled servers using this CA bundle

  • --cert-file (default: "")

    identify HTTPS client using this SSL certificate file

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • --insecure-skip-tls-verify (default: false)

    skip tls certificate checks for the chart download

  • --key-file (default: "")

    identify HTTPS client using this SSL key file

  • --keyring (default: "~/.gnupg/pubring.gpg")

    keyring containing public keys

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • --password (default: "")

    chart repository password where to locate the requested chart

  • --plain-http (default: false)

    use insecure HTTP connections for the chart download

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

  • --skip-refresh (default: false)

    do not refresh the local repository cache

  • --username (default: "")

    chart repository username where to locate the requested chart

  • --verify (default: false)

    verify the packages against signatures

chart repo add

Set up a new chart repository.

Usage:

nelm chart repo add [NAME] [URL] [flags]

Other options:

  • --allow-deprecated-repos (default: false)

    by default, this command will not allow adding official repos that have been permanently deleted. This disables that behavior

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --ca-file (default: "")

    verify certificates of HTTPS-enabled servers using this CA bundle

  • --cert-file (default: "")

    identify HTTPS client using this SSL certificate file

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • --force-update (default: false)

    replace (overwrite) the repo if it already exists

  • --insecure-skip-tls-verify (default: false)

    skip tls certificate checks for the repository

  • --key-file (default: "")

    identify HTTPS client using this SSL key file

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • --pass-credentials (default: false)

    pass credentials to all domains

  • --password (default: "")

    chart repository password

  • --password-stdin (default: false)

    read chart repository password from stdin

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

  • --timeout (default: 2m0s)

    time to wait for the index file download to complete

  • --username (default: "")

    chart repository username

chart repo remove

Remove a chart repository.

Usage:

nelm chart repo remove [REPO1 [REPO2 ...]] [flags]

Other options:

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

chart repo update

Update info about available charts for all chart repositories.

Usage:

nelm chart repo update [REPO1 [REPO2 ...]] [flags]

Other options:

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

  • --timeout (default: 2m0s)

    time to wait for the index file download to complete

chart repo login

Log in to an OCI registry with charts.

Usage:

nelm chart repo login [host] [flags]

Other options:

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --ca-file (default: "")

    verify certificates of HTTPS-enabled servers using this CA bundle

  • --cert-file (default: "")

    identify registry client using this SSL certificate file

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • --insecure (default: false)

    allow connections to TLS registry without certs

  • --key-file (default: "")

    identify registry client using this SSL key file

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • -p, --password (default: "")

    registry password or identity token

  • --password-stdin (default: false)

    read password or identity token from stdin

  • --plain-http (default: false)

    use insecure HTTP connections for the chart upload

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

  • -u, --username (default: "")

    registry username

chart repo logout

Log out from an OCI registry with charts.

Usage:

nelm chart repo logout [host] [flags]

Other options:

  • --burst-limit (default: 100)

    client-side default throttling limit

  • --color (default: "auto")

    use colored output (never, auto, always)

  • --colour (default: "auto")

    use colored output (never, auto, always)

  • --content-cache (default: "~/.cache/helm/content")

    path to the directory containing cached content (e.g. charts)

  • --debug (default: false)

    enable verbose output

  • --kube-apiserver (default: "")

    the address and the port for the Kubernetes API server

  • --kube-as-group (default: [])

    group to impersonate for the operation, this flag can be repeated to specify multiple groups.

  • --kube-as-user (default: "")

    username to impersonate for the operation

  • --kube-ca-file (default: "")

    the certificate authority file for the Kubernetes API server connection

  • --kube-context (default: "")

    name of the kubeconfig context to use

  • --kube-insecure-skip-tls-verify (default: false)

    if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure

  • --kube-tls-server-name (default: "")

    server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used

  • --kube-token (default: "")

    bearer token used for authentication

  • --kubeconfig (default: "")

    path to the kubeconfig file

  • -n, --namespace (default: "")

    namespace scope for this request

  • --qps (default: 0)

    queries per second used when communicating with the Kubernetes API, not including bursting

  • --registry-config (default: "~/.config/helm/registry/config.json")

    path to the registry config file

  • --repository-cache (default: "~/.cache/helm/repository")

    path to the directory containing cached repository indexes

  • --repository-config (default: "~/.config/helm/repositories.yaml")

    path to the file containing repository names and URLs

chart ts init

Initialize the files needed to render manifests using TypeScript. If PATH is not specified, uses the current directory.

Usage:

nelm chart ts init [PATH]

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_TS_INIT_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_TS_INIT_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_TS_INIT_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

chart ts build

Build TypeScript chart in the specified directory. If PATH is not specified, uses the current directory.

Usage:

nelm chart ts build [PATH]

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_CHART_TS_BUILD_COLOR_MODE

  • --log-level (default: "info")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_CHART_TS_BUILD_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_CHART_TS_BUILD_LOG_WIDTH

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

completion bash

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

source <(nelm completion bash)

To load completions for every new session, execute once:

#### Linux:

nelm completion bash > /etc/bash_completion.d/nelm

#### macOS:

nelm completion bash > $(brew --prefix)/etc/bash_completion.d/nelm

You will need to start a new shell for this setup to take effect.

Usage:

nelm completion bash

Other options:

  • --no-descriptions (default: false)

    disable completion descriptions

completion fish

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

nelm completion fish | source

To load completions for every new session, execute once:

nelm completion fish > ~/.config/fish/completions/nelm.fish

You will need to start a new shell for this setup to take effect.

Usage:

nelm completion fish [flags]

Other options:

  • --no-descriptions (default: false)

    disable completion descriptions

completion powershell

Generate the autocompletion script for powershell.

To load completions in your current shell session:

nelm completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command to your powershell profile.

Usage:

nelm completion powershell [flags]

Other options:

  • --no-descriptions (default: false)

    disable completion descriptions

completion zsh

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(nelm completion zsh)

To load completions for every new session, execute once:

#### Linux:

nelm completion zsh > "${fpath[1]}/_nelm"

#### macOS:

nelm completion zsh > $(brew --prefix)/share/zsh/site-functions/_nelm

You will need to start a new shell for this setup to take effect.

Usage:

nelm completion zsh [flags]

Other options:

  • --no-descriptions (default: false)

    disable completion descriptions

version

Show version.

Usage:

nelm version [options...]

Other options:

  • --color-mode (default: "auto")

    Color mode for logs. Allowed: auto, off, on. Vars: $NELM_COLOR_MODE, $NELM_VERSION_COLOR_MODE

  • --log-level (default: "error")

    Set log level. Allowed: silent, error, warning, info, debug, trace. Vars: $NELM_LOG_LEVEL, $NELM_VERSION_LOG_LEVEL

  • --log-width (default: 0)

    Set log width. 0 to detect automatically. Vars: $NELM_LOG_WIDTH, $NELM_VERSION_LOG_WIDTH

  • --output-format (default: "yaml")

    Result output format. Vars: $NELM_OUTPUT_FORMAT, $NELM_VERSION_OUTPUT_FORMAT

  • --temp-dir (default: "")

    The directory for temporary files. By default, create a new directory in the default system directory for temporary files. Var: $NELM_TEMP_DIR

Feature Gates

Feature gates are experimental features that can be enabled via environment variables.

NELM_FEAT_PERIODIC_STACK_TRACES

Default: false

Print stack traces periodically to help with debugging deadlocks and other issues

NELM_FEAT_ADOPT_DECKHOUSE_CONTROLLER_FIELDS

Default: false

Adopt managed fields owned by the legacy "deckhouse-controller" field manager (the pre-nelm Helm 3 engine). Unsafe if any resource still has hook-owned "deckhouse-controller" entries