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 on port 8800. Alternatively, you can specify the --port flag to override the default port.

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. Default: false. For more information, see Installing in an Air Gapped Environment.
--airgap-bundlestringPath to the application air gap bundle where application metadata will be loaded from. Setting --airgap-bundle implies --airgap=true. For more information, see Installing in an Air Gapped Environment.
--app-version-labelstringThe application version label to install. If not specified, the latest version is installed.
--config-valuesstringPath to a manifest file containing configuration values. This manifest must be apiVersion: kots.io/v1beta1 and kind: ConfigValues. For more information, see Define Application Configuration Values.
--copy-proxy-envboolCopy proxy environment variables from current environment into all admin console components. Default: false
--disable-image-pushboolSet to true to disable images from being pushed to private registry. Default: false
--ensure-rbacboolWhen set to true, KOTS configures RBAC at installation time. Default: true. 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. For more information, see Installing in an Air Gapped Environment.
--kotsadm-registrystringSet to override the registry of kotsadm images. Used for air gapped installations. For more information, see Installing in an Air Gapped Environment.
--license-filestringPath to a license file. Required when --upstream-uri points to a Replicated application.
--local-pathstringSpecify a local-path to test the behavior of rendering a Replicated application locally. Only supported on Replicated application types.
--namestringName of the application to use in the admin console.
--no-port-forwardboolSet to true to disable automatic port forward. Default: false
--no-proxystringSets NO_PROXY environment variable in all admin console components.
--portstringOverride the local port to access the admin console. Default: 8800
--preflights-wait-durationstringTimeout to be used while waiting for preflights to complete. Must be in Go duration format. For example, 10s, 2m. Default: 15m
--registry-passwordstringPassword to use to authenticate with the application registry. Used for air gapped installations. For more information, see Installing in an Air Gapped Environment.
--registry-usernamestringUsername to use to authenticate with the application registry. Used for air gapped installations. For more information, see Installing in an Air Gapped Environment.
--repostringRepo URI to use when installing a Helm chart.
--setstringsValues to pass to Helm when running helm template.
--shared-passwordstringShared password to use when deploying the admin console.
--skip-compatibility-checkboolSet to true to skip compatibility checks between the current KOTS version and the application. Default: false
--skip-preflightsboolSet to true to skip preflight checks. Default: false. If any strict preflight checks are configured, the --skip-preflights flag is not honored because strict preflight checks must run and contain no failures before the application is deployed. For more information, see About Preflight Checks and Support Bundles.
--skip-rbac-checkboolSet to true to bypass RBAC check. Default: false
--strict-security-contextboolSet to true to explicitly enable explicit security contexts for all KOTS pods and containers. Default: false. Note: Might not work for some storage providers.
--use-minimal-rbacboolWhen set to true, KOTS is namespace-scoped if the application supports namespace scoped installations. Default: false
--wait-durationstringTimeout to be used while waiting for individual components to be ready. Must be in Go duration format. For example, 10s, 2m. Default: 2m
--with-minioboolWhen set to true, KOTS deploys a local MinIO instance for storage and uses MinIO for host path 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