@pulumi/harness 0.12.0-alpha.1776752434 → 0.12.0

package/chaos/actionTemplate.d.ts

@@ -0,0 +1,492 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as inputs from "../types/input";
+import * as outputs from "../types/output";
+/**
+ * Resource for managing Harness Chaos Action Templates. Action templates define reusable actions that can be used in chaos experiments.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as harness from "@pulumi/harness";
+ *
+ * // ============================================================================
+ * // Harness Chaos Action Template Resource Examples
+ * // ============================================================================
+ * //
+ * // Action templates define reusable actions for chaos experiments.
+ * // These examples are based on TESTED configurations from the e2e-test suite.
+ * //
+ * // Key Points:
+ * // - Actions can be delay, script, or container type
+ * // - Runtime inputs with defaults: "<+input>.default('value')"
+ * // - Container actions support full Kubernetes pod configuration
+ * // ============================================================================
+ * // ----------------------------------------------------------------------------
+ * // Example 1: Container Action with Runtime Inputs (TESTED ✅)
+ * // ----------------------------------------------------------------------------
+ * // Most common pattern: container action with runtime inputs and defaults
+ * const containerWithRuntimeInputs = new harness.chaos.ActionTemplate("container_with_runtime_inputs", {
+ *     orgId: _this.id,
+ *     projectId: thisHarnessPlatformProject.id,
+ *     hubIdentity: projectLevel.identity,
+ *     identity: "container-action-template",
+ *     name: "Container Action Template",
+ *     description: "Container action with runtime inputs and defaults",
+ *     type: "container",
+ *     infrastructureType: "<+input>.default('Kubernetes')",
+ *     tags: [
+ *         "container",
+ *         "kubernetes",
+ *         "runtime-inputs",
+ *     ],
+ *     containerAction: {
+ *         image: "<+input>.default('busybox:latest')",
+ *         commands: ["<+input>.default('sh')"],
+ *         args: "echo 'Running container action'; sleep 15",
+ *         namespace: "<+input>.default('default')",
+ *         nodeSelector: {
+ *             disktype: "ssd",
+ *             zone: "us-west-1a",
+ *         },
+ *         labels: {
+ *             app: "chaos-action",
+ *             environment: "production",
+ *             "managed-by": "terraform",
+ *         },
+ *         annotations: {
+ *             description: "Chaos container action",
+ *             owner: "chaos-team",
+ *         },
+ *         envs: [
+ *             {
+ *                 name: "TEST_VAR",
+ *                 value: "<+input>.default('test_value')",
+ *             },
+ *             {
+ *                 name: "ANOTHER_VAR",
+ *                 value: "<+input>.default('another_value')",
+ *             },
+ *         ],
+ *         resources: {
+ *             limits: {
+ *                 cpu: "500m",
+ *                 memory: "512Mi",
+ *             },
+ *             requests: {
+ *                 cpu: "250m",
+ *                 memory: "256Mi",
+ *             },
+ *         },
+ *     },
+ *     runProperties: {
+ *         timeout: "<+input>.default('60s')",
+ *         interval: "<+input>.default('15s')",
+ *     },
+ *     variables: [
+ *         {
+ *             name: "container_image",
+ *             value: "<+input>",
+ *             type: "string",
+ *             required: true,
+ *             description: "Container image to use (runtime input)",
+ *         },
+ *         {
+ *             name: "namespace",
+ *             value: "<+input>",
+ *             type: "string",
+ *             required: false,
+ *             description: "Kubernetes namespace (runtime input)",
+ *         },
+ *     ],
+ * }, {
+ *     dependsOn: [projectLevel],
+ * });
+ * // ----------------------------------------------------------------------------
+ * // Example 2: Simple Delay Action (TESTED ✅)
+ * // ----------------------------------------------------------------------------
+ * // Delay action for adding wait time in experiments
+ * const delayAction = new harness.chaos.ActionTemplate("delay_action", {
+ *     orgId: _this.id,
+ *     projectId: thisHarnessPlatformProject.id,
+ *     hubIdentity: projectLevel.identity,
+ *     identity: "delay-action-template",
+ *     name: "Delay Action Template",
+ *     description: "Simple delay action for wait time",
+ *     type: "delay",
+ *     infrastructureType: "Kubernetes",
+ *     tags: [
+ *         "delay",
+ *         "wait",
+ *     ],
+ *     delayAction: {
+ *         duration: "<+input>.default('30s')",
+ *     },
+ *     runProperties: {
+ *         timeout: "60s",
+ *     },
+ * }, {
+ *     dependsOn: [projectLevel],
+ * });
+ * // ----------------------------------------------------------------------------
+ * // Example 3: Script Action (TESTED ✅)
+ * // ----------------------------------------------------------------------------
+ * // Custom script action for flexible operations
+ * const scriptAction = new harness.chaos.ActionTemplate("script_action", {
+ *     orgId: _this.id,
+ *     projectId: thisHarnessPlatformProject.id,
+ *     hubIdentity: projectLevel.identity,
+ *     identity: "script-action-template",
+ *     name: "Script Action Template",
+ *     description: "Custom script action for chaos operations",
+ *     type: "script",
+ *     infrastructureType: "<+input>.default('Kubernetes')",
+ *     tags: [
+ *         "script",
+ *         "custom",
+ *     ],
+ *     customScriptAction: {
+ *         script: `#!/bin/bash
+ * echo \\"Running custom chaos script\\"
+ * echo \\"Target: <+input>\\"
+ * sleep 10
+ * echo \\"Script completed\\"
+ * `,
+ *         shell: "bash",
+ *         envs: [{
+ *             name: "TARGET",
+ *             value: "<+input>.default('default-target')",
+ *         }],
+ *     },
+ *     runProperties: {
+ *         timeout: "<+input>.default('120s')",
+ *         interval: "30s",
+ *     },
+ *     variables: [{
+ *         name: "target_resource",
+ *         value: "<+input>",
+ *         type: "string",
+ *         required: true,
+ *         description: "Target resource for the script",
+ *     }],
+ * }, {
+ *     dependsOn: [projectLevel],
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * The `pulumi import` command can be used, for example:
+ *
+ * Example 1: Import Project-level Action Template
+ * Format: org_id/project_id/hub_identity/template_identity
+ *
+ * ```sh
+ * $ pulumi import harness:chaos/actionTemplate:ActionTemplate example my_org/my_project/my-chaos-hub/delay-action-template
+ * ```
+ *
+ * Example 2: Import Org-level Action Template
+ * Format: org_id/hub_identity/template_identity
+ *
+ * ```sh
+ * $ pulumi import harness:chaos/actionTemplate:ActionTemplate org_example my_org/org-chaos-hub/org-script-action
+ * ```
+ *
+ * Example 3: Import Account-level Action Template
+ * Format: hub_identity/template_identity
+ *
+ * ```sh
+ * $ pulumi import harness:chaos/actionTemplate:ActionTemplate account_example account-chaos-hub/account-delay-action
+ * ```
+ */
+export declare class ActionTemplate extends pulumi.CustomResource {
+    /**
+     * Get an existing ActionTemplate 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?: ActionTemplateState, opts?: pulumi.CustomResourceOptions): ActionTemplate;
+    /**
+     * Returns true if the given object is an instance of ActionTemplate.  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 ActionTemplate;
+    /**
+     * Account identifier.
+     */
+    readonly accountId: pulumi.Output<string>;
+    /**
+     * Container action configuration. Required when type is 'container'.
+     */
+    readonly containerAction: pulumi.Output<outputs.chaos.ActionTemplateContainerAction | undefined>;
+    /**
+     * Creation timestamp (Unix epoch).
+     */
+    readonly createdAt: pulumi.Output<number>;
+    /**
+     * User who created the action template.
+     */
+    readonly createdBy: pulumi.Output<string>;
+    /**
+     * Custom script action configuration. Required when type is 'customScript'.
+     */
+    readonly customScriptAction: pulumi.Output<outputs.chaos.ActionTemplateCustomScriptAction | undefined>;
+    /**
+     * Delay action configuration. Required when type is 'delay'.
+     */
+    readonly delayAction: pulumi.Output<outputs.chaos.ActionTemplateDelayAction | undefined>;
+    /**
+     * Description of the action template.
+     */
+    readonly description: pulumi.Output<string | undefined>;
+    /**
+     * Identity of the chaos hub this action template belongs to.
+     */
+    readonly hubIdentity: pulumi.Output<string>;
+    /**
+     * Internal ID of the action template.
+     */
+    readonly idInternal: pulumi.Output<string>;
+    /**
+     * Unique identifier for the action template (immutable).
+     */
+    readonly identity: pulumi.Output<string>;
+    /**
+     * Infrastructure type for the action template. Valid values: Kubernetes, KubernetesV2, Windows, Linux, CloudFoundry, Container. Supports runtime inputs like <+input>.
+     */
+    readonly infrastructureType: pulumi.Output<string | undefined>;
+    /**
+     * Whether this is the default version for predefined actions.
+     */
+    readonly isDefault: pulumi.Output<boolean>;
+    /**
+     * Whether this is an enterprise action template.
+     */
+    readonly isEnterprise: pulumi.Output<boolean>;
+    /**
+     * Whether the action template has been removed.
+     */
+    readonly isRemoved: pulumi.Output<boolean>;
+    /**
+     * Name of the action template.
+     */
+    readonly name: pulumi.Output<string>;
+    /**
+     * Organization identifier.
+     */
+    readonly orgId: pulumi.Output<string | undefined>;
+    /**
+     * Project identifier.
+     */
+    readonly projectId: pulumi.Output<string | undefined>;
+    /**
+     * Revision number of the action template.
+     */
+    readonly revision: pulumi.Output<number>;
+    /**
+     * Run properties for the action template execution.
+     */
+    readonly runProperties: pulumi.Output<outputs.chaos.ActionTemplateRunProperties | undefined>;
+    /**
+     * Tags to associate with the action template.
+     */
+    readonly tags: pulumi.Output<string[] | undefined>;
+    /**
+     * Template content/definition.
+     */
+    readonly template: pulumi.Output<string>;
+    /**
+     * Type of the action template. Valid values: delay, customScript, container.
+     */
+    readonly type: pulumi.Output<string>;
+    /**
+     * Last update timestamp (Unix epoch).
+     */
+    readonly updatedAt: pulumi.Output<number>;
+    /**
+     * User who last updated the action template.
+     */
+    readonly updatedBy: pulumi.Output<string>;
+    /**
+     * Template variables that can be used in the action.
+     */
+    readonly variables: pulumi.Output<outputs.chaos.ActionTemplateVariable[] | undefined>;
+    /**
+     * Create a ActionTemplate 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: ActionTemplateArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * Input properties used for looking up and filtering ActionTemplate resources.
+ */
+export interface ActionTemplateState {
+    /**
+     * Account identifier.
+     */
+    accountId?: pulumi.Input<string>;
+    /**
+     * Container action configuration. Required when type is 'container'.
+     */
+    containerAction?: pulumi.Input<inputs.chaos.ActionTemplateContainerAction>;
+    /**
+     * Creation timestamp (Unix epoch).
+     */
+    createdAt?: pulumi.Input<number>;
+    /**
+     * User who created the action template.
+     */
+    createdBy?: pulumi.Input<string>;
+    /**
+     * Custom script action configuration. Required when type is 'customScript'.
+     */
+    customScriptAction?: pulumi.Input<inputs.chaos.ActionTemplateCustomScriptAction>;
+    /**
+     * Delay action configuration. Required when type is 'delay'.
+     */
+    delayAction?: pulumi.Input<inputs.chaos.ActionTemplateDelayAction>;
+    /**
+     * Description of the action template.
+     */
+    description?: pulumi.Input<string>;
+    /**
+     * Identity of the chaos hub this action template belongs to.
+     */
+    hubIdentity?: pulumi.Input<string>;
+    /**
+     * Internal ID of the action template.
+     */
+    idInternal?: pulumi.Input<string>;
+    /**
+     * Unique identifier for the action template (immutable).
+     */
+    identity?: pulumi.Input<string>;
+    /**
+     * Infrastructure type for the action template. Valid values: Kubernetes, KubernetesV2, Windows, Linux, CloudFoundry, Container. Supports runtime inputs like <+input>.
+     */
+    infrastructureType?: pulumi.Input<string>;
+    /**
+     * Whether this is the default version for predefined actions.
+     */
+    isDefault?: pulumi.Input<boolean>;
+    /**
+     * Whether this is an enterprise action template.
+     */
+    isEnterprise?: pulumi.Input<boolean>;
+    /**
+     * Whether the action template has been removed.
+     */
+    isRemoved?: pulumi.Input<boolean>;
+    /**
+     * Name of the action template.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * Organization identifier.
+     */
+    orgId?: pulumi.Input<string>;
+    /**
+     * Project identifier.
+     */
+    projectId?: pulumi.Input<string>;
+    /**
+     * Revision number of the action template.
+     */
+    revision?: pulumi.Input<number>;
+    /**
+     * Run properties for the action template execution.
+     */
+    runProperties?: pulumi.Input<inputs.chaos.ActionTemplateRunProperties>;
+    /**
+     * Tags to associate with the action template.
+     */
+    tags?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Template content/definition.
+     */
+    template?: pulumi.Input<string>;
+    /**
+     * Type of the action template. Valid values: delay, customScript, container.
+     */
+    type?: pulumi.Input<string>;
+    /**
+     * Last update timestamp (Unix epoch).
+     */
+    updatedAt?: pulumi.Input<number>;
+    /**
+     * User who last updated the action template.
+     */
+    updatedBy?: pulumi.Input<string>;
+    /**
+     * Template variables that can be used in the action.
+     */
+    variables?: pulumi.Input<pulumi.Input<inputs.chaos.ActionTemplateVariable>[]>;
+}
+/**
+ * The set of arguments for constructing a ActionTemplate resource.
+ */
+export interface ActionTemplateArgs {
+    /**
+     * Container action configuration. Required when type is 'container'.
+     */
+    containerAction?: pulumi.Input<inputs.chaos.ActionTemplateContainerAction>;
+    /**
+     * Custom script action configuration. Required when type is 'customScript'.
+     */
+    customScriptAction?: pulumi.Input<inputs.chaos.ActionTemplateCustomScriptAction>;
+    /**
+     * Delay action configuration. Required when type is 'delay'.
+     */
+    delayAction?: pulumi.Input<inputs.chaos.ActionTemplateDelayAction>;
+    /**
+     * Description of the action template.
+     */
+    description?: pulumi.Input<string>;
+    /**
+     * Identity of the chaos hub this action template belongs to.
+     */
+    hubIdentity: pulumi.Input<string>;
+    /**
+     * Unique identifier for the action template (immutable).
+     */
+    identity: pulumi.Input<string>;
+    /**
+     * Infrastructure type for the action template. Valid values: Kubernetes, KubernetesV2, Windows, Linux, CloudFoundry, Container. Supports runtime inputs like <+input>.
+     */
+    infrastructureType?: pulumi.Input<string>;
+    /**
+     * Name of the action template.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * Organization identifier.
+     */
+    orgId?: pulumi.Input<string>;
+    /**
+     * Project identifier.
+     */
+    projectId?: pulumi.Input<string>;
+    /**
+     * Run properties for the action template execution.
+     */
+    runProperties?: pulumi.Input<inputs.chaos.ActionTemplateRunProperties>;
+    /**
+     * Tags to associate with the action template.
+     */
+    tags?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Type of the action template. Valid values: delay, customScript, container.
+     */
+    type: pulumi.Input<string>;
+    /**
+     * Template variables that can be used in the action.
+     */
+    variables?: pulumi.Input<pulumi.Input<inputs.chaos.ActionTemplateVariable>[]>;
+}