interface KubernetesManifestProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EKS.KubernetesManifestProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awseks#KubernetesManifestProps |
![]() | software.amazon.awscdk.services.eks.KubernetesManifestProps |
![]() | aws_cdk.aws_eks.KubernetesManifestProps |
![]() | aws-cdk-lib » aws_eks » KubernetesManifestProps |
Properties for KubernetesManifest.
Example
declare const cluster: eks.Cluster;
const appLabel = { app: "hello-kubernetes" };
const deployment = {
apiVersion: "apps/v1",
kind: "Deployment",
metadata: { name: "hello-kubernetes" },
spec: {
replicas: 3,
selector: { matchLabels: appLabel },
template: {
metadata: { labels: appLabel },
spec: {
containers: [
{
name: "hello-kubernetes",
image: "paulbouwer/hello-kubernetes:1.5",
ports: [ { containerPort: 8080 } ],
},
],
},
},
},
};
const service = {
apiVersion: "v1",
kind: "Service",
metadata: { name: "hello-kubernetes" },
spec: {
type: "LoadBalancer",
ports: [ { port: 80, targetPort: 8080 } ],
selector: appLabel,
}
};
// option 1: use a construct
new eks.KubernetesManifest(this, 'hello-kub', {
cluster,
manifest: [ deployment, service ],
});
// or, option2: use `addManifest`
cluster.addManifest('hello-kub', service, deployment);
Properties
Name | Type | Description |
---|---|---|
cluster | ICluster | The EKS cluster to apply this manifest to. |
manifest | { [string]: any }[] | The manifest to apply. |
ingress | boolean | Automatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller. |
ingress | Alb | Specify the ALB scheme that should be applied to Ingress resources. |
overwrite? | boolean | Overwrite any existing resources. |
prune? | boolean | 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. |
skip | boolean | A flag to signify if the manifest validation should be skipped. |
cluster
Type:
ICluster
The EKS cluster to apply this manifest to.
[disable-awslint:ref-via-interface]
manifest
Type:
{ [string]: any }[]
The manifest to apply.
Consists of any number of child resources.
When the resources are created/updated, this manifest will be applied to the
cluster through kubectl apply
and when the resources or the stack is
deleted, the resources in the manifest will be deleted through kubectl delete
.
Example
[{
apiVersion: 'v1',
kind: 'Pod',
metadata: { name: 'mypod' },
spec: {
containers: [ { name: 'hello', image: 'paulbouwer/hello-kubernetes:1.5', ports: [ { containerPort: 8080 } ] } ]
}
}]
ingressAlb?
Type:
boolean
(optional, default: false)
Automatically detect Ingress
resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.
ingressAlbScheme?
Type:
Alb
(optional, default: AlbScheme.INTERNAL)
Specify the ALB scheme that should be applied to Ingress
resources.
Only applicable if ingressAlb
is set to true
.
overwrite?
Type:
boolean
(optional, default: false)
Overwrite any existing resources.
If this is set, we will use kubectl apply
instead of kubectl create
when the resource is created. Otherwise, if there is already a resource
in the cluster with the same name, the operation will fail.
prune?
Type:
boolean
(optional, default: based on the prune option of the cluster, which is true
unless
otherwise specified.)
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.
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.
skipValidation?
Type:
boolean
(optional, default: false)
A flag to signify if the manifest validation should be skipped.