KubernetesManifestProps Struct
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
[disable-awslint:ref-via-interface]
ingressAlboptionalbooleaningress_alboptionalboolingressAlboptionalBooleanIngressAlboptionalboolIngressAlboptional*bool= false#ingressAlbSchemeoptionalAlbSchemeingress_alb_schemeoptionalAlbSchemeingressAlbSchemeoptionalAlbSchemeIngressAlbSchemeoptionalAlbSchemeIngressAlbSchemeoptionalAlbScheme= AlbScheme.INTERNAL#Only applicable if ingressAlb is set to true.
manifest{ [key: string]: any }[]manifesttyping.List[typing.Mapping[str, Any]]manifestList<Map<String, Object>>ManifestIDictionary<string, object>[]Manifest*[]*map[string]interface{}required#notes · example
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.
[{
apiVersion: 'v1',
kind: 'Pod',
metadata: { name: 'mypod' },
spec: {
containers: [ { name: 'hello', image: 'paulbouwer/hello-kubernetes:1.5', ports: [ { containerPort: 8080 } ] } ]
}
}]
overwriteoptionalbooleanoverwriteoptionalbooloverwriteoptionalBooleanOverwriteoptionalboolOverwriteoptional*bool= false#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.
Default: based on the prune option of the cluster, which is true unless otherwise specified.
notes
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.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#notes
The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:
- The resource is removed from the template, so CloudFormation stops managing it
- A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
- The stack is deleted, so CloudFormation stops managing all resources in it
skipValidationoptionalbooleanskip_validationoptionalboolskipValidationoptionalBooleanSkipValidationoptionalboolSkipValidationoptional*bool= false#