@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
139 lines (138 loc) • 4.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating a Kubernetes service. This resource uses the config-as-code API's. When updating the `name` or `path` of this resource you should typically also set the `createBeforeDestroy = true` lifecycle setting.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const example = new harness.Application("example", {name: "example"});
* const exampleKubernetes = new harness.service.Kubernetes("example", {
* appId: example.id,
* name: "k8s-svc",
* helmVersion: "V3",
* description: "Service for deploying Kubernetes manifests",
* variables: [
* {
* name: "test",
* value: "test_value",
* type: "TEXT",
* },
* {
* name: "test2",
* value: "test_value2",
* type: "TEXT",
* },
* ],
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import using the Harness application id and service id
*
* ```sh
* $ pulumi import harness:service/kubernetes:Kubernetes example <app_id>/<svc_id>
* ```
*/
export declare class Kubernetes extends pulumi.CustomResource {
/**
* Get an existing Kubernetes resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KubernetesState, opts?: pulumi.CustomResourceOptions): Kubernetes;
/**
* Returns true if the given object is an instance of Kubernetes. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Kubernetes;
/**
* The id of the application the service belongs to
*/
readonly appId: pulumi.Output<string>;
/**
* Description of th service
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The version of Helm to use. Options are `V2` and `V3`. Defaults to 'V2'. Only used when `type` is `KUBERNETES` or `HELM`.
*/
readonly helmVersion: pulumi.Output<string | undefined>;
/**
* Name of the service
*/
readonly name: pulumi.Output<string>;
/**
* Variables to be used in the service
*/
readonly variables: pulumi.Output<outputs.service.KubernetesVariable[] | undefined>;
/**
* Create a Kubernetes 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: string, args: KubernetesArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Kubernetes resources.
*/
export interface KubernetesState {
/**
* The id of the application the service belongs to
*/
appId?: pulumi.Input<string>;
/**
* Description of th service
*/
description?: pulumi.Input<string>;
/**
* The version of Helm to use. Options are `V2` and `V3`. Defaults to 'V2'. Only used when `type` is `KUBERNETES` or `HELM`.
*/
helmVersion?: pulumi.Input<string>;
/**
* Name of the service
*/
name?: pulumi.Input<string>;
/**
* Variables to be used in the service
*/
variables?: pulumi.Input<pulumi.Input<inputs.service.KubernetesVariable>[]>;
}
/**
* The set of arguments for constructing a Kubernetes resource.
*/
export interface KubernetesArgs {
/**
* The id of the application the service belongs to
*/
appId: pulumi.Input<string>;
/**
* Description of th service
*/
description?: pulumi.Input<string>;
/**
* The version of Helm to use. Options are `V2` and `V3`. Defaults to 'V2'. Only used when `type` is `KUBERNETES` or `HELM`.
*/
helmVersion?: pulumi.Input<string>;
/**
* Name of the service
*/
name?: pulumi.Input<string>;
/**
* Variables to be used in the service
*/
variables?: pulumi.Input<pulumi.Input<inputs.service.KubernetesVariable>[]>;
}