UNPKG

1.14 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]] and [[kubernetesSync]] commands are added to
12 * the SDM with intents.
13 *
14 * The [[kubernetesDeployHandler]] event handler for this SDM is added
15 * to the SDM.
16 *
17 * If `sync.repo` is a valid repo ref, synchronizing Kubernetes
18 * resources with a Git repository is enabled.
19 *
20 * The [[minikubeStartupListener]] is added to the SDM to assist
21 * running in local mode against a
22 * [minikube](https://kubernetes.io/docs/setup/minikube/) cluster.
23 *
24 * @param options SDM Pack K8s options, see [[SdmPackK8sOptions]].
25 * @returns SDM extension pack.
26 */
27export declare function k8sSupport(options?: SdmPackK8sOptions): ExtensionPack;
28//# sourceMappingURL=k8s.d.ts.map
\No newline at end of file