io.cloudshiftdev.awscdk.services.eks.KubernetesManifest.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.eks
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* Represents a manifest within the Kubernetes system.
*
* Alternatively, you can use `cluster.addManifest(resource[, resource, ...])`
* to define resources on this cluster.
*
* Applies/deletes the manifest using `kubectl`.
*
* Example:
*
* ```
* Cluster cluster;
* KubernetesManifest namespace = cluster.addManifest("my-namespace", Map.of(
* "apiVersion", "v1",
* "kind", "Namespace",
* "metadata", Map.of("name", "my-app")));
* KubernetesManifest service = cluster.addManifest("my-service", Map.of(
* "metadata", Map.of(
* "name", "myservice",
* "namespace", "my-app"),
* "spec", Map.of()));
* service.node.addDependency(namespace);
* ```
*/
public open class KubernetesManifest(
cdkObject: software.amazon.awscdk.services.eks.KubernetesManifest,
) : CloudshiftdevConstructsConstruct(cdkObject) {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: KubernetesManifestProps,
) :
this(software.amazon.awscdk.services.eks.KubernetesManifest(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(KubernetesManifestProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: KubernetesManifestProps.Builder.() -> Unit,
) : this(scope, id, KubernetesManifestProps(props)
)
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.eks.KubernetesManifest].
*/
@CdkDslMarker
public interface Builder {
/**
* The EKS cluster to apply this manifest to.
*
* [disable-awslint:ref-via-interface]
*
* @param cluster The EKS cluster to apply this manifest to.
*/
public fun cluster(cluster: ICluster)
/**
* Automatically detect `Ingress` resources in the manifest and annotate them so they are picked
* up by an ALB Ingress Controller.
*
* Default: false
*
* @param ingressAlb Automatically detect `Ingress` resources in the manifest and annotate them
* so they are picked up by an ALB Ingress Controller.
*/
public fun ingressAlb(ingressAlb: Boolean)
/**
* Specify the ALB scheme that should be applied to `Ingress` resources.
*
* Only applicable if `ingressAlb` is set to `true`.
*
* Default: AlbScheme.INTERNAL
*
* @param ingressAlbScheme Specify the ALB scheme that should be applied to `Ingress` resources.
*
*/
public fun ingressAlbScheme(ingressAlbScheme: AlbScheme)
/**
* 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:
*
* ```
* List.of(Map.of(
* "apiVersion", "v1",
* "kind", "Pod",
* "metadata", Map.of("name", "mypod"),
* "spec", Map.of(
* "containers", List.of(Map.of("name", "hello", "image", "paulbouwer/hello-kubernetes:1.5",
* "ports", List.of(Map.of("containerPort", 8080)))))));
* ```
*
* @param manifest The manifest to apply.
*/
public fun manifest(manifest: List>)
/**
* 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:
*
* ```
* List.of(Map.of(
* "apiVersion", "v1",
* "kind", "Pod",
* "metadata", Map.of("name", "mypod"),
* "spec", Map.of(
* "containers", List.of(Map.of("name", "hello", "image", "paulbouwer/hello-kubernetes:1.5",
* "ports", List.of(Map.of("containerPort", 8080)))))));
* ```
*
* @param manifest The manifest to apply.
*/
public fun manifest(vararg manifest: Map)
/**
* 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.
*
* Default: false
*
* @param overwrite Overwrite any existing resources.
*/
public fun overwrite(overwrite: 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.
*
* 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.
*
* [Documentation](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label)
* @param 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.
*/
public fun prune(prune: Boolean)
/**
* A flag to signify if the manifest validation should be skipped.
*
* Default: false
*
* @param skipValidation A flag to signify if the manifest validation should be skipped.
*/
public fun skipValidation(skipValidation: Boolean)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.eks.KubernetesManifest.Builder =
software.amazon.awscdk.services.eks.KubernetesManifest.Builder.create(scope, id)
/**
* The EKS cluster to apply this manifest to.
*
* [disable-awslint:ref-via-interface]
*
* @param cluster The EKS cluster to apply this manifest to.
*/
override fun cluster(cluster: ICluster) {
cdkBuilder.cluster(cluster.let(ICluster.Companion::unwrap))
}
/**
* Automatically detect `Ingress` resources in the manifest and annotate them so they are picked
* up by an ALB Ingress Controller.
*
* Default: false
*
* @param ingressAlb Automatically detect `Ingress` resources in the manifest and annotate them
* so they are picked up by an ALB Ingress Controller.
*/
override fun ingressAlb(ingressAlb: Boolean) {
cdkBuilder.ingressAlb(ingressAlb)
}
/**
* Specify the ALB scheme that should be applied to `Ingress` resources.
*
* Only applicable if `ingressAlb` is set to `true`.
*
* Default: AlbScheme.INTERNAL
*
* @param ingressAlbScheme Specify the ALB scheme that should be applied to `Ingress` resources.
*
*/
override fun ingressAlbScheme(ingressAlbScheme: AlbScheme) {
cdkBuilder.ingressAlbScheme(ingressAlbScheme.let(AlbScheme.Companion::unwrap))
}
/**
* 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:
*
* ```
* List.of(Map.of(
* "apiVersion", "v1",
* "kind", "Pod",
* "metadata", Map.of("name", "mypod"),
* "spec", Map.of(
* "containers", List.of(Map.of("name", "hello", "image", "paulbouwer/hello-kubernetes:1.5",
* "ports", List.of(Map.of("containerPort", 8080)))))));
* ```
*
* @param manifest The manifest to apply.
*/
override fun manifest(manifest: List>) {
cdkBuilder.manifest(manifest)
}
/**
* 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:
*
* ```
* List.of(Map.of(
* "apiVersion", "v1",
* "kind", "Pod",
* "metadata", Map.of("name", "mypod"),
* "spec", Map.of(
* "containers", List.of(Map.of("name", "hello", "image", "paulbouwer/hello-kubernetes:1.5",
* "ports", List.of(Map.of("containerPort", 8080)))))));
* ```
*
* @param manifest The manifest to apply.
*/
override fun manifest(vararg manifest: Map): Unit = manifest(manifest.toList())
/**
* 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.
*
* Default: false
*
* @param overwrite Overwrite any existing resources.
*/
override fun overwrite(overwrite: Boolean) {
cdkBuilder.overwrite(overwrite)
}
/**
* 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.
*
* Default: - based on the prune option of the cluster, which is `true` unless
* otherwise specified.
*
* [Documentation](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label)
* @param 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.
*/
override fun prune(prune: Boolean) {
cdkBuilder.prune(prune)
}
/**
* A flag to signify if the manifest validation should be skipped.
*
* Default: false
*
* @param skipValidation A flag to signify if the manifest validation should be skipped.
*/
override fun skipValidation(skipValidation: Boolean) {
cdkBuilder.skipValidation(skipValidation)
}
public fun build(): software.amazon.awscdk.services.eks.KubernetesManifest = cdkBuilder.build()
}
public companion object {
public val RESOURCE_TYPE: String =
software.amazon.awscdk.services.eks.KubernetesManifest.RESOURCE_TYPE
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): KubernetesManifest {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return KubernetesManifest(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.eks.KubernetesManifest):
KubernetesManifest = KubernetesManifest(cdkObject)
internal fun unwrap(wrapped: KubernetesManifest):
software.amazon.awscdk.services.eks.KubernetesManifest = wrapped.cdkObject as
software.amazon.awscdk.services.eks.KubernetesManifest
}
}