Skip to content

API Reference

Packages

node.eks.aws/v1alpha1

Resource Types

ClusterDetails

ClusterDetails contains the coordinates of your EKS cluster. These details can be found using the DescribeCluster API.

Appears in: - NodeConfigSpec

Field Description
name string Name is the name of your EKS cluster
apiServerEndpoint string APIServerEndpoint is the URL of your EKS cluster's kube-apiserver.
certificateAuthority integer array CertificateAuthority is a base64-encoded string of your cluster's certificate authority chain.
cidr string CIDR is your cluster's service CIDR block. This value is used to infer your cluster's DNS address.
enableOutpost boolean EnableOutpost determines how your node is configured when running on an AWS Outpost.
id string ID is an identifier for your cluster; this is only used when your node is running on an AWS Outpost.

ContainerdOptions

ContainerdOptions are additional parameters passed to containerd.

Appears in: - NodeConfigSpec

Field Description
config string Config is an inline containerd configuration TOML
that will be merged with the defaults.
baseRuntimeSpec object (keys:string, values:RawExtension) BaseRuntimeSpec is the OCI runtime specification upon which all containers will be based.
The provided spec will be merged with the default spec; so that a partial spec may be provided.
For more information, see: https://github.com/opencontainers/runtime-spec

DisabledMount

Underlying type: string

DisabledMount specifies a directory that should not be mounted onto local storage

  • Containerd refers to /var/lib/containerd
  • PodLogs refers to /var/log/pods

Appears in: - LocalStorageOptions

.Validation: - Enum: [Containerd PodLogs]

EnvironmentOptions

Underlying type: object

EnvironmentOptions configures environment variables for the system and systemd services. The key default is reserved for configuring the environment across all services on the instance The key can be set to a systemd service name to configure environment only for a particular service.

Appears in: - InstanceOptions

Feature

Underlying type: string

Feature specifies which feature gate should be toggled

Appears in: - NodeConfigSpec

.Validation: - Enum: [InstanceIdNodeName FastImagePull]

InstanceOptions

InstanceOptions determines how the node's operating system and devices are configured.

Appears in: - NodeConfigSpec

Field Description
localStorage LocalStorageOptions
environment EnvironmentOptions

KubeletOptions

KubeletOptions are additional parameters passed to kubelet.

Appears in: - NodeConfigSpec

Field Description
config object (keys:string, values:RawExtension) Config is a KubeletConfiguration
that will be merged with the defaults.
flags string array Flags are command-line kubelet arguments.
that will be appended to the defaults.
maxPodsExpression string MaxPodsExpression is a CEL expression used to compute a max pods value for
the kubelet configuration. Any MaxPods value set in Config takes precedence
over the result of this expression. If the expression is successfully evaluated,
kubeReserved will always be calculated on its result.

LocalStorageOptions

LocalStorageOptions control how EC2 instance stores are used when available.

Appears in: - InstanceOptions

Field Description
strategy LocalStorageStrategy
mountPath string MountPath is the path where the filesystem will be mounted.
Defaults to /mnt/k8s-disks/.
disabledMounts DisabledMount array List of directories that will not be mounted to LocalStorage. By default,
all mounts are enabled.

LocalStorageStrategy

Underlying type: string

LocalStorageStrategy specifies how to handle an instance's local storage devices.

Appears in: - LocalStorageOptions

.Validation: - Enum: [RAID0 RAID10 Mount]

NodeConfig

NodeConfig is the primary configuration object for nodeadm.

Field Description
apiVersion string node.eks.aws/v1alpha1
kind string NodeConfig
kind string 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
apiVersion string 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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec NodeConfigSpec

NodeConfigSpec

Appears in: - NodeConfig

Field Description
cluster ClusterDetails
containerd ContainerdOptions
instance InstanceOptions
kubelet KubeletOptions
featureGates object (keys:Feature, values:boolean) FeatureGates holds key-value pairs to enable or disable application features.