admin-console generate-manifests
Running this command will create a directory on the workstation containing the Replicated Admin Console manifests. These assets can be used to deploy KOTS to a cluster through other workflows, such as kubectl, to provide additional customization of the Admin Console before deploying.
Limitations
-
generate-manifests
does not support generating manifests for Red Hat OpenShift clusters or GKE Autopilot clusters if executed without a Kubernetes cluster context. -
To upgrade a KOTS instance that has ever been on version 1.72.0 or earlier, you must run
generate-manifests
with a Kubernetes cluster context. -
The
admin-console generate-manifests
command does not accept the--strict-security-context
flag, which deploys KOTS Pods with a security context. To generate Admin Console manifests with a security context, add the following to the Pod templates for Deployments and StatefulSets deployed by KOTS:securityContext:
fsGroup: 1001
runAsGroup: 1001
runAsNonRoot: true
runAsUser: 1001
seccompProfile:
type: RuntimeDefault
supplementalGroups:
- 1001
Usage
kubectl kots admin-console generate-manifests [flags]
This command supports the following flags:
Flag | Type | Description |
--rootdir | string | Root directory where the YAML will be written (default ${HOME} or %USERPROFILE% ) |
--namespace | string | Target namespace for the Admin Console |
--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 |
--http-proxy | string | Sets HTTP_PROXY environment variable in all KOTS Admin Console |
--kotsadm-namespace | string | Set to override the registry namespace of KOTS Admin Console images. Used for air gap installations. For more information, see Air Gap Installation in Existing Clusters with KOTS. Note: Replicated recommends that you use |
--kotsadm-registry | string | Set to override the registry hostname and namespace of KOTS Admin Console images. Used for air gap installations. For more information, see Air Gap Installation in Existing Clusters with KOTS. |
--no-proxy | string | Sets NO_PROXY environment variable in all KOTS Admin Console components |
--private-ca-configmap | string | Name of a ConfigMap containing private CAs to add to the kotsadm deployment |
--registry-password | string | Password to use to authenticate with the application registry. Used for air gap installations. |
--registry-username | string | Username to use to authenticate with the application registry. Used for air gap installations. |
--with-minio | bool | Set to true to include a local minio instance to be used for storage (default true) |
--minimal-rbac | bool | Set to true to include a local minio instance to be used for storage (default true) |
--additional-namespaces | string | Comma delimited list to specify additional namespace(s) managed by KOTS outside where it is to be deployed. Ignored without with --minimal-rbac=true |
--storage-class | string | Sets the storage class to use for the KOTS Admin Console components. Default: unset, which means the default storage class will be used |
Examples
kubectl kots admin-console generate-manifests
kubectl kots admin-console generate-manifests --rootdir ./manifests
kubectl kots admin-console generate-manifests --namespace kotsadm --minimal-rbac=true --additional-namespaces="app1,app3"