cluster prepare

Create a cluster and a release, then install the release in the cluster. This allows you to deploy applications to a cluster for compatibility testing without needing to promote a release to a channel or create a temporary customer. For more information, see About Compatibility Matrix.

note

cluster prepare is not recommended for production testing. For production testing, use cluster create instead.

Usage

replicated cluster prepare [flags]

Flag	Type (if applicable)	Description
-h, --help		Help for the command.
--disk	integer	The disk size (GiB) to request per node. Default: 50
--distribution	string	The Kubernetes cluster distribution type to provision. Default: kind
--instance-type	string	The type of instance to use for nodes in the cluster. See Supported Compatibility Matrix Cluster Types (Beta).
--name	string	The name of the cluster. If no name is specified, a name will be generated.
--nodes	integer	The node count. Default: 1
--ttl	string	The cluster Time to Live (TTL) duration, in hours, before the cluster is automatically deleted by the service. TTL starts when the cluster is in a Ready state. Valid values: 1 - 48. Default: 1
--version	string	(Required) The Kubernetes version to provision. For OpenShift clusters, provide the supported OpenShift version. The format is distribution dependent. For supported versions, see Supported Compatibility Matrix Cluster Types (Beta).
--wait	duration	The wait duration for the cluster to be ready. Default: 5 minutes
--cluster-id	string	The ID of an existing cluster to use instead of creating a new ID.
--entitlements	string	The entitlements to set on the customer. You can specify multiple entitlements.
--namespace	string	The namespace in which to deploy the KOTS or Helm chart application. Default: default
--app-ready-timeout	string	Timeout to wait for the application to be ready. Requires the Go duration format (e.g., 10s, 2m). Default: 5 minutes
--chart	string	The path to the Helm chart for a release.
--values	string	Specify values in a YAML file or a URL. You can specify multiple values.
--set	string	Set values using the command line. Specify multiple or separate values with commas: key1=val1,key2=val2.
--set-string	string	Set String values using the command line. Specify multiple or separate values with commas: key1=val1,key2=val2.
--set-file	string	Set values from respective files specified using the command line. Specify multiple or separate values with commas: key1=path1,key2=path2.
--set-json	string	Set JSON values using the command line. Specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2.
--set-literal	string	Set a literal String value using the command line.
--yaml	string	The YAML config for this release. Use - to read from stdin. Cannot be used with the --yaml-file flag.
--yaml-file	string	The YAML config for this release. Cannot be used with the --yaml flag.
--yaml-dir	string	The directory containing multiple YAML files for a KOTS release. Cannot be used with the --yaml flag.
--config-values-file	string	Path to a manifest containing config values. Must use apiVersion: kots.io/v1beta1, kind: ConfigValues.
--shared-password	string	Shared password for the KOTS admin console.

Examples

• For a Helm application with a kind distribution:

  replicated cluster cluster prepare \
  --distribution kind \
  --version 1.27.0 \
  --chart nginx-chart-0.0.14.tgz \
  --set key1=val1,key2=val2 \
  --set-string s1=val1,s2=val2 \
  --set-json j1='{"key1":"val1","key2":"val2"}' \
  --set-literal l1=val1,l2=val2 \
  --values values.yaml

• For a KOTS-based application with a k3s distribution:

  replicated cluster prepare \
  --distribution k3s \
  --version 1.26 \
  --namespace config-validation \
  --shared-password password \
  --app-ready-timeout 10m \
  --yaml-dir config-validation \
  --config-values-file config-values.yaml \
  --entitlements "num_of_queues=5"