Interface IKubernetesManifestOptions
Options for KubernetesManifest
.
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.AWS.EKS.dll
Syntax (csharp)
public interface IKubernetesManifestOptions
Syntax (vb)
Public Interface IKubernetesManifestOptions
Remarks
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;
var kubernetesManifestOptions = new KubernetesManifestOptions {
IngressAlb = false,
IngressAlbScheme = AlbScheme.INTERNAL,
Prune = false,
SkipValidation = false
};
Synopsis
Properties
IngressAlb | Automatically detect |
IngressAlbScheme | Specify the ALB scheme that should be applied to |
Prune | 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 | A flag to signify if the manifest validation should be skipped. |
Properties
IngressAlb
Automatically detect Ingress
resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.
virtual Nullable<bool> IngressAlb { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
IngressAlbScheme
Specify the ALB scheme that should be applied to Ingress
resources.
virtual Nullable<AlbScheme> IngressAlbScheme { get; }
Property Value
System.Nullable<AlbScheme>
Remarks
Only applicable if ingressAlb
is set to true
.
Default: AlbScheme.INTERNAL
Prune
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.
virtual Nullable<bool> Prune { get; }
Property Value
System.Nullable<System.Boolean>
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.
SkipValidation
A flag to signify if the manifest validation should be skipped.
virtual Nullable<bool> SkipValidation { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false