Skip to main content
Skip table of contents

nkp create cluster aws

Create a Konvoy cluster in AWS

CODE
nkp create cluster aws [flags]

Options

CODE
      --additional-security-group-ids strings           A comma separated list of existing security group IDs to use for machines in addition to those created automatically (default [])
      --additional-tags stringToString                  Tags to apply to the provisioned infrastructure (default [])
      --allow-missing-template-keys                     If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
      --ami string                                      AMI ID to use for machines
      --ami-base-os string                              Base OS used in search of AMIs. Examples: 'ubuntu-22.04'
      --ami-format string                               Query string used in search of AMIs. Example: When --ami-base-os='rhel8.10', then the string 'prefix-{{.BaseOS}}-?{{.K8sVersion}}-*' matches any AMIs with the Name 'prefix-rhel8.10-1.33.5
      --ami-owner string                                ID of AWS account used in search of AMIs
      --aws-service-endpoints string                    Custom AWS service endpoints in a semi-colon separated format: ${SigningRegion1}:${ServiceID1}=${URL},${ServiceID2}=${URL};${SigningRegion2}...
      --bootstrap-cluster-image string                  Container image used to create the bootstrap cluster. Can be an image name or path to a filee.g. ./nkp-v2.16.1-rc.3/konvoy-bootstrap-image-v2.16.1-rc.3.tar. If not provided, the default image will be used (default "docker.io/mesosphere/konvoy-bootstrap:v2.16.1-rc.3")
  -c, --cluster-name name                               Name used to prefix the cluster and all the created resources.
      --control-plane-http-proxy string                 HTTP proxy for control plane machines
      --control-plane-https-proxy string                HTTPS proxy for control plane machines
      --control-plane-iam-instance-profile string       Name of the IAM instance profile to assign to control plane machines. (default "control-plane.cluster-api-provider-aws.sigs.k8s.io")
      --control-plane-instance-type string              Control Plane machine instance type (default "m5.xlarge")
      --control-plane-no-proxy strings                  No Proxy list for control plane machines (default [])
      --control-plane-renew-certificates-before int32   Enables automated control-plane certificates renewal. Provide the number of days between 7 and 360 when to trigger the certificate renewal. The renewal process will trigger new control-plane Machines to be created. A value of 0 disables the feature. (default 180)
      --control-plane-replicas int32                    Number of control plane nodes (default 3)
      --dry-run                                         Only print the objects that would be created, without creating them.
      --etcd-image-repository string                    The image repository to use for pulling the etcd image
      --etcd-version string                             The version of etcd to use.
      --extra-sans strings                              A comma separated list of additional Subject Alternative Names for the API Server signing cert (default [])
  -h, --help                                            help for aws
      --http-proxy string                               HTTP proxy for CAPI controllers
      --https-proxy string                              HTTPS proxy for CAPI controllers
      --internal-load-balancer                          Make the control plane load balancer internal, i.e., reachable only within the VPC.
      --kubeconfig string                               Path to the kubeconfig for the management cluster. If unspecified, default discovery rules apply. This flag is ignored if used with the --self-managed flag.
      --kubernetes-image-repository string              The image repository to use for pulling kubernetes images
      --kubernetes-pod-network-cidr cidr                The Kubernetes Pod network CIDR to use in the cluster (default 192.168.0.0/16)
      --kubernetes-service-cidr cidr                    The Kubernetes Service CIDR to use in the cluster (default 10.96.0.0/12)
      --kubernetes-version string                       Kubernetes version (default "1.33.5")
  -n, --namespace string                                If present, the namespace scope for this CLI request. (default "default")
      --no-proxy strings                                No Proxy list for CAPI controllers (default [])
      --os-hint flatcar                                 A hint which will allow the installer to generate appropriate configurations for a target OS. Presently, only the hint for flatcar is supported.
  -o, --output string                                   Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
      --output-directory string                         Used with --output=json|yaml. The directory where to output resources to files. The directory must already exist.
      --region string                                   AWS region to deploy cluster to (default "us-west-2")
      --registry-mirror-cacert file                     Path to file containing the CA certificate used to verify the registry mirror server certificate
      --registry-mirror-password string                 Password used to authenticate with the registry mirror
      --registry-mirror-url url                         URL of a container registry used as a mirror (required for air-gapped installations)
      --registry-mirror-username string                 Username used to authenticate with the registry mirror
      --self-managed                                    When set to true, the required prerequisites are created before creating the cluster and the resulting cluster has all necessary components deployed onto itself, so it can manage its own cluster lifecycle. When set to false, a management cluster is used. (default false)
      --show-managed-fields                             If true, keep the managedFields when printing objects in JSON or YAML format.
      --ssh-public-key-file string                      Path to the authorized SSH key for the user
      --ssh-username string                             Name of the user to create on the instance (default "konvoy")
      --subnet-ids strings                              A comma separated list of existing subnet IDs to use for the kube-apiserver ELB and all control-plane and worker nodes (default [])
      --template string                                 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
      --timeout duration                                The length of time to wait before giving up. Zero means wait forever (e.g. 300s, 30m, 3h). (default 30m0s)
      --vpc-id string                                   Existing VPC ID to use for the cluster
      --wait                                            If true, wait for operations to complete before returning. This flag is ignored and will always be 'true' if used with the --self-managed flag. (default true)
      --with-aws-bootstrap-credentials                  Set true to use AWS bootstrap credentials from your environment. When false, the instance profile of the EC2 instance where the CAPA controller is scheduled on will be used instead.
      --with-gcp-bootstrap-credentials                  Set true to use GCP bootstrap credentials from your environment. When false, the service account of the VM instance where the CAPG controller is scheduled on will be used instead.
      --worker-availability-zone string                 The AvailabilityZone in the region to deploy the worker nodes to, if not set a random one will be selected (ex. us-west-2a)
      --worker-http-proxy string                        HTTP proxy for nodes
      --worker-https-proxy string                       HTTPS proxy for nodes
      --worker-iam-instance-profile string              Name of the IAM instance profile to assign to worker machines. (default "nodes.cluster-api-provider-aws.sigs.k8s.io")
      --worker-instance-type string                     Worker machine instance type (default "m5.2xlarge")
      --worker-no-proxy strings                         No Proxy list for nodes (default [])
      --worker-replicas int32                           Number of workers (default 4)

Options inherited from parent commands

CODE
  -v, --verbose int   Output verbosity

SEE ALSO

  • nkp create cluster - Create a Kubernetes cluster, one of [aks, aws, azure, eks, gcp, nutanix, preprovisioned, vsphere]
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.