Skip to main content

install

Installs the application and the admin console directly to a cluster. The kots install command pulls Kubernetes manifests from the remote upstream, deploys the manifests to the specified cluster, installs the Replicated admin console, and sets up port forwarding to make the admin console accessible.

Usage

kubectl kots install [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-file flag must be provided.
  • Provide [flags] according to the table below

This command supports all global flags and also:

FlagTypeDescription
--airgapboolSet to true to run install in air gapped mode. Setting --airgap-bundle implies --airgap=true.
--airgap-bundlestringPath to the application air gap bundle where application metadata will be loaded from.
--app-version-labelstringThe application version label to install. If not specified, the latest version is installed.
--config-valuesstringPath to a manifest containing config values (must be apiVersion: kots.io/v1beta1, kind: ConfigValues).
--copy-proxy-envboolCopy proxy environment variables from current environment into all admin console components.
--disable-image-pushboolSet to true to disable images from being pushed to private registry.
--ensure-rbacboolWhen set, kots skips RBAC configuration at installation time. Default: false. If a role specification is needed, use the generate-manifests command.
-h, --helpHelp for install.
--http-proxystringSets HTTP_PROXY environment variable in all admin console components.
--https-proxystringSets HTTPS_PROXY environment variable in all admin console components.
--kotsadm-namespacestringSet to override the namespace of kotsadm images. Used for air gapped installations.
--kotsadm-registrystringSet to override the registry of kotsadm images. Used for air gapped installations.
--license-filestringPath to a license file (required when [upstream-uri] points to a replicated app).
--local-pathstringSpecify a local-path to test the behavior of rendering a replicated application locally (only supported on replicated app types currently).
--namestringName of the application to use in the admin console.
-n, --namespacestringThe namespace to deploy to.
--no-port-forwardboolSet to true to disable automatic port forward. Default: false
--no-proxystringSets NO_PROXY environment variable in all admin console components.
--preflights-wait-durationstringTimeout to be used while waiting for preflights to complete. Must be in Go duration format (eg: 10s, 2m). Default: 15m
--registry-passwordstringPassword to use to authenticate with the application registry. Used for air gapped installations.
--registry-usernamestringUsername to use to authenticate with the application registry. Used for air gapped installations.
--shared-passwordstringShared password to apply.
--skip-preflightsboolSet to true to skip preflight checks.
--strict-security-contextboolSet to explicitly enable strict security contexts for all kots pods and containers (may not work for some storage providers) Default: false
--use-minimal-rbacboolWhen set, kots uses namespace-scoped access if the application is configured to support namespace-scoped installations.
--wait-durationstringTimeout to be used while waiting for individual components to be ready. Must be in Go duration format (eg: 10s, 2m). Default: 2m
--with-minioboolWhen set, kots deploys a local minio instance for storage and use minio for hostpath and NFS snapshot storage. Default: true

Examples

kubectl kots install sentry/unstable --license-file ~/license.yaml
kubectl kots install kots-sentry/stable --shared-password IgqG5OBc9Gp --license-file ~/sentry-license.yaml --namespace sentry-namespace --config-values ~/config-values.yaml
kubectl kots install --ensure-rbac=false