awsmanagedmachinepool_v1beta2.json

{
  "description": "AWSManagedMachinePool is the Schema for the awsmanagedmachinepools API.",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "AWSManagedMachinePoolSpec defines the desired state of AWSManagedMachinePool.",
      "properties": {
        "additionalTags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the\nones added by default.",
          "type": "object"
        },
        "amiType": {
          "default": "AL2_x86_64",
          "description": "AMIType defines the AMI type",
          "enum": [
            "AL2_x86_64",
            "AL2_x86_64_GPU",
            "AL2_ARM_64",
            "AL2023_x86_64_STANDARD",
            "AL2023_ARM_64_STANDARD",
            "CUSTOM"
          ],
          "type": "string"
        },
        "amiVersion": {
          "description": "AMIVersion defines the desired AMI release version. If no version number\nis supplied then the latest version for the Kubernetes version\nwill be used",
          "minLength": 2,
          "type": "string"
        },
        "availabilityZoneSubnetType": {
          "description": "AvailabilityZoneSubnetType specifies which type of subnets to use when an availability zone is specified.",
          "enum": [
            "public",
            "private",
            "all"
          ],
          "type": "string"
        },
        "availabilityZones": {
          "description": "AvailabilityZones is an array of availability zones instances can run in",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "awsLaunchTemplate": {
          "description": "AWSLaunchTemplate specifies the launch template to use to create the managed node group.\nIf AWSLaunchTemplate is specified, certain node group configuraions outside of launch template\nare prohibited (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html).",
          "properties": {
            "additionalSecurityGroups": {
              "description": "AdditionalSecurityGroups is an array of references to security groups that should be applied to the\ninstances. These security groups would be set in addition to any security groups defined\nat the cluster level or in the actuator.",
              "items": {
                "description": "AWSResourceReference is a reference to a specific AWS resource by ID or filters.\nOnly one of ID or Filters may be specified. Specifying more than one will result in\na validation error.",
                "properties": {
                  "filters": {
                    "description": "Filters is a set of key/value pairs used to identify a resource\nThey are applied according to the rules defined by the AWS API:\nhttps://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html",
                    "items": {
                      "description": "Filter is a filter used to identify an AWS resource.",
                      "properties": {
                        "name": {
                          "description": "Name of the filter. Filter names are case-sensitive.",
                          "type": "string"
                        },
                        "values": {
                          "description": "Values includes one or more filter values. Filter values are case-sensitive.",
                          "items": {
                            "type": "string"
                          },
                          "type": "array"
                        }
                      },
                      "required": [
                        "name",
                        "values"
                      ],
                      "type": "object",
                      "additionalProperties": false
                    },
                    "type": "array"
                  },
                  "id": {
                    "description": "ID of resource",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "ami": {
              "description": "AMI is the reference to the AMI from which to create the machine instance.",
              "properties": {
                "eksLookupType": {
                  "description": "EKSOptimizedLookupType If specified, will look up an EKS Optimized image in SSM Parameter store",
                  "enum": [
                    "AmazonLinux",
                    "AmazonLinuxGPU"
                  ],
                  "type": "string"
                },
                "id": {
                  "description": "ID of resource",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "iamInstanceProfile": {
              "description": "The name or the Amazon Resource Name (ARN) of the instance profile associated\nwith the IAM role for the instance. The instance profile contains the IAM\nrole.",
              "type": "string"
            },
            "imageLookupBaseOS": {
              "description": "ImageLookupBaseOS is the name of the base operating system to use for\nimage lookup the AMI is not set.",
              "type": "string"
            },
            "imageLookupFormat": {
              "description": "ImageLookupFormat is the AMI naming format to look up the image for this\nmachine It will be ignored if an explicit AMI is set. Supports\nsubstitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and\nkubernetes version, respectively. The BaseOS will be the value in\nImageLookupBaseOS or ubuntu (the default), and the kubernetes version as\ndefined by the packages produced by kubernetes/release without v as a\nprefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default\nimage format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up\nsearching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a\nMachine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See\nalso: https://golang.org/pkg/text/template/",
              "type": "string"
            },
            "imageLookupOrg": {
              "description": "ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.",
              "type": "string"
            },
            "instanceMetadataOptions": {
              "description": "InstanceMetadataOptions defines the behavior for applying metadata to instances.",
              "properties": {
                "httpEndpoint": {
                  "default": "enabled",
                  "description": "Enables or disables the HTTP metadata endpoint on your instances.\n\n\nIf you specify a value of disabled, you cannot access your instance metadata.\n\n\nDefault: enabled",
                  "enum": [
                    "enabled",
                    "disabled"
                  ],
                  "type": "string"
                },
                "httpPutResponseHopLimit": {
                  "default": 1,
                  "description": "The desired HTTP PUT response hop limit for instance metadata requests. The\nlarger the number, the further instance metadata requests can travel.\n\n\nDefault: 1",
                  "format": "int64",
                  "maximum": 64,
                  "minimum": 1,
                  "type": "integer"
                },
                "httpTokens": {
                  "default": "optional",
                  "description": "The state of token usage for your instance metadata requests.\n\n\nIf the state is optional, you can choose to retrieve instance metadata with\nor without a session token on your request. If you retrieve the IAM role\ncredentials without a token, the version 1.0 role credentials are returned.\nIf you retrieve the IAM role credentials using a valid session token, the\nversion 2.0 role credentials are returned.\n\n\nIf the state is required, you must send a session token with any instance\nmetadata retrieval requests. In this state, retrieving the IAM role credentials\nalways returns the version 2.0 credentials; the version 1.0 credentials are\nnot available.\n\n\nDefault: optional",
                  "enum": [
                    "optional",
                    "required"
                  ],
                  "type": "string"
                },
                "instanceMetadataTags": {
                  "default": "disabled",
                  "description": "Set to enabled to allow access to instance tags from the instance metadata.\nSet to disabled to turn off access to instance tags from the instance metadata.\nFor more information, see Work with instance tags using the instance metadata\n(https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS).\n\n\nDefault: disabled",
                  "enum": [
                    "enabled",
                    "disabled"
                  ],
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "instanceType": {
              "description": "InstanceType is the type of instance to create. Example: m4.xlarge",
              "type": "string"
            },
            "name": {
              "description": "The name of the launch template.",
              "type": "string"
            },
            "privateDnsName": {
              "description": "PrivateDNSName is the options for the instance hostname.",
              "properties": {
                "enableResourceNameDnsAAAARecord": {
                  "description": "EnableResourceNameDNSAAAARecord indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.",
                  "type": "boolean"
                },
                "enableResourceNameDnsARecord": {
                  "description": "EnableResourceNameDNSARecord indicates whether to respond to DNS queries for instance hostnames with DNS A records.",
                  "type": "boolean"
                },
                "hostnameType": {
                  "description": "The type of hostname to assign to an instance.",
                  "enum": [
                    "ip-name",
                    "resource-name"
                  ],
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "rootVolume": {
              "description": "RootVolume encapsulates the configuration options for the root volume",
              "properties": {
                "deviceName": {
                  "description": "Device name",
                  "type": "string"
                },
                "encrypted": {
                  "description": "Encrypted is whether the volume should be encrypted or not.",
                  "type": "boolean"
                },
                "encryptionKey": {
                  "description": "EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN.\nIf Encrypted is set and this is omitted, the default AWS key will be used.\nThe key must already exist and be accessible by the controller.",
                  "type": "string"
                },
                "iops": {
                  "description": "IOPS is the number of IOPS requested for the disk. Not applicable to all types.",
                  "format": "int64",
                  "type": "integer"
                },
                "size": {
                  "description": "Size specifies size (in Gi) of the storage device.\nMust be greater than the image snapshot size or 8 (whichever is greater).",
                  "format": "int64",
                  "minimum": 8,
                  "type": "integer"
                },
                "throughput": {
                  "description": "Throughput to provision in MiB/s supported for the volume type. Not applicable to all types.",
                  "format": "int64",
                  "type": "integer"
                },
                "type": {
                  "description": "Type is the type of the volume (e.g. gp2, io1, etc...).",
                  "type": "string"
                }
              },
              "required": [
                "size"
              ],
              "type": "object",
              "additionalProperties": false
            },
            "spotMarketOptions": {
              "description": "SpotMarketOptions are options for configuring AWSMachinePool instances to be run using AWS Spot instances.",
              "properties": {
                "maxPrice": {
                  "description": "MaxPrice defines the maximum price the user is willing to pay for Spot VM instances",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "sshKeyName": {
              "description": "SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string\n(do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)",
              "type": "string"
            },
            "versionNumber": {
              "description": "VersionNumber is the version of the launch template that is applied.\nTypically a new version is created when at least one of the following happens:\n1) A new launch template spec is applied.\n2) One or more parameters in an existing template is changed.\n3) A new AMI is discovered.",
              "format": "int64",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "capacityType": {
          "default": "onDemand",
          "description": "CapacityType specifies the capacity type for the ASG behind this pool",
          "enum": [
            "onDemand",
            "spot"
          ],
          "type": "string"
        },
        "diskSize": {
          "description": "DiskSize specifies the root disk size",
          "format": "int32",
          "type": "integer"
        },
        "eksNodegroupName": {
          "description": "EKSNodegroupName specifies the name of the nodegroup in AWS\ncorresponding to this MachinePool. If you don't specify a name\nthen a default name will be created based on the namespace and\nname of the managed machine pool.",
          "type": "string"
        },
        "instanceType": {
          "description": "InstanceType specifies the AWS instance type",
          "type": "string"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Labels specifies labels for the Kubernetes node objects",
          "type": "object"
        },
        "providerIDList": {
          "description": "ProviderIDList are the provider IDs of instances in the\nautoscaling group corresponding to the nodegroup represented by this\nmachine pool",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "remoteAccess": {
          "description": "RemoteAccess specifies how machines can be accessed remotely",
          "properties": {
            "public": {
              "description": "Public specifies whether to open port 22 to the public internet",
              "type": "boolean"
            },
            "sourceSecurityGroups": {
              "description": "SourceSecurityGroups specifies which security groups are allowed access",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "sshKeyName": {
              "description": "SSHKeyName specifies which EC2 SSH key can be used to access machines.\nIf left empty, the key from the control plane is used.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "roleAdditionalPolicies": {
          "description": "RoleAdditionalPolicies allows you to attach additional polices to\nthe node group role. You must enable the EKSAllowAddRoles\nfeature flag to incorporate these into the created role.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "roleName": {
          "description": "RoleName specifies the name of IAM role for the node group.\nIf the role is pre-existing we will treat it as unmanaged\nand not delete it on deletion. If the EKSEnableIAM feature\nflag is true and no name is supplied then a role is created.",
          "type": "string"
        },
        "scaling": {
          "description": "Scaling specifies scaling for the ASG behind this pool",
          "properties": {
            "maxSize": {
              "format": "int32",
              "type": "integer"
            },
            "minSize": {
              "format": "int32",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "subnetIDs": {
          "description": "SubnetIDs specifies which subnets are used for the\nauto scaling group of this nodegroup",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "taints": {
          "description": "Taints specifies the taints to apply to the nodes of the machine pool",
          "items": {
            "description": "Taint defines the specs for a Kubernetes taint.",
            "properties": {
              "effect": {
                "description": "Effect specifies the effect for the taint",
                "enum": [
                  "no-schedule",
                  "no-execute",
                  "prefer-no-schedule"
                ],
                "type": "string"
              },
              "key": {
                "description": "Key is the key of the taint",
                "type": "string"
              },
              "value": {
                "description": "Value is the value of the taint",
                "type": "string"
              }
            },
            "required": [
              "effect",
              "key",
              "value"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "updateConfig": {
          "description": "UpdateConfig holds the optional config to control the behaviour of the update\nto the nodegroup.",
          "properties": {
            "maxUnavailable": {
              "description": "MaxUnavailable is the maximum number of nodes unavailable at once during a version update.\nNodes will be updated in parallel. The maximum number is 100.",
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            },
            "maxUnavailablePercentage": {
              "description": "MaxUnavailablePercentage is the maximum percentage of nodes unavailable during a version update. This\npercentage of nodes will be updated in parallel, up to 100 nodes at once.",
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "AWSManagedMachinePoolStatus defines the observed state of AWSManagedMachinePool.",
      "properties": {
        "conditions": {
          "description": "Conditions defines current service state of the managed machine pool",
          "items": {
            "description": "Condition defines an observation of a Cluster API resource operational state.",
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when\nthe API field changed is acceptable.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "A human readable message indicating details about the transition.\nThis field may be empty.",
                "type": "string"
              },
              "reason": {
                "description": "The reason for the condition's last transition in CamelCase.\nThe specific API may choose whether or not this field is considered a guaranteed API.\nThis field may not be empty.",
                "type": "string"
              },
              "severity": {
                "description": "Severity provides an explicit classification of Reason code, so the users or machines can immediately\nunderstand the current situation and act accordingly.\nThe Severity field MUST be set only when Status=False.",
                "type": "string"
              },
              "status": {
                "description": "Status of the condition, one of True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type of condition in CamelCase or in foo.example.com/CamelCase.\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions\ncan be useful (see .node.status.conditions), the ability to deconflict is important.",
                "type": "string"
              }
            },
            "required": [
              "lastTransitionTime",
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "failureMessage": {
          "description": "FailureMessage will be set in the event that there is a terminal problem\nreconciling the MachinePool and will contain a more verbose string suitable\nfor logging and human consumption.\n\n\nThis field should not be set for transitive errors that a controller\nfaces that are expected to be fixed automatically over\ntime (like service outages), but instead indicate that something is\nfundamentally wrong with the MachinePool's spec or the configuration of\nthe controller, and that manual intervention is required. Examples\nof terminal errors would be invalid combinations of settings in the\nspec, values that are unsupported by the controller, or the\nresponsible controller itself being critically misconfigured.\n\n\nAny transient errors that occur during the reconciliation of MachinePools\ncan be added as events to the MachinePool object and/or logged in the\ncontroller's output.",
          "type": "string"
        },
        "failureReason": {
          "description": "FailureReason will be set in the event that there is a terminal problem\nreconciling the MachinePool and will contain a succinct value suitable\nfor machine interpretation.\n\n\nThis field should not be set for transitive errors that a controller\nfaces that are expected to be fixed automatically over\ntime (like service outages), but instead indicate that something is\nfundamentally wrong with the Machine's spec or the configuration of\nthe controller, and that manual intervention is required. Examples\nof terminal errors would be invalid combinations of settings in the\nspec, values that are unsupported by the controller, or the\nresponsible controller itself being critically misconfigured.\n\n\nAny transient errors that occur during the reconciliation of MachinePools\ncan be added as events to the MachinePool object and/or logged in the\ncontroller's output.",
          "type": "string"
        },
        "launchTemplateID": {
          "description": "The ID of the launch template",
          "type": "string"
        },
        "launchTemplateVersion": {
          "description": "The version of the launch template",
          "type": "string"
        },
        "ready": {
          "default": false,
          "description": "Ready denotes that the AWSManagedMachinePool nodegroup has joined\nthe cluster",
          "type": "boolean"
        },
        "replicas": {
          "description": "Replicas is the most recently observed number of replicas.",
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "ready"
      ],
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}