Packages:

infrastructure.cluster.x-k8s.io/v1alpha4

Resource Types:

    ASGStatus (string alias)

    (Appears on:AWSMachinePoolStatus, AutoScalingGroup)

    ASGStatus is a status string returned by the autoscaling API

    AWSFargateProfile

    AWSFargateProfile is the Schema for the awsfargateprofiles API

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


    clusterName
    string

    ClusterName is the name of the Cluster this object belongs to.

    profileName
    string

    ProfileName specifies the profile name.

    subnetIDs
    []string
    (Optional)

    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.

    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.

    roleName
    string
    (Optional)

    RoleName specifies the name of IAM role for this fargate pool 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.

    selectors
    []FargateSelector

    Selectors specify fargate pod selectors.

    status
    FargateProfileStatus

    AWSLaunchTemplate

    (Appears on:AWSMachinePoolSpec)

    AwsLaunchTemplate defines the desired state of AWSLaunchTemplate

    Field Description
    name
    string

    The name of the launch template.

    iamInstanceProfile
    string

    The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

    ami
    Cluster API AWS api/v1alpha4.AWSResourceReference
    (Optional)

    AMI is the reference to the AMI from which to create the machine instance.

    imageLookupFormat
    string
    (Optional)

    ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. 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

    ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

    imageLookupBaseOS
    string

    ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

    instanceType
    string

    InstanceType is the type of instance to create. Example: m4.xlarge

    rootVolume
    Cluster API AWS api/v1alpha4.Volume
    (Optional)

    RootVolume encapsulates the configuration options for the root volume

    sshKeyName
    string
    (Optional)

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

    versionNumber
    int64

    VersionNumber is the version of the launch template that is applied. Typically a new version is created when at least one of the following happens: 1) A new launch template spec is applied. 2) One or more parameters in an existing template is changed. 3) A new AMI is discovered.

    additionalSecurityGroups
    []Cluster API AWS api/v1alpha4.AWSResourceReference
    (Optional)

    AdditionalSecurityGroups is an array of references to security groups that should be applied to the instances. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator.

    AWSMachinePool

    AWSMachinePool is the Schema for the awsmachinepools API

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


    providerID
    string
    (Optional)

    ProviderID is the ARN of the associated ASG

    minSize
    int32

    The minimum size of the group.

    maxSize
    int32

    The maximum size of the group.

    availabilityZones
    []string

    AvailabilityZones is an array of availability zones instances can run in

    subnets
    []Cluster API AWS api/v1alpha4.AWSResourceReference
    (Optional)

    Subnets is an array of subnet configurations

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

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

    awsLaunchTemplate
    AWSLaunchTemplate

    AWSLaunchTemplate specifies the launch template and version to use when an instance is launched.

    mixedInstancesPolicy
    MixedInstancesPolicy

    MixedInstancesPolicy describes how multiple instance types will be used by the ASG.

    providerIDList
    []string
    (Optional)

    ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

    defaultCoolDown
    Kubernetes meta/v1.Duration
    (Optional)

    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. If no value is supplied by user a default value of 300 seconds is set

    refreshPreferences
    RefreshPreferences
    (Optional)

    RefreshPreferences describes set of preferences associated with the instance refresh request.

    capacityRebalance
    bool
    (Optional)

    Enable or disable the capacity rebalance autoscaling group feature

    status
    AWSMachinePoolStatus

    AWSMachinePoolInstanceStatus

    Field Description
    instanceID
    string
    (Optional)

    InstanceID is the identification of the Machine Instance within ASG

    version
    string
    (Optional)

    Version defines the Kubernetes version for the Machine Instance

    AWSMachinePoolSpec

    (Appears on:AWSMachinePool)

    AWSMachinePoolSpec defines the desired state of AWSMachinePool

    Field Description
    providerID
    string
    (Optional)

    ProviderID is the ARN of the associated ASG

    minSize
    int32

    The minimum size of the group.

    maxSize
    int32

    The maximum size of the group.

    availabilityZones
    []string

    AvailabilityZones is an array of availability zones instances can run in

    subnets
    []Cluster API AWS api/v1alpha4.AWSResourceReference
    (Optional)

    Subnets is an array of subnet configurations

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

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

    awsLaunchTemplate
    AWSLaunchTemplate

    AWSLaunchTemplate specifies the launch template and version to use when an instance is launched.

    mixedInstancesPolicy
    MixedInstancesPolicy

    MixedInstancesPolicy describes how multiple instance types will be used by the ASG.

    providerIDList
    []string
    (Optional)

    ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

    defaultCoolDown
    Kubernetes meta/v1.Duration
    (Optional)

    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. If no value is supplied by user a default value of 300 seconds is set

    refreshPreferences
    RefreshPreferences
    (Optional)

    RefreshPreferences describes set of preferences associated with the instance refresh request.

    capacityRebalance
    bool
    (Optional)

    Enable or disable the capacity rebalance autoscaling group feature

    AWSMachinePoolStatus

    (Appears on:AWSMachinePool)

    AWSMachinePoolStatus defines the observed state of AWSMachinePool

    Field Description
    ready
    bool
    (Optional)

    Ready is true when the provider resource is ready.

    replicas
    int32
    (Optional)

    Replicas is the most recently observed number of replicas

    conditions
    Cluster API api/v1alpha4.Conditions
    (Optional)

    Conditions defines current service state of the AWSMachinePool.

    instances
    []*../../exp/api/v1alpha4.AWSMachinePoolInstanceStatus
    (Optional)

    Instances contains the status for each instance in the pool

    launchTemplateID
    string

    The ID of the launch template

    failureReason
    Cluster API errors.MachineStatusError
    (Optional)

    FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.

    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

    Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

    failureMessage
    string
    (Optional)

    FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.

    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

    Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

    asgStatus
    ASGStatus

    AWSManagedCluster

    AWSManagedCluster is the Schema for the awsmanagedclusters API

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


    controlPlaneEndpoint
    Cluster API api/v1alpha4.APIEndpoint
    (Optional)

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

    status
    AWSManagedClusterStatus

    AWSManagedClusterSpec

    (Appears on:AWSManagedCluster)

    AWSManagedClusterSpec defines the desired state of AWSManagedCluster

    Field Description
    controlPlaneEndpoint
    Cluster API api/v1alpha4.APIEndpoint
    (Optional)

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

    AWSManagedClusterStatus

    (Appears on:AWSManagedCluster)

    AWSManagedClusterStatus defines the observed state of AWSManagedCluster

    Field Description
    ready
    bool
    (Optional)

    Ready is when the AWSManagedControlPlane has a API server URL.

    failureDomains
    Cluster API api/v1alpha4.FailureDomains
    (Optional)

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

    AWSManagedMachinePool

    AWSManagedMachinePool is the Schema for the awsmanagedmachinepools API

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


    eksNodegroupName
    string
    (Optional)

    EKSNodegroupName specifies the name of the nodegroup in AWS corresponding to this MachinePool. If you don’t specify a name then a default name will be created based on the namespace and name of the managed machine pool.

    availabilityZones
    []string

    AvailabilityZones is an array of availability zones instances can run in

    subnetIDs
    []string
    (Optional)

    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup

    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.

    roleName
    string
    (Optional)

    RoleName specifies the name of IAM role for the node group. 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.

    amiVersion
    string
    (Optional)

    AMIVersion defines the desired AMI release version. If no version number is supplied then the latest version for the Kubernetes version will be used

    amiType
    ManagedMachineAMIType
    (Optional)

    AMIType defines the AMI type

    labels
    map[string]string
    (Optional)

    Labels specifies labels for the Kubernetes node objects

    diskSize
    int32
    (Optional)

    DiskSize specifies the root disk size

    instanceType
    string
    (Optional)

    InstanceType specifies the AWS instance type

    scaling
    ManagedMachinePoolScaling
    (Optional)

    Scaling specifies scaling for the ASG behind this pool

    remoteAccess
    ManagedRemoteAccess
    (Optional)

    RemoteAccess specifies how machines can be accessed remotely

    providerIDList
    []string
    (Optional)

    ProviderIDList are the provider IDs of instances in the autoscaling group corresponding to the nodegroup represented by this machine pool

    status
    AWSManagedMachinePoolStatus

    AWSManagedMachinePoolSpec

    (Appears on:AWSManagedMachinePool)

    AWSManagedMachinePoolSpec defines the desired state of AWSManagedMachinePool

    Field Description
    eksNodegroupName
    string
    (Optional)

    EKSNodegroupName specifies the name of the nodegroup in AWS corresponding to this MachinePool. If you don’t specify a name then a default name will be created based on the namespace and name of the managed machine pool.

    availabilityZones
    []string

    AvailabilityZones is an array of availability zones instances can run in

    subnetIDs
    []string
    (Optional)

    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup

    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.

    roleName
    string
    (Optional)

    RoleName specifies the name of IAM role for the node group. 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.

    amiVersion
    string
    (Optional)

    AMIVersion defines the desired AMI release version. If no version number is supplied then the latest version for the Kubernetes version will be used

    amiType
    ManagedMachineAMIType
    (Optional)

    AMIType defines the AMI type

    labels
    map[string]string
    (Optional)

    Labels specifies labels for the Kubernetes node objects

    diskSize
    int32
    (Optional)

    DiskSize specifies the root disk size

    instanceType
    string
    (Optional)

    InstanceType specifies the AWS instance type

    scaling
    ManagedMachinePoolScaling
    (Optional)

    Scaling specifies scaling for the ASG behind this pool

    remoteAccess
    ManagedRemoteAccess
    (Optional)

    RemoteAccess specifies how machines can be accessed remotely

    providerIDList
    []string
    (Optional)

    ProviderIDList are the provider IDs of instances in the autoscaling group corresponding to the nodegroup represented by this machine pool

    AWSManagedMachinePoolStatus

    (Appears on:AWSManagedMachinePool)

    AWSManagedMachinePoolStatus defines the observed state of AWSManagedMachinePool

    Field Description
    ready
    bool

    Ready denotes that the AWSManagedMachinePool nodegroup has joined the cluster

    replicas
    int32
    (Optional)

    Replicas is the most recently observed number of replicas.

    failureReason
    Cluster API errors.MachineStatusError
    (Optional)

    FailureReason will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a succinct value suitable for machine interpretation.

    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

    Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

    failureMessage
    string
    (Optional)

    FailureMessage will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a more verbose string suitable for logging and human consumption.

    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachinePool’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

    Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

    conditions
    Cluster API api/v1alpha4.Conditions
    (Optional)

    Conditions defines current service state of the managed machine pool

    AutoScalingGroup

    AutoScalingGroup describes an AWS autoscaling group.

    Field Description
    id
    string

    The tags associated with the instance.

    tags
    Cluster API AWS api/v1alpha4.Tags
    name
    string
    desiredCapacity
    int32
    maxSize
    int32
    minSize
    int32
    placementGroup
    string
    subnets
    []string
    defaultCoolDown
    Kubernetes meta/v1.Duration
    capacityRebalance
    bool
    mixedInstancesPolicy
    MixedInstancesPolicy
    Status
    ASGStatus
    instances
    []Cluster API AWS api/v1alpha4.Instance

    BlockDeviceMapping

    BlockDeviceMappings specifies the block devices for the instance. You can specify virtual devices and EBS volumes.

    Field Description
    deviceName
    string

    The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

    ebs
    EBS
    (Optional)

    You can specify either VirtualName or Ebs, but not both.

    EBS

    (Appears on:BlockDeviceMapping)

    EBS can be used to automatically set up EBS volumes when an instance is launched.

    Field Description
    encrypted
    bool
    (Optional)

    Encrypted is whether the volume should be encrypted or not.

    volumeSize
    int64
    (Optional)

    The size of the volume, in GiB. This can be a number from 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

    volumeType
    string
    (Optional)

    The volume type For more information, see Amazon EBS Volume Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html)

    FargateProfileSpec

    (Appears on:AWSFargateProfile)

    FargateProfileSpec defines the desired state of FargateProfile

    Field Description
    clusterName
    string

    ClusterName is the name of the Cluster this object belongs to.

    profileName
    string

    ProfileName specifies the profile name.

    subnetIDs
    []string
    (Optional)

    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.

    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.

    roleName
    string
    (Optional)

    RoleName specifies the name of IAM role for this fargate pool 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.

    selectors
    []FargateSelector

    Selectors specify fargate pod selectors.

    FargateProfileStatus

    (Appears on:AWSFargateProfile)

    FargateProfileStatus defines the observed state of FargateProfile

    Field Description
    ready
    bool

    Ready denotes that the FargateProfile is available.

    failureReason
    Cluster API errors.MachineStatusError
    (Optional)

    FailureReason will be set in the event that there is a terminal problem reconciling the FargateProfile and will contain a succinct value suitable for machine interpretation.

    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the FargateProfile’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

    Any transient errors that occur during the reconciliation of FargateProfiles can be added as events to the FargateProfile object and/or logged in the controller’s output.

    failureMessage
    string
    (Optional)

    FailureMessage will be set in the event that there is a terminal problem reconciling the FargateProfile and will contain a more verbose string suitable for logging and human consumption.

    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the FargateProfile’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

    Any transient errors that occur during the reconciliation of FargateProfiles can be added as events to the FargateProfile object and/or logged in the controller’s output.

    conditions
    Cluster API api/v1alpha4.Conditions
    (Optional)

    Conditions defines current state of the Fargate profile.

    FargateSelector

    (Appears on:FargateProfileSpec)

    FargateSelector specifies a selector for pods that should run on this fargate pool

    Field Description
    labels
    map[string]string

    Labels specifies which pod labels this selector should match.

    namespace
    string

    Namespace specifies which namespace this selector should match.

    InstancesDistribution

    (Appears on:MixedInstancesPolicy)

    InstancesDistribution to configure distribution of On-Demand Instances and Spot Instances.

    Field Description
    onDemandAllocationStrategy
    OnDemandAllocationStrategy
    spotAllocationStrategy
    SpotAllocationStrategy
    onDemandBaseCapacity
    int64
    onDemandPercentageAboveBaseCapacity
    int64

    ManagedMachineAMIType (string alias)

    (Appears on:AWSManagedMachinePoolSpec)

    ManagedMachineAMIType specifies which AWS AMI to use for a managed MachinePool

    Value Description

    "AL2_ARM_64"

    Al2Arm64 is the Arm AMI type

    "AL2_x86_64"

    Al2x86_64 is the default AMI type

    "AL2_x86_64_GPU"

    Al2x86_64GPU is the x86-64 GPU AMI type

    ManagedMachinePoolScaling

    (Appears on:AWSManagedMachinePoolSpec)

    ManagedMachinePoolScaling specifies scaling options

    Field Description
    minSize
    int32
    maxSize
    int32

    ManagedRemoteAccess

    (Appears on:AWSManagedMachinePoolSpec)

    ManagedRemoteAccess specifies remote access settings for EC2 instances

    Field Description
    sshKeyName
    string

    SSHKeyName specifies which EC2 SSH key can be used to access machines. If left empty, the key from the control plane is used.

    sourceSecurityGroups
    []string

    SourceSecurityGroups specifies which security groups are allowed access

    public
    bool

    Public specifies whether to open port 22 to the public internet

    MixedInstancesPolicy

    (Appears on:AWSMachinePoolSpec, AutoScalingGroup)

    MixedInstancesPolicy for an Auto Scaling group

    Field Description
    instancesDistribution
    InstancesDistribution
    overrides
    []Overrides

    OnDemandAllocationStrategy (string alias)

    (Appears on:InstancesDistribution)

    OnDemandAllocationStrategy indicates how to allocate instance types to fulfill On-Demand capacity.

    Overrides

    (Appears on:MixedInstancesPolicy)

    Overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

    Field Description
    instanceType
    string

    RefreshPreferences

    (Appears on:AWSMachinePoolSpec)

    Field Description
    strategy
    string
    (Optional)

    The strategy to use for the instance refresh. The only valid value is Rolling. A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated.

    instanceWarmup
    int64
    (Optional)

    The number of seconds until a newly launched instance is configured and ready to use. During this time, the next replacement will not be initiated. The default is to use the value for the health check grace period defined for the group.

    minHealthyPercentage
    int64
    (Optional)

    The amount of capacity as a percentage in ASG that must remain healthy during an instance refresh. The default is 90.

    SpotAllocationStrategy (string alias)

    (Appears on:InstancesDistribution)

    SpotAllocationStrategy indicates how to allocate instances across Spot Instance pools.

    Tags (map[string]string alias)

    Tags


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