Addon

eks.services.k8s.aws/v1alpha1

TypeLink
GoDoceks-controller/apis/v1alpha1#Addon

Metadata

PropertyValue
ScopeNamespaced
KindAddon
ListKindAddonList
Pluraladdons
Singularaddon

An Amazon EKS add-on. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the Amazon EKS User Guide.

Spec

addonVersion: string
clientRequestToken: string
clusterName: string
clusterRef: 
  from: 
    name: string
configurationValues: string
name: string
resolveConflicts: string
serviceAccountRoleARN: string
serviceAccountRoleRef: 
  from: 
    name: string
tags: {}
FieldDescription
addonVersion
Optional
string
The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html).
clientRequestToken
Optional
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
clusterName
Optional
string
The name of the cluster to create the add-on for.
clusterRef
Optional
object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:
from: name: my-api
clusterRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
clusterRef.from.name
Optional
string
configurationValues
Optional
string
The set of configuration values for the add-on that’s created. The values that you provide are validated against the schema in DescribeAddonConfiguration (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html).
name
Required
string
The name of the add-on. The name must match one of the names that DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) returns.
resolveConflicts
Optional
string
How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:
* None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn’t change the value. Creation of the add-on might fail.
* Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.
* Preserve – Not supported. You can set this value when updating an add-on though. For more information, see UpdateAddon (https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html).
If you don’t currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.
serviceAccountRoleARN
Optional
string
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on’s service account. The role must be assigned the IAM permissions required by the add-on. If you don’t specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the Amazon EKS User Guide.
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster (https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) in the Amazon EKS User Guide.
serviceAccountRoleRef
Optional
object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:
from: name: my-api
serviceAccountRoleRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
serviceAccountRoleRef.from.name
Optional
string
tags
Optional
object
The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdAt: string
health: 
  issues:
  - code: string
    message: string
    resourceIDs:
    - string
marketplaceInformation: 
  productID: string
  productURL: string
modifiedAt: string
owner: string
publisher: string
status: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn
Optional
string
ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required
string
OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region
Required
string
Region is the AWS region in which the resource exists or will exist.
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[]
Required
object
Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource
conditions.[].message
Optional
string
A human readable message indicating details about the transition.
conditions.[].reason
Optional
string
The reason for the condition’s last transition.
conditions.[].status
Optional
string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional
string
Type is the type of the Condition
createdAt
Optional
string
The date and time that the add-on was created.
health
Optional
object
An object that represents the health of the add-on.
health.issues
Optional
array
health.issues.[]
Required
object
An issue related to an add-on.
health.issues.[].message
Optional
string
health.issues.[].resourceIDs
Optional
array
health.issues.[].resourceIDs.[]
Required
string
marketplaceInformation.productID
Optional
string
marketplaceInformation.productURL
Optional
string
modifiedAt
Optional
string
The date and time that the add-on was last modified.
owner
Optional
string
The owner of the add-on.
publisher
Optional
string
The publisher of the add-on.
status
Optional
string
The status of the add-on.