kots pull
Running this command will create a directory on the workstation containing the KOTS application and Kubernetes manifests. These assets can be used to deploy KOTS to a cluster through other workflows, such as kubectl. This command is necessary when managing a KOTS application without the use of the Admin Console.
Usage
kubectl kots pull [upstream uri] [flags]
- Replace
[upstream-uri]with the URI for your KOTS application (required). - If the KOTS application has been packaged by Replicated Vendor, the
--license-fileflag must be provided. - Provide
[flags]according to the table below
This command supports all global flags and also:
| Flag | Type | Description |
|---|---|---|
--downstream |
strings | the list of any downstreams to create/update |
--exclude-admin-console |
bool | set to true to exclude the admin console (only valid when [upstream-uri] points to a replicated app) |
--exclude-kots-kinds |
bool | set to true to exclude rendering KOTS custom objects to the base directory (default true) |
-h, --help |
help for pull | |
--helm-version |
string | the Helm version with which to render the Helm Chart (default "v2"). This is a beta feature |
--image-namespace |
string | the namespace/org in the docker registry to push images to (required when --rewrite-images is set) |
--license-file |
string | path to a license file (required when [upstream-uri] points to a replicated app) |
--local-path |
string | specify a local-path to pull a locally available replicated app (only valid when [upstream-uri] points to a replicated app) |
-n, --namespace |
string | namespace to render the upstream to in the base (default "default") |
--registry-endpoint |
string | the endpoint of the local docker registry to use when pushing images (required when --rewrite-images is set) |
--repo |
string | repo uri to use when downloading a helm chart |
--rewrite-images |
bool | set to true to force all container images to be rewritten and pushed to a local registry |
--rootdir |
string | root directory that will be used to write the yaml to (default ${HOME} or %USERPROFILE%) |
--set |
strings | values to pass to helm when running helm template |
--shared-password |
string | shared password to use when deploying the admin console |
--http-proxy |
string | sets HTTP_PROXY environment variable in all KOTS Admin Console components |
--https-proxy |
string | sets HTTPS_PROXY environment variable in all KOTS Admin Console components |
--no-proxy |
string | sets NO_PROXY environment variable in all KOTS Admin Console components |
--copy-proxy-env |
bool | copy proxy environment variables from current environment into all KOTS Admin Console components |
--config-values |
string | path to a manifest containing config values (must be apiVersion: kots.io/v1beta1, kind: ConfigValues) |
--with-minio |
bool | set to true to include a local minio instance to be used for storage (default true) |
Examples
kubectl kots pull sentry/unstable --license-file ~/license.yaml
kubectl kots pull helm://elastic/elasticsearch --helm-version v3