awsmanagedmachinepool_v1alpha3.json

{
  "description": "AWSManagedMachinePool is the Schema for the awsmanagedmachinepools API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More 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. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More 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 ones 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"
          ],
          "type": "string"
        },
        "amiVersion": {
          "description": "AMIVersion defines the desired AMI release version. If no version number is supplied then the latest version for the Kubernetes version will be used",
          "minLength": 2,
          "type": "string"
        },
        "availabilityZones": {
          "description": "AvailabilityZones is an array of availability zones instances can run in",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "diskSize": {
          "description": "DiskSize specifies the root disk size",
          "format": "int32",
          "type": "integer"
        },
        "eksNodegroupName": {
          "description": "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.",
          "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 autoscaling group corresponding to the nodegroup represented by this machine 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. If left empty, the key from the control plane is used.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "roleName": {
          "description": "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.",
          "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 auto scaling group of this nodegroup",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "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. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "A human readable message indicating details about the transition. This field may be empty.",
                "type": "string"
              },
              "reason": {
                "description": "The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.",
                "type": "string"
              },
              "severity": {
                "description": "Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The 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. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.",
                "type": "string"
              }
            },
            "required": [
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "failureMessage": {
          "description": "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. \n 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. \n 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.",
          "type": "string"
        },
        "failureReason": {
          "description": "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. \n 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. \n 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.",
          "type": "string"
        },
        "ready": {
          "default": false,
          "description": "Ready denotes that the AWSManagedMachinePool nodegroup has joined the 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"
}