Interface IKubernetesManifestOptions

(experimental) Options for KubernetesManifest.

Namespace: Amazon.CDK.AWS.Eks.V2.Alpha

Assembly: Amazon.CDK.AWS.Eks.V2.Alpha.dll

Syntax (csharp)

public interface IKubernetesManifestOptions

Syntax (vb)

Public Interface IKubernetesManifestOptions

Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Eks.V2.Alpha;

             var kubernetesManifestOptions = new KubernetesManifestOptions {
                 IngressAlb = false,
                 IngressAlbScheme = AlbScheme.INTERNAL,
                 Prune = false,
                 SkipValidation = false
             };

Synopsis

Properties

IngressAlb	(experimental) Automatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.
IngressAlbScheme	(experimental) Specify the ALB scheme that should be applied to Ingress resources.
Prune	(experimental) When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted.
SkipValidation	(experimental) A flag to signify if the manifest validation should be skipped.

Properties

IngressAlb

(experimental) Automatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.

bool? IngressAlb { get; }

Property Value

bool?

Remarks

Default: false

Stability: Experimental

IngressAlbScheme

(experimental) Specify the ALB scheme that should be applied to Ingress resources.

AlbScheme? IngressAlbScheme { get; }

Property Value

AlbScheme?

Remarks

Only applicable if ingressAlb is set to true.

Default: AlbScheme.INTERNAL

Stability: Experimental

Prune

(experimental) When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted.

bool? Prune { get; }

Property Value

bool?

Remarks

To address this, kubectl apply has a --prune option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become "orphaned" and will not be deleted from the cluster.

When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via kubectl apply --prune.

The label name will be aws.cdk.eks/prune-<ADDR> where <ADDR> is the 42-char unique address of this construct in the construct tree. Value is empty.

Default: - based on the prune option of the cluster, which is true unless otherwise specified.

Stability: Experimental

See: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label

SkipValidation

(experimental) A flag to signify if the manifest validation should be skipped.

bool? SkipValidation { get; }

Property Value

bool?

Remarks

Default: false

Stability: Experimental