UNPKG

1.07 kBTypeScriptView Raw
1import { ExtensionPack } from "@atomist/sdm";
2import { SdmPackK8sOptions } from "./config";
3/**
4 * Register Kubernetes deployment support for provided goals. Any
5 * provided `options` are merged with any found in the SDM
6 * configuration at `sdm.k8s.options`, i.e.,
7 * `sdm.configuration.sdm.k8s.options` if accessing from the SDM
8 * object, with those passed in taking precedence.
9 *
10 * If the merged options result in a truthy `addCommands`, then the
11 * [[kubernetesUndeploy]] command is added to the SDM.
12 *
13 * The [[kubernetesDeployHandler]] event handler for this SDM is added
14 * to the SDM.
15 *
16 * If `sync.repo` is a valid repo ref, synchronizing Kubernetes
17 * resources with a Git repository is enabled.
18 *
19 * The [[minikubeStartupListener]] is added to the SDM to assist
20 * running in local mode against a
21 * [minikube](https://kubernetes.io/docs/setup/minikube/) cluster.
22 *
23 * @param options SDM Pack K8s options, see [[SdmPackK8sOptions]].
24 * @returns SDM extension pack.
25 */
26export declare function k8sSupport(options?: SdmPackK8sOptions): ExtensionPack;