Cluster

eks.services.k8s.aws/v1alpha1

Metadata#

An object representing an Amazon EKS cluster.

Spec#

accessConfig: 
  authenticationMode: string
  bootstrapClusterCreatorAdminPermissions: boolean
bootstrapSelfManagedAddons: boolean
clientRequestToken: string
computeConfig: 
  enabled: boolean
  nodePools:
  - string
  nodeRoleARN: string
encryptionConfig:
  provider: 
    keyARN: string
    keyRef: 
      from: 
        name: string
        namespace: string
  resources:
  - string
kubernetesNetworkConfig: 
  elasticLoadBalancing: 
    enabled: boolean
  ipFamily: string
  serviceIPv4CIDR: string
logging: 
  clusterLogging:
  - enabled: boolean
    types:
    - string
name: string
outpostConfig: 
  controlPlaneInstanceType: string
  controlPlanePlacement: 
    groupName: string
  outpostARNs:
  - string
remoteNetworkConfig: 
  remoteNodeNetworks:
    cidrs:
    - string
  remotePodNetworks:
    cidrs:
    - string
resourcesVPCConfig: 
  endpointPrivateAccess: boolean
  endpointPublicAccess: boolean
  publicAccessCIDRs:
  - string
  securityGroupIDs:
  - string
  securityGroupRefs:
    from: 
      name: string
      namespace: string
  subnetIDs:
  - string
  subnetRefs:
    from: 
      name: string
      namespace: string
roleARN: string
roleRef: 
  from: 
    name: string
    namespace: string
storageConfig: 
  blockStorage: 
    enabled: boolean
tags: {}
upgradePolicy: 
  supportType: string
version: string
zonalShiftConfig: 
  enabled: boolean

These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).

It must satisfy the following requirements:

• Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /24, maximum allowed size is /8. Publicly-routable addresses aren’t supported.

• Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.

• Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.

• Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.

• Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.

• Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names. || remoteNetworkConfig.remoteNodeNetworks.[].cidrs
  Optional | array
  | | remoteNetworkConfig.remoteNodeNetworks.[].cidrs.[]
  Required | string
  || remoteNetworkConfig.remotePodNetworks
  Optional | array
  | | remoteNetworkConfig.remotePodNetworks.[]
  Required | object
  A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.

These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn’t available for on-premises and edge locations.

Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).

It must satisfy the following requirements:

• Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /24, maximum allowed size is /8. Publicly-routable addresses aren’t supported.

• Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. || remoteNetworkConfig.remotePodNetworks.[].cidrs
  Optional | array
  | | remoteNetworkConfig.remotePodNetworks.[].cidrs.[]
  Required | string
  || resourcesVPCConfig
  Required | object
  The VPC configuration that’s used by the cluster control plane. Amazon EKS
  VPC resources have specific requirements to work properly with Kubernetes.
  For more information, see Cluster VPC Considerations (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html)
  and Cluster Security Group Considerations (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html)
  in the Amazon EKS User Guide. You must specify at least two subnets. You
  can specify up to five security groups. However, we recommend that you use
  a dedicated security group for your cluster control plane. | | resourcesVPCConfig.endpointPrivateAccess
  Optional | boolean
  | | resourcesVPCConfig.endpointPublicAccess
  Optional | boolean
  | | resourcesVPCConfig.publicAccessCIDRs
  Optional | array
  | | resourcesVPCConfig.publicAccessCIDRs.[]
  Required | string
  || resourcesVPCConfig.securityGroupIDs
  Optional | array
  | | resourcesVPCConfig.securityGroupIDs.[]
  Required | string
  || resourcesVPCConfig.securityGroupRefs
  Optional | array
  Reference field for SecurityGroupIDs | | resourcesVPCConfig.securityGroupRefs.[]
  Required | object
  AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:

from:
  name: my-api || **resourcesVPCConfig.securityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| resourcesVPCConfig.securityGroupRefs.[].from.name
Optional | string
| | resourcesVPCConfig.securityGroupRefs.[].from.namespace
Optional | string
| | resourcesVPCConfig.subnetIDs
Optional | array
| | resourcesVPCConfig.subnetIDs.[]
Required | string
|| resourcesVPCConfig.subnetRefs
Optional | array
Reference field for SubnetIDs | | resourcesVPCConfig.subnetRefs.[]
Required | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:

from:
  name: my-api || **resourcesVPCConfig.subnetRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| resourcesVPCConfig.subnetRefs.[].from.name
Optional | string
| | resourcesVPCConfig.subnetRefs.[].from.namespace
Optional | string
| | roleARN
Optional | string
The Amazon Resource Name (ARN) of the IAM role that provides permissions
for the Kubernetes control plane to make calls to Amazon Web Services API
operations on your behalf. For more information, see Amazon EKS Service IAM
Role (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html)
in the Amazon EKS User Guide . | | roleRef
Optional | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api | | roleRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | roleRef.from.name
Optional | string
| | roleRef.from.namespace
Optional | string
| | storageConfig
Optional | object
Enable or disable the block storage capability of EKS Auto Mode when creating
your EKS Auto Mode cluster. If the block storage capability is enabled, EKS
Auto Mode will create and delete EBS volumes in your Amazon Web Services
account. | | storageConfig.blockStorage
Optional | object
Indicates the current configuration of the block storage capability on your
EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
If the block storage capability is enabled, EKS Auto Mode will create and
delete EBS volumes in your Amazon Web Services account. For more information,
see EKS Auto Mode block storage capability in the Amazon EKS User Guide. | | storageConfig.blockStorage.enabled
Optional | boolean
| | tags
Optional | object
Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don’t propagate to
any other cluster or Amazon Web Services resources. | | upgradePolicy
Optional | object
New clusters, by default, have extended support enabled. You can disable
extended support when creating a cluster by setting this value to STANDARD. | | upgradePolicy.supportType
Optional | string
| | version
Optional | string
The desired Kubernetes version for your cluster. If you don’t specify a value
here, the default version available in Amazon EKS is used.

The default version might not be the latest version available. | | zonalShiftConfig
Optional | object
Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled,
Amazon Web Services configures zonal autoshift for the cluster.

Zonal shift is a feature of Amazon Application Recovery Controller (ARC).
ARC zonal shift is designed to be a temporary measure that allows you to
move traffic for a resource away from an impaired AZ until the zonal shift
expires or you cancel it. You can extend the zonal shift if necessary.

You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon
Web Services to do it for you by enabling zonal autoshift. This shift updates
the flow of east-to-west network traffic in your cluster to only consider
network endpoints for Pods running on worker nodes in healthy AZs. Additionally,
any ALB or NLB handling ingress traffic for applications in your Amazon EKS
cluster will automatically route traffic to targets in the healthy AZs. For
more information about zonal shift in EKS, see Learn about Amazon Application
Recovery Controller (ARC) Zonal Shift in Amazon EKS (https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html)
in the Amazon EKS User Guide . | | zonalShiftConfig.enabled
Optional | boolean
|

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
certificateAuthority: 
  data: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
connectorConfig: 
  activationCode: string
  activationExpiry: string
  activationID: string
  provider: string
  roleARN: string
createdAt: string
endpoint: string
health: 
  issues:
  - code: string
    message: string
    resourceIDs:
    - string
id: string
identity: 
  oidc: 
    issuer: string
platformVersion: string
status: string