UNPKG

1.25 kBTypeScriptView Raw
1import { ExtensionPack } from "@atomist/sdm";
2/**
3 * Configuration options to be passed to the extension pack creation.
4 */
5export interface SdmPackK8sOptions {
6 /**
7 * Whether to add the undelete command. Typically you would only
8 * want to enable this in one SDM per workspace. If no value is
9 * provided, the comand is not added.
10 */
11 addCommands?: boolean;
12}
13/**
14 * Register Kubernetes deployment support for provided goals. Any
15 * provided `options` are merged with any found in the SDM
16 * configuration at `sdm.k8s.options`, i.e.,
17 * `sdm.configuration.sdm.k8s.options` if accessing from the SDM
18 * object, with those passed in taking precedence.
19 *
20 * If the merged options result in a truthy `addCommands`, then the
21 * [[kubernetesUndeploy]] command is added to the SDM.
22 *
23 * The [[kubernetesDeployHandler]] event handler for this SDM is added
24 * to the SDM.
25 *
26 * The [[minikubeStartupListener]] is added to the SDM to assist
27 * running in local mode against a
28 * [minikube](https://kubernetes.io/docs/setup/minikube/) cluster.
29 *
30 * @param options SDM Pack K8s options, see [[SdmPackK8sOptions]].
31 * @returns SDM extension pack.
32 */
33export declare function k8sSupport(options?: SdmPackK8sOptions): ExtensionPack;