@pulumi/kubernetes
Version:
[](https://travis-ci.com/pulumi/pulumi-kubernetes) [](https://slack.pulumi.com) [![NPM
143 lines • 5.55 kB
JavaScript
;
// *** WARNING: this file was generated by pulumigen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConfigGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../../utilities");
/**
* ConfigGroup creates a set of Kubernetes resources from Kubernetes YAML text. The YAML text
* may be supplied using any of the following methods:
*
* 1. Using a filename or a list of filenames:
* 2. Using a file pattern or a list of file patterns:
* 3. Using a literal string containing YAML, or a list of such strings:
* 4. Any combination of files, patterns, or YAML strings:
*
* ## Dependency ordering
* Sometimes resources must be applied in a specific order. For example, a namespace resource must be
* created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.
*
* Pulumi uses heuristics to determine which order to apply and delete objects within the ConfigGroup. Pulumi also
* waits for each object to be fully reconciled, unless `skipAwait` is enabled.
*
* ### Explicit Dependency Ordering
* Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource.
* The annotation accepts a list of resource references, delimited by commas.
*
* Note that references to resources outside the ConfigGroup aren't supported.
*
* **Resource reference**
*
* A resource reference is a string that uniquely identifies a resource.
*
* It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.
*
* | Resource Scope | Format |
* | :--------------- | :--------------------------------------------- |
* | namespace-scoped | `<group>/namespaces/<namespace>/<kind>/<name>` |
* | cluster-scoped | `<group>/<kind>/<name>` |
*
* For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).
*
* ### Ordering across ConfigGroups
* The `dependsOn` resource option creates a list of explicit dependencies between Pulumi resources.
* Use it on another resource to make it dependent on the ConfigGroup and to wait for the resources within
* the group to be deployed.
*
* A best practice is to deploy each application using its own ConfigGroup, especially when that application
* installs custom resource definitions.
*
* ## Example Usage
* ### Local File(s)
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
*
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* files: ["./manifest.yaml"],
* });
* ```
* ### Local File Pattern
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
*
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* files: ["./manifests/*.yaml"],
* });
* ```
* {{% /example %}}
* ### Literal YAML String
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
*
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* yaml: `
* apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* `
* });
* ```
* ### Literal Object
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
*
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* objs: [
* {
* apiVersion: "v1",
* kind: "ConfigMap",
* metadata: {
* name: "my-map"
* }
* }
* ]
* });
* ```
* {% /examples %}}
*/
class ConfigGroup extends pulumi.ComponentResource {
/**
* Returns true if the given object is an instance of ConfigGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === ConfigGroup.__pulumiType;
}
/**
* Create a ConfigGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name, args, opts) {
let resourceInputs = {};
opts = opts || {};
if (!opts.id) {
resourceInputs["files"] = args ? args.files : undefined;
resourceInputs["objs"] = args ? args.objs : undefined;
resourceInputs["resourcePrefix"] = args ? args.resourcePrefix : undefined;
resourceInputs["skipAwait"] = args ? args.skipAwait : undefined;
resourceInputs["yaml"] = args ? args.yaml : undefined;
resourceInputs["resources"] = undefined /*out*/;
}
else {
resourceInputs["resources"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ConfigGroup.__pulumiType, name, resourceInputs, opts, true /*remote*/);
}
}
exports.ConfigGroup = ConfigGroup;
/** @internal */
ConfigGroup.__pulumiType = 'kubernetes:yaml/v2:ConfigGroup';
//# sourceMappingURL=configGroup.js.map