Last modified November 27, 2024

cluster-eks chart reference

The cluster-eks chart templates all the AWS infrastructure resources that are necessary to create a Cluster API EKS cluster.

Additional resource tags
object 
Additional tags to add to AWS resources created by the cluster.
Tag value
string 
Amazon machine image (AMI)
string 
If specified, this image will be used to provision EC2 instances.
AWS account ID
string 
AWS Account ID of the AWSClusterRoleIdentity IAM role, recommendation is to leave this value empty as it will be automatically calculated. This value is needed for tests.
Cluster role identity name
string 
Name of an AWSClusterRoleIdentity object. This in turn refers to the IAM role used to create all AWS cloud resources when creating the cluster. The role can be in another AWS account in order to create all resources in that account. Note: This name does not refer directly to an IAM role name/ARN.
Region
string 
Availability zones
integer 
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.
Base DNS domain
string 
Network
object 
Pods
object 
Pod subnets
array 
Pod subnet
string 
IPv4 address range for pods, in CIDR notation. Must be within the 100.64.0.0/10 or 198.19.0.0/16 range. The CIDR block size must be betwen /16 and /28.
Services
object 
K8s Service subnets
array 
Service subnet
string 
IPv4 address range for kubernetes services, in CIDR notation.
VPC subnet
string 
IPv4 address range to assign to this cluster's VPC, in CIDR notation.
Pod Subnets
array 
Pod Subnets are created and tagged based on this definition.
Subnet
object 
Network
array 
object 
Availability zone
string 
Address range
string 
IPv4 address range, in CIDR notation.
Tags
object 
AWS resource tags to assign to this subnet.
Tag value
string 
Tags
object 
AWS resource tags to assign to this CIDR block.
Tag value
string 
Proxy
object 
Whether/how outgoing traffic is routed through proxy servers.
Enable
boolean 
HTTP proxy
string 
To be passed to the HTTP_PROXY environment variable in all hosts.
HTTPS proxy
string 
To be passed to the HTTPS_PROXY environment variable in all hosts.
No proxy
string 
To be passed to the NO_PROXY environment variable in all hosts.
Subnets
array 
Subnets are created and tagged based on this definition.
Subnet
object 
Network
array 
object 
Availability zone
string 
Address range
string 
IPv4 address range, in CIDR notation.
Tags
object 
AWS resource tags to assign to this subnet.
Tag value
string 
Public
boolean 
Tags
object 
AWS resource tags to assign to this CIDR block.
Tag value
string 
API mode
string 
Whether the Kubernetes API server load balancer should be reachable from the internet (public) or internal only (private).
Logging
object 
Api Server
boolean 
Enable or disable Api server logging to CloudWatch (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html).
Audit
boolean 
Enable or disable audit logging to CloudWatch (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html).
Authenticator
boolean 
Enable or disable IAM Authenticator logging to CloudWatch (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html).
Controller Manager
boolean 
Enable or disable Controller Manager logging to CloudWatch (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html).
OIDC identity provider config
object 
OIDC identity provider configuration for the Kubernetes API server.
Client ID
string 
Client ID of the OIDC identity provider.
Groups claim
string 
Claim to use for mapping groups.
Groups prefix
string 
Prefix to use for mapping groups.
Identity provider config name
string 
Name of the OIDC identity provider config.
Issuer URL
string 
URL of the OIDC identity provider.
Required claims
object 
Required claims for the OIDC identity provider.
Claim
string 
Tags
object 
AWS resource tags to assign to the IAM OIDC provider.
Tag value
string 
Username claim
string 
Claim to use for mapping usernames.
Username prefix
string 
Prefix to use for mapping usernames.
Role mappings
array 
Role mapping
object 
Maps AWS IAM role to Kubernetes role.
Groups
array 
Kubernetes groups.
Group
string 
Kubernetes group, for example `system:masters`.
AWS Role ARN
string 
Full ARN of the AWS IAM role.
Kubernetes username
string 
Kubernetes username, for example `cluster-admin`.
Hash salt
string 
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.
Kubernetes version
string 
Default node pool
object 
Node pool
object 
Availability zones
array 
Availability zone
string 
Custom node labels
array 
Label
string 
Custom node taints
array 
object 
Effect
string 
Key
string 
Value
string 
EC2 instance type
string 
Maximum number of nodes
integer 
Minimum number of nodes
integer 
Root volume size (GB)
integer 
Subnet tags
array 
Tags to filter which AWS subnets will be used for this node pool.
Subnet tag
object 
Tag value
string 
Kubectl image
object 
Repository
string 
Registry
string 
Tag
string 
Repository
string 
Registry
string 
Tag
string 
Cluster description
string 
User-friendly description of the cluster's purpose.
Cluster name
string 
Unique identifier, cannot be changed after creation.
Organization
string 
Prevent cluster deletion
boolean 
Service priority
string 
The relative importance of this cluster.
Node pool
object 
Availability zones
array 
Availability zone
string 
Custom node labels
array 
Label
string 
Custom node taints
array 
object 
Effect
string 
Key
string 
Value
string 
EC2 instance type
string 
Maximum number of nodes
integer 
Minimum number of nodes
integer 
Root volume size (GB)
integer 
Subnet tags
array 
Tags to filter which AWS subnets will be used for this node pool.
Subnet tag
object 
Tag value
string 
Management cluster
string 
Name of the Cluster API cluster managing this workload cluster.
Base DNS domain
string 
Library chart
object 
Management cluster
string 
Name of the Cluster API cluster managing this workload cluster.
Cluster API provider name
string 

Further reading

This part of our documentation refers to our vintage product. The content may be not valid anymore for our current product. Please check our new documentation hub for the latest state of our docs.