Class BootstrapOptions

EKS node bootstrapping options.

Inheritance

object

BootstrapOptions

Implements

IBootstrapOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EKS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class BootstrapOptions : IBootstrapOptions

Syntax (vb)

Public Class BootstrapOptions Implements IBootstrapOptions

Remarks

ExampleMetadata: infused

Examples

Cluster cluster;

            cluster.AddAutoScalingGroupCapacity("spot", new AutoScalingGroupCapacityOptions {
                InstanceType = new InstanceType("t3.large"),
                MinCapacity = 2,
                BootstrapOptions = new BootstrapOptions {
                    KubeletExtraArgs = "--node-labels foo=bar,goo=far",
                    AwsApiRetryAttempts = 5
                }
            });

Synopsis

Constructors

BootstrapOptions()

EKS node bootstrapping options.

Properties

AdditionalArgs	Additional command line arguments to pass to the `/etc/eks/bootstrap.sh` command.
AwsApiRetryAttempts	Number of retry attempts for AWS API call (DescribeCluster).
DnsClusterIp	Overrides the IP address to use for DNS queries within the cluster.
DockerConfigJson	The contents of the `/etc/docker/daemon.json` file. Useful if you want a custom config differing from the default one in the EKS AMI.
EnableDockerBridge	Restores the docker default bridge network.
KubeletExtraArgs	Extra arguments to add to the kubelet. Useful for adding labels or taints.
UseMaxPods	Sets `--max-pods` for the kubelet based on the capacity of the EC2 instance.

Constructors

BootstrapOptions()

EKS node bootstrapping options.

public BootstrapOptions()

Remarks

ExampleMetadata: infused

Examples

Cluster cluster;

            cluster.AddAutoScalingGroupCapacity("spot", new AutoScalingGroupCapacityOptions {
                InstanceType = new InstanceType("t3.large"),
                MinCapacity = 2,
                BootstrapOptions = new BootstrapOptions {
                    KubeletExtraArgs = "--node-labels foo=bar,goo=far",
                    AwsApiRetryAttempts = 5
                }
            });

Properties

AdditionalArgs

Additional command line arguments to pass to the /etc/eks/bootstrap.sh command.

public string? AdditionalArgs { get; set; }

Property Value

string

Remarks

Default: - none

See: https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh

AwsApiRetryAttempts

Number of retry attempts for AWS API call (DescribeCluster).

public double? AwsApiRetryAttempts { get; set; }

Property Value

double?

Remarks

Default: 3

DnsClusterIp

Overrides the IP address to use for DNS queries within the cluster.

public string? DnsClusterIp { get; set; }

Property Value

string

Remarks

Default: - 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface.

DockerConfigJson

The contents of the /etc/docker/daemon.json file. Useful if you want a custom config differing from the default one in the EKS AMI.

public string? DockerConfigJson { get; set; }

Property Value

string

Remarks

Default: - none

EnableDockerBridge

Restores the docker default bridge network.

public bool? EnableDockerBridge { get; set; }

Property Value

bool?

Remarks

Default: false

KubeletExtraArgs

Extra arguments to add to the kubelet. Useful for adding labels or taints.

public string? KubeletExtraArgs { get; set; }

Property Value

string

Remarks

For example, --node-labels foo=bar,goo=far.

Default: - none

UseMaxPods

Sets --max-pods for the kubelet based on the capacity of the EC2 instance.

public bool? UseMaxPods { get; set; }

Property Value

bool?

Remarks

Default: true

Implements

IBootstrapOptions