Packages:

controlplane.cluster.x-k8s.io/v1alpha4

Package v1alpha4 contains API Schema definitions for the controlplane v1alpha4 API group

Resource Types:

    AWSManagedControlPlane

    AWSManagedControlPlane is the Schema for the awsmanagedcontrolplanes API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    AWSManagedControlPlaneSpec


    eksClusterName
    string
    (Optional)

    EKSClusterName allows you to specify the name of the EKS cluster in AWS. If you don’t specify a name then a default name will be created based on the namespace and name of the managed control plane.

    identityRef
    Cluster API AWS api/v1alpha4.AWSIdentityReference
    (Optional)

    IdentityRef is a reference to a identity to be used when reconciling the managed control plane.

    network
    Cluster API AWS api/v1alpha4.NetworkSpec

    NetworkSpec encapsulates all things related to AWS network.

    secondaryCidrBlock
    string
    (Optional)

    SecondaryCidrBlock is the additional CIDR range to use for pod IPs. Must be within the 100.64.0.0/10 or 198.19.0.0/16 range.

    region
    string

    The AWS Region the cluster lives in.

    sshKeyName
    string
    (Optional)

    SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

    version
    string
    (Optional)

    Version defines the desired Kubernetes version. If no version number is supplied then the latest version of Kubernetes that EKS supports will be used.

    roleName
    string
    (Optional)

    RoleName specifies the name of IAM role that gives EKS permission to make API calls. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

    roleAdditionalPolicies
    []string
    (Optional)

    RoleAdditionalPolicies allows you to attach additional polices to the control plane role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

    logging
    ControlPlaneLoggingSpec
    (Optional)

    Logging specifies which EKS Cluster logs should be enabled. Entries for each of the enabled logs will be sent to CloudWatch

    encryptionConfig
    EncryptionConfig
    (Optional)

    EncryptionConfig specifies the encryption configuration for the cluster

    additionalTags
    Cluster API AWS api/v1alpha4.Tags
    (Optional)

    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

    iamAuthenticatorConfig
    IAMAuthenticatorConfig
    (Optional)

    IAMAuthenticatorConfig allows the specification of any additional user or role mappings for use when generating the aws-iam-authenticator configuration. If this is nil the default configuration is still generated for the cluster.

    endpointAccess
    EndpointAccess
    (Optional)

    Endpoints specifies access to this cluster’s control plane endpoints

    controlPlaneEndpoint
    Cluster API api/v1alpha4.APIEndpoint
    (Optional)

    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

    imageLookupFormat
    string
    (Optional)

    ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

    imageLookupOrg
    string
    (Optional)

    ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

    imageLookupBaseOS
    string

    ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

    bastion
    Cluster API AWS api/v1alpha4.Bastion
    (Optional)

    Bastion contains options to configure the bastion host.

    tokenMethod
    EKSTokenMethod

    TokenMethod is used to specify the method for obtaining a client token for communicating with EKS iam-authenticator - obtains a client token using iam-authentictor aws-cli - obtains a client token using the AWS CLI Defaults to iam-authenticator

    associateOIDCProvider
    bool

    AssociateOIDCProvider can be enabled to automatically create an identity provider for the controller for use with IAM roles for service accounts

    addons
    []../../controlplane/eks/api/v1alpha4.Addon
    (Optional)

    Addons defines the EKS addons to enable with the EKS cluster.

    disableVPCCNI
    bool

    DisableVPCCNI indcates the the Amazon VPC CNI should be disabled. With EKS clusters that the Amazon VPC CNI is automatically installed into the cluster. For clusters where you want to use an alternate CNI this option provides a way to specify that the Amazon VPC CNI should be deleted. You cannot set this to true if you are using the Amazon VPC CNI addon or if you have specified a secondary CIDR block.

    status
    AWSManagedControlPlaneStatus

    AWSManagedControlPlaneSpec

    (Appears on:AWSManagedControlPlane)

    AWSManagedControlPlaneSpec defines the desired state of AWSManagedControlPlane

    Field Description
    eksClusterName
    string
    (Optional)

    EKSClusterName allows you to specify the name of the EKS cluster in AWS. If you don’t specify a name then a default name will be created based on the namespace and name of the managed control plane.

    identityRef
    Cluster API AWS api/v1alpha4.AWSIdentityReference
    (Optional)

    IdentityRef is a reference to a identity to be used when reconciling the managed control plane.

    network
    Cluster API AWS api/v1alpha4.NetworkSpec

    NetworkSpec encapsulates all things related to AWS network.

    secondaryCidrBlock
    string
    (Optional)

    SecondaryCidrBlock is the additional CIDR range to use for pod IPs. Must be within the 100.64.0.0/10 or 198.19.0.0/16 range.

    region
    string

    The AWS Region the cluster lives in.

    sshKeyName
    string
    (Optional)

    SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

    version
    string
    (Optional)

    Version defines the desired Kubernetes version. If no version number is supplied then the latest version of Kubernetes that EKS supports will be used.

    roleName
    string
    (Optional)

    RoleName specifies the name of IAM role that gives EKS permission to make API calls. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

    roleAdditionalPolicies
    []string
    (Optional)

    RoleAdditionalPolicies allows you to attach additional polices to the control plane role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

    logging
    ControlPlaneLoggingSpec
    (Optional)

    Logging specifies which EKS Cluster logs should be enabled. Entries for each of the enabled logs will be sent to CloudWatch

    encryptionConfig
    EncryptionConfig
    (Optional)

    EncryptionConfig specifies the encryption configuration for the cluster

    additionalTags
    Cluster API AWS api/v1alpha4.Tags
    (Optional)

    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

    iamAuthenticatorConfig
    IAMAuthenticatorConfig
    (Optional)

    IAMAuthenticatorConfig allows the specification of any additional user or role mappings for use when generating the aws-iam-authenticator configuration. If this is nil the default configuration is still generated for the cluster.

    endpointAccess
    EndpointAccess
    (Optional)

    Endpoints specifies access to this cluster’s control plane endpoints

    controlPlaneEndpoint
    Cluster API api/v1alpha4.APIEndpoint
    (Optional)

    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

    imageLookupFormat
    string
    (Optional)

    ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

    imageLookupOrg
    string
    (Optional)

    ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

    imageLookupBaseOS
    string

    ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

    bastion
    Cluster API AWS api/v1alpha4.Bastion
    (Optional)

    Bastion contains options to configure the bastion host.

    tokenMethod
    EKSTokenMethod

    TokenMethod is used to specify the method for obtaining a client token for communicating with EKS iam-authenticator - obtains a client token using iam-authentictor aws-cli - obtains a client token using the AWS CLI Defaults to iam-authenticator

    associateOIDCProvider
    bool

    AssociateOIDCProvider can be enabled to automatically create an identity provider for the controller for use with IAM roles for service accounts

    addons
    []../../controlplane/eks/api/v1alpha4.Addon
    (Optional)

    Addons defines the EKS addons to enable with the EKS cluster.

    disableVPCCNI
    bool

    DisableVPCCNI indcates the the Amazon VPC CNI should be disabled. With EKS clusters that the Amazon VPC CNI is automatically installed into the cluster. For clusters where you want to use an alternate CNI this option provides a way to specify that the Amazon VPC CNI should be deleted. You cannot set this to true if you are using the Amazon VPC CNI addon or if you have specified a secondary CIDR block.

    AWSManagedControlPlaneStatus

    (Appears on:AWSManagedControlPlane)

    AWSManagedControlPlaneStatus defines the observed state of AWSManagedControlPlane

    Field Description
    networkStatus
    Cluster API AWS api/v1alpha4.NetworkStatus
    (Optional)

    Networks holds details about the AWS networking resources used by the control plane

    failureDomains
    Cluster API api/v1alpha4.FailureDomains
    (Optional)

    FailureDomains specifies a list fo available availability zones that can be used

    bastion
    Cluster API AWS api/v1alpha4.Instance
    (Optional)

    Bastion holds details of the instance that is used as a bastion jump box

    oidcProvider
    OIDCProviderStatus
    (Optional)

    OIDCProvider holds the status of the identity provider for this cluster

    externalManagedControlPlane
    bool

    ExternalManagedControlPlane indicates to cluster-api that the control plane is managed by an external service such as AKS, EKS, GKE, etc.

    initialized
    bool
    (Optional)

    Initialized denotes whether or not the control plane has the uploaded kubernetes config-map.

    ready
    bool

    Ready denotes that the AWSManagedControlPlane API Server is ready to receive requests and that the VPC infra is ready.

    failureMessage
    string
    (Optional)

    ErrorMessage indicates that there is a terminal problem reconciling the state, and will be set to a descriptive error message.

    conditions
    Cluster API api/v1alpha4.Conditions

    Conditions specifies the cpnditions for the managed control plane

    addons
    []AddonState
    (Optional)

    Addons holds the current status of the EKS addons

    Addon

    Addon represents a EKS addon

    Field Description
    name
    string

    Name is the name of the addon

    version
    string

    Version is the version of the addon to use

    conflictResolution
    AddonResolution

    ConflictResolution is used to declare what should happen if there are parameter conflicts. Defaults to none

    serviceAccountRoleARN
    string
    (Optional)

    ServiceAccountRoleArn is the ARN of an IAM role to bind to the addons service account

    AddonIssue

    (Appears on:AddonState)

    AddonIssue represents an issue with an addon

    Field Description
    code
    string

    Code is the issue code

    message
    string

    Message is the textual description of the issue

    resourceIds
    []string

    ResourceIDs is a list of resource ids for the issue

    AddonResolution (string alias)

    (Appears on:Addon)

    AddonResolution defines the method for resolving parameter conflicts.

    AddonState

    (Appears on:AWSManagedControlPlaneStatus)

    AddonState represents the state of an addon

    Field Description
    name
    string

    Name is the name of the addon

    version
    string

    Version is the version of the addon to use

    arn
    string

    ARN is the AWS ARN of the addon

    serviceAccountRoleARN
    string

    ServiceAccountRoleArn is the ARN of the IAM role used for the service account

    createdAt
    Kubernetes meta/v1.Time

    CreatedAt is the date and time the addon was created at

    modifiedAt
    Kubernetes meta/v1.Time

    ModifiedAt is the date and time the addon was last modified

    status
    string

    Status is the status of the addon

    issues
    []AddonIssue

    Issues is a list of issue associated with the addon

    AddonStatus (string alias)

    AddonStatus defines the status for an addon.

    ControlPlaneLoggingSpec

    (Appears on:AWSManagedControlPlaneSpec)

    ControlPlaneLoggingSpec defines what EKS control plane logs that should be enabled.

    Field Description
    apiServer
    bool

    APIServer indicates if the Kubernetes API Server log (kube-apiserver) shoulkd be enabled

    audit
    bool

    Audit indicates if the Kubernetes API audit log should be enabled

    authenticator
    bool

    Authenticator indicates if the iam authenticator log should be enabled

    controllerManager
    bool

    ControllerManager indicates if the controller manager (kube-controller-manager) log should be enabled

    scheduler
    bool

    Scheduler indicates if the Kubernetes scheduler (kube-scheduler) log should be enabled

    EKSTokenMethod (string alias)

    (Appears on:AWSManagedControlPlaneSpec)

    EKSTokenMethod defines the method for obtaining a client token to use when connecting to EKS.

    EncryptionConfig

    (Appears on:AWSManagedControlPlaneSpec)

    EncryptionConfig specifies the encryption configuration for the EKS clsuter.

    Field Description
    provider
    string

    Provider specifies the ARN or alias of the CMK (in AWS KMS)

    resources
    []*string

    Resources specifies the resources to be encrypted

    EndpointAccess

    (Appears on:AWSManagedControlPlaneSpec)

    EndpointAccess specifies how control plane endpoints are accessible.

    Field Description
    public
    bool
    (Optional)

    Public controls whether control plane endpoints are publicly accessible

    publicCIDRs
    []*string
    (Optional)

    PublicCIDRs specifies which blocks can access the public endpoint

    private
    bool
    (Optional)

    Private points VPC-internal control plane access to the private endpoint

    IAMAuthenticatorConfig

    (Appears on:AWSManagedControlPlaneSpec)

    IAMAuthenticatorConfig represents an aws-iam-authenticator configuration.

    Field Description
    mapRoles
    []RoleMapping
    (Optional)

    RoleMappings is a list of role mappings

    mapUsers
    []UserMapping
    (Optional)

    UserMappings is a list of user mappings

    KubernetesMapping

    (Appears on:RoleMapping, UserMapping)

    KubernetesMapping represents the kubernetes RBAC mapping.

    Field Description
    username
    string

    UserName is a kubernetes RBAC user subject

    groups
    []string

    Groups is a list of kubernetes RBAC groups

    OIDCProviderStatus

    (Appears on:AWSManagedControlPlaneStatus)

    OIDCProviderStatus holds the status of the AWS OIDC identity provider.

    Field Description
    arn
    string

    ARN holds the ARN of the provider

    trustPolicy
    string

    TrustPolicy contains the boilerplate IAM trust policy to use for IRSA

    RoleMapping

    (Appears on:IAMAuthenticatorConfig)

    RoleMapping represents a mapping from a IAM role to Kubernetes users and groups

    Field Description
    rolearn
    string

    RoleARN is the AWS ARN for the role to map

    KubernetesMapping
    KubernetesMapping

    (Members of KubernetesMapping are embedded into this type.)

    KubernetesMapping holds the RBAC details for the mapping

    UserMapping

    (Appears on:IAMAuthenticatorConfig)

    UserMapping represents a mapping from an IAM user to Kubernetes users and groups

    Field Description
    userarn
    string

    UserARN is the AWS ARN for the user to map

    KubernetesMapping
    KubernetesMapping

    (Members of KubernetesMapping are embedded into this type.)

    KubernetesMapping holds the RBAC details for the mapping


    Generated with gen-crd-api-reference-docs on git commit f19c125c.