Last modified November 27, 2024
cluster-aws chart reference
The cluster-aws chart templates all the AWS infrastructure resources that are necessary to create a Cluster API cluster.
Chart Configuration Reference
AWS settings
Additional tags to add to AWS resources created by the cluster.
Name of an AWSClusterRoleIdentity object. Learn more at https://docs.giantswarm.io/getting-started/cloud-provider-accounts/cluster-api/aws/#configure-the-awsclusterroleidentity .
Apps
Configuration of apps that are part of the cluster.
Extra config maps or secrets that will be used to customize to the app. The desired values must be under configmap or secret key 'values'. The values are merged in the order given, with the later values overwriting earlier, and then inline values overwriting those. Resources must be in the same namespace as the cluster.
Specifies whether the resource is a config map or a secret.
Name of the config map or secret. The object must exist in the same namespace as the cluster App.
Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.
Values to be passed to the app. Values will have higher priority than values from configmaps.
Extra config maps or secrets that will be used to customize to the app. The desired values must be under configmap or secret key 'values'. The values are merged in the order given, with the later values overwriting earlier, and then inline values overwriting those. Resources must be in the same namespace as the cluster.
Specifies whether the resource is a config map or a secret.
Name of the config map or secret. The object must exist in the same namespace as the cluster App.
Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.
Values to be passed to the app. Values will have higher priority than values from configmaps.
Extra config maps or secrets that will be used to customize to the app. The desired values must be under configmap or secret key 'values'. The values are merged in the order given, with the later values overwriting earlier, and then inline values overwriting those. Resources must be in the same namespace as the cluster.
Name of the config map or secret. The object must exist in the same namespace as the cluster App.
Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.
Values to be passed to the app. Values will have higher priority than values from configmaps.
Extra config maps or secrets that will be used to customize to the app. The desired values must be under configmap or secret key 'values'. The values are merged in the order given, with the later values overwriting earlier, and then inline values overwriting those. Resources must be in the same namespace as the cluster.
Specifies whether the resource is a config map or a secret.
Name of the config map or secret. The object must exist in the same namespace as the cluster App.
Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.
Values to be passed to the app. Values will have higher priority than values from configmaps.
Extra config maps or secrets that will be used to customize to the app. The desired values must be under configmap or secret key 'values'. The values are merged in the order given, with the later values overwriting earlier, and then inline values overwriting those. Resources must be in the same namespace as the cluster.
Specifies whether the resource is a config map or a secret.
Name of the config map or secret. The object must exist in the same namespace as the cluster App.
Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.
Values to be passed to the app. Values will have higher priority than values from configmaps.
Components
Advanced configuration of components that are running on all nodes.
Endpoints and credentials configuration for container registries.
Base64-encoded string from the concatenation of the username, a colon, and the password.
Used to authenticate the user and obtain an access token for the registry.
Used to authenticate for the registry with username/password.
Used to authenticate for the registry with username/password.
Connectivity
Maximum number of availability zones (AZ) that should be used in a region. If a region has more than this number of AZs then this number of AZs will be picked randomly when creating subnets.
ID of the AWS account that created the resolver rules to be associated with the workload cluster VPC.
IPv4 address range for kubernetes services, in CIDR notation.
IPv4 address range to assign to this cluster's VPC, in CIDR notation.
ID of the VPC, where the cluster will be deployed. The VPC must exist and it case this is set, VPC wont be created by controllers.
To be passed to the HTTP_PROXY environment variable in all hosts.
To be passed to the HTTPS_PROXY environment variable in all hosts.
ID of an existing subnet. When set, this subnet will be used instead of creating a new one.
ID of the route table, assigned to the existing subnet. Must be provided when defining subnet via ID.
Networking architecture between management cluster and workload cluster.
ID of the managed prefix list to use when the topology mode is set to 'UserManaged'.
If the topology mode is set to 'UserManaged', this can be used to specify the transit gateway to use.
Whether the cluser's VPC is created with public, internet facing resources (public subnets, NAT gateway) or not (private).
Control plane
Additional security groups that will be added to the control plane nodes.
ID of the security group that will be added to the control plane nodes. The security group must exist.
Whether the Kubernetes API server load balancer should be reachable from the internet (public) or internal only (private).
The API server Load Balancer port. This option sets the Spec.ClusterNetwork.APIServerPort field on the Cluster CR. In CAPI this field isn't used currently. It is instead used in providers. In CAPA this sets only the public facing port of the Load Balancer. In CAPZ both the public facing and the destination port are set to this value. CAPV and CAPVCD do not use it.
IPv4 address ranges that are allowed to connect to the control plane load balancer, in CIDR notation. When setting this field, remember to add the Management cluster Nat Gateway IPs provided by Giant Swarm so that the cluster can still be managed. These Nat Gateway IPs can be found in the Management Cluster AWSCluster '.status.networkStatus.natGatewaysIPs' field.
Determines how long a machine health check should wait for a node to join the cluster, before considering a machine unhealthy.
If a node is not in condition 'Ready' after this timeout, it will be considered unhealthy.
If a node is in 'Unknown' condition after this timeout, it will be considered unhealthy.
Internal
For Giant Swarm internal use only, not stable, or not supported by UIs.
If specified, this token is used as a salt to the hash suffix of some resource names. Can be used to force-recreate some resources.
Additional fiels that will be provisioned to control-plane nodes, reference is from secret in the same namespace.
Additional Post-Kubeadm Commands executed on the control plane node.
Additional Pre-Kubeadm Commands executed on the control plane node.
Additional security groups that will be added to the machine pool nodes.
ID of the security group that will be added to the machine pool nodes. The security group must exist.
Ordered list of instance types to be used for the machine pool. The first instance type that is available in the region will be used. Read more in our docs https://docs.giantswarm.io/advanced/cluster-management/node-pools-capi/
Compared to on-demand instances, spot instances can help you save cost.
Tags to filter which AWS subnets will be used for this node pool.
Kubectl image
Metadata
Node pools
Node pools of the cluster. If not specified, this defaults to the value of `internal.nodePools`.
Additional security groups that will be added to the machine pool nodes.
ID of the security group that will be added to the machine pool nodes. The security group must exist.
Ordered list of instance types to be used for the machine pool. The first instance type that is available in the region will be used. Read more in our docs https://docs.giantswarm.io/advanced/cluster-management/node-pools-capi/
Compared to on-demand instances, spot instances can help you save cost.
Tags to filter which AWS subnets will be used for this node pool.
Other global
Pod Security Standards
Other
Further reading
Need help, got feedback?
We listen to your Slack support channel. You can also reach us at support@giantswarm.io. And of course, we welcome your pull requests!
