awsmachinepool_v1beta2.json

{
  "description": "AWSMachinePool is the Schema for the awsmachinepools 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": "AWSMachinePoolSpec defines the desired state of AWSMachinePool.",
      "properties": {
        "additionalTags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the\nAWS provider.",
          "type": "object"
        },
        "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 and version to use when an instance is launched.",
          "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
        },
        "capacityRebalance": {
          "description": "Enable or disable the capacity rebalance autoscaling group feature",
          "type": "boolean"
        },
        "defaultCoolDown": {
          "description": "The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.\nIf no value is supplied by user a default value of 300 seconds is set",
          "type": "string"
        },
        "defaultInstanceWarmup": {
          "description": "The amount of time, in seconds, until a new instance is considered to\nhave finished initializing and resource consumption to become stable\nafter it enters the InService state.\nIf no value is supplied by user a default value of 300 seconds is set",
          "type": "string"
        },
        "maxSize": {
          "default": 1,
          "description": "MaxSize defines the maximum size of the group.",
          "format": "int32",
          "minimum": 1,
          "type": "integer"
        },
        "minSize": {
          "default": 1,
          "description": "MinSize defines the minimum size of the group.",
          "format": "int32",
          "minimum": 0,
          "type": "integer"
        },
        "mixedInstancesPolicy": {
          "description": "MixedInstancesPolicy describes how multiple instance types will be used by the ASG.",
          "properties": {
            "instancesDistribution": {
              "description": "InstancesDistribution to configure distribution of On-Demand Instances and Spot Instances.",
              "properties": {
                "onDemandAllocationStrategy": {
                  "default": "prioritized",
                  "description": "OnDemandAllocationStrategy indicates how to allocate instance types to fulfill On-Demand capacity.",
                  "enum": [
                    "prioritized",
                    "lowest-price"
                  ],
                  "type": "string"
                },
                "onDemandBaseCapacity": {
                  "default": 0,
                  "format": "int64",
                  "type": "integer"
                },
                "onDemandPercentageAboveBaseCapacity": {
                  "default": 100,
                  "format": "int64",
                  "type": "integer"
                },
                "spotAllocationStrategy": {
                  "default": "lowest-price",
                  "description": "SpotAllocationStrategy indicates how to allocate instances across Spot Instance pools.",
                  "enum": [
                    "lowest-price",
                    "capacity-optimized",
                    "capacity-optimized-prioritized",
                    "price-capacity-optimized"
                  ],
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "overrides": {
              "items": {
                "description": "Overrides are used to override the instance type specified by the launch template with multiple\ninstance types that can be used to launch On-Demand Instances and Spot Instances.",
                "properties": {
                  "instanceType": {
                    "type": "string"
                  }
                },
                "required": [
                  "instanceType"
                ],
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "providerID": {
          "description": "ProviderID is the ARN of the associated ASG",
          "type": "string"
        },
        "providerIDList": {
          "description": "ProviderIDList are the identification IDs of machine instances provided by the provider.\nThis field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "refreshPreferences": {
          "description": "RefreshPreferences describes set of preferences associated with the instance refresh request.",
          "properties": {
            "disable": {
              "description": "Disable, if true, disables instance refresh from triggering when new launch templates are detected.\nThis is useful in scenarios where ASG nodes are externally managed.",
              "type": "boolean"
            },
            "instanceWarmup": {
              "description": "The number of seconds until a newly launched instance is configured and ready\nto use. During this time, the next replacement will not be initiated.\nThe default is to use the value for the health check grace period defined for the group.",
              "format": "int64",
              "type": "integer"
            },
            "minHealthyPercentage": {
              "description": "The amount of capacity as a percentage in ASG that must remain healthy\nduring an instance refresh. The default is 90.",
              "format": "int64",
              "type": "integer"
            },
            "strategy": {
              "description": "The strategy to use for the instance refresh. The only valid value is Rolling.\nA rolling update is an update that is applied to all instances in an Auto\nScaling group until all instances have been updated.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "subnets": {
          "description": "Subnets is an array of subnet configurations",
          "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"
        },
        "suspendProcesses": {
          "description": "SuspendProcesses defines a list of processes to suspend for the given ASG. This is constantly reconciled.\nIf a process is removed from this list it will automatically be resumed.",
          "properties": {
            "all": {
              "type": "boolean"
            },
            "processes": {
              "description": "Processes defines the processes which can be enabled or disabled individually.",
              "properties": {
                "addToLoadBalancer": {
                  "type": "boolean"
                },
                "alarmNotification": {
                  "type": "boolean"
                },
                "azRebalance": {
                  "type": "boolean"
                },
                "healthCheck": {
                  "type": "boolean"
                },
                "instanceRefresh": {
                  "type": "boolean"
                },
                "launch": {
                  "type": "boolean"
                },
                "replaceUnhealthy": {
                  "type": "boolean"
                },
                "scheduledActions": {
                  "type": "boolean"
                },
                "terminate": {
                  "type": "boolean"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "awsLaunchTemplate",
        "maxSize",
        "minSize"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "AWSMachinePoolStatus defines the observed state of AWSMachinePool.",
      "properties": {
        "asgStatus": {
          "description": "ASGStatus is a status string returned by the autoscaling API.",
          "type": "string"
        },
        "conditions": {
          "description": "Conditions defines current service state of the AWSMachinePool.",
          "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 Machine 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 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 Machines\ncan be added as events to the Machine 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 Machine 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 Machines\ncan be added as events to the Machine object and/or logged in the\ncontroller's output.",
          "type": "string"
        },
        "instances": {
          "description": "Instances contains the status for each instance in the pool",
          "items": {
            "description": "AWSMachinePoolInstanceStatus defines the status of the AWSMachinePoolInstance.",
            "properties": {
              "instanceID": {
                "description": "InstanceID is the identification of the Machine Instance within ASG",
                "type": "string"
              },
              "version": {
                "description": "Version defines the Kubernetes version for the Machine Instance",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "launchTemplateID": {
          "description": "The ID of the launch template",
          "type": "string"
        },
        "launchTemplateVersion": {
          "description": "The version of the launch template",
          "type": "string"
        },
        "ready": {
          "description": "Ready is true when the provider resource is ready.",
          "type": "boolean"
        },
        "replicas": {
          "description": "Replicas is the most recently observed number of replicas",
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}