Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

AppV2

Provides a Rancher App v2 resource. This can be used to manage helm charts for Rancher v2 environments and retrieve their information. App v2 resource is available at Rancher v2.5.x and above.

Example Usage

using System.IO;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new Rancher2 App V2 using
        var foo = new Rancher2.AppV2("foo", new Rancher2.AppV2Args
        {
            ClusterId = "<CLUSTER_ID>",
            Namespace = "cattle-monitoring-system",
            RepoName = "rancher-charts",
            ChartName = "rancher-monitoring",
            ChartVersion = "9.4.200",
            Values = File.ReadAllText("values.yaml"),
        });
    }

}

Coming soon!

import pulumi
import pulumi_rancher2 as rancher2

# Create a new Rancher2 App V2 using
foo = rancher2.AppV2("foo",
    cluster_id="<CLUSTER_ID>",
    namespace="cattle-monitoring-system",
    repo_name="rancher-charts",
    chart_name="rancher-monitoring",
    chart_version="9.4.200",
    values=(lambda path: open(path).read())("values.yaml"))
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
import * from "fs";

// Create a new Rancher2 App V2 using
const foo = new rancher2.AppV2("foo", {
    clusterId: "<CLUSTER_ID>",
    namespace: "cattle-monitoring-system",
    repoName: "rancher-charts",
    chartName: "rancher-monitoring",
    chartVersion: "9.4.200",
    values: fs.readFileSync("values.yaml"),
});

Create a AppV2 Resource

new AppV2(name: string, args: AppV2Args, opts?: CustomResourceOptions);
def AppV2(resource_name: str, opts: Optional[ResourceOptions] = None, annotations: Optional[Mapping[str, Any]] = None, chart_name: Optional[str] = None, chart_version: Optional[str] = None, cleanup_on_fail: Optional[bool] = None, cluster_id: Optional[str] = None, disable_hooks: Optional[bool] = None, disable_open_api_validation: Optional[bool] = None, force_upgrade: Optional[bool] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, namespace: Optional[str] = None, project_id: Optional[str] = None, repo_name: Optional[str] = None, values: Optional[str] = None, wait: Optional[bool] = None)
func NewAppV2(ctx *Context, name string, args AppV2Args, opts ...ResourceOption) (*AppV2, error)
public AppV2(string name, AppV2Args args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AppV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AppV2Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AppV2 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The AppV2 resource accepts the following input properties:

ChartName string

The app v2 chart name (string)

ClusterId string

The cluster id of the app (string)

Namespace string

The namespace of the app v2 (string)

RepoName string

Repo name (string)

Annotations Dictionary<string, object>

Annotations for the app v2 (map)

ChartVersion string

The app v2 chart version (string)

CleanupOnFail bool

Cleanup app v2 on failed chart upgrade. Default: false (bool)

DisableHooks bool

Disable app v2 chart hooks. Default: false (bool)

DisableOpenApiValidation bool

Disable app V2 Open API Validation. Default: false (bool)

ForceUpgrade bool

Force app V2 chart upgrade. Default: false (bool)

Labels Dictionary<string, object>

Labels for the app v2 (map)

Name string

The name of the app v2 (string)

ProjectId string

Deploy the app v2 within project ID (string)

Values string

The app v2 values yaml. Yaml format is required (string)

Wait bool

Wait until app is deployed. Default: true (bool)

ChartName string

The app v2 chart name (string)

ClusterId string

The cluster id of the app (string)

Namespace string

The namespace of the app v2 (string)

RepoName string

Repo name (string)

Annotations map[string]interface{}

Annotations for the app v2 (map)

ChartVersion string

The app v2 chart version (string)

CleanupOnFail bool

Cleanup app v2 on failed chart upgrade. Default: false (bool)

DisableHooks bool

Disable app v2 chart hooks. Default: false (bool)

DisableOpenApiValidation bool

Disable app V2 Open API Validation. Default: false (bool)

ForceUpgrade bool

Force app V2 chart upgrade. Default: false (bool)

Labels map[string]interface{}

Labels for the app v2 (map)

Name string

The name of the app v2 (string)

ProjectId string

Deploy the app v2 within project ID (string)

Values string

The app v2 values yaml. Yaml format is required (string)

Wait bool

Wait until app is deployed. Default: true (bool)

chartName string

The app v2 chart name (string)

clusterId string

The cluster id of the app (string)

namespace string

The namespace of the app v2 (string)

repoName string

Repo name (string)

annotations {[key: string]: any}

Annotations for the app v2 (map)

chartVersion string

The app v2 chart version (string)

cleanupOnFail boolean

Cleanup app v2 on failed chart upgrade. Default: false (bool)

disableHooks boolean

Disable app v2 chart hooks. Default: false (bool)

disableOpenApiValidation boolean

Disable app V2 Open API Validation. Default: false (bool)

forceUpgrade boolean

Force app V2 chart upgrade. Default: false (bool)

labels {[key: string]: any}

Labels for the app v2 (map)

name string

The name of the app v2 (string)

projectId string

Deploy the app v2 within project ID (string)

values string

The app v2 values yaml. Yaml format is required (string)

wait boolean

Wait until app is deployed. Default: true (bool)

chart_name str

The app v2 chart name (string)

cluster_id str

The cluster id of the app (string)

namespace str

The namespace of the app v2 (string)

repo_name str

Repo name (string)

annotations Mapping[str, Any]

Annotations for the app v2 (map)

chart_version str

The app v2 chart version (string)

cleanup_on_fail bool

Cleanup app v2 on failed chart upgrade. Default: false (bool)

disable_hooks bool

Disable app v2 chart hooks. Default: false (bool)

disable_open_api_validation bool

Disable app V2 Open API Validation. Default: false (bool)

force_upgrade bool

Force app V2 chart upgrade. Default: false (bool)

labels Mapping[str, Any]

Labels for the app v2 (map)

name str

The name of the app v2 (string)

project_id str

Deploy the app v2 within project ID (string)

values str

The app v2 values yaml. Yaml format is required (string)

wait bool

Wait until app is deployed. Default: true (bool)

Outputs

All input properties are implicitly available as output properties. Additionally, the AppV2 resource produces the following output properties:

ClusterName string

(Computed) The cluster name of the app (string)

Id string
The provider-assigned unique ID for this managed resource.
ClusterName string

(Computed) The cluster name of the app (string)

Id string
The provider-assigned unique ID for this managed resource.
clusterName string

(Computed) The cluster name of the app (string)

id string
The provider-assigned unique ID for this managed resource.
cluster_name str

(Computed) The cluster name of the app (string)

id str
The provider-assigned unique ID for this managed resource.

Look up an Existing AppV2 Resource

Get an existing AppV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AppV2State, opts?: CustomResourceOptions): AppV2
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, annotations: Optional[Mapping[str, Any]] = None, chart_name: Optional[str] = None, chart_version: Optional[str] = None, cleanup_on_fail: Optional[bool] = None, cluster_id: Optional[str] = None, cluster_name: Optional[str] = None, disable_hooks: Optional[bool] = None, disable_open_api_validation: Optional[bool] = None, force_upgrade: Optional[bool] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, namespace: Optional[str] = None, project_id: Optional[str] = None, repo_name: Optional[str] = None, values: Optional[str] = None, wait: Optional[bool] = None) -> AppV2
func GetAppV2(ctx *Context, name string, id IDInput, state *AppV2State, opts ...ResourceOption) (*AppV2, error)
public static AppV2 Get(string name, Input<string> id, AppV2State? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Annotations Dictionary<string, object>

Annotations for the app v2 (map)

ChartName string

The app v2 chart name (string)

ChartVersion string

The app v2 chart version (string)

CleanupOnFail bool

Cleanup app v2 on failed chart upgrade. Default: false (bool)

ClusterId string

The cluster id of the app (string)

ClusterName string

(Computed) The cluster name of the app (string)

DisableHooks bool

Disable app v2 chart hooks. Default: false (bool)

DisableOpenApiValidation bool

Disable app V2 Open API Validation. Default: false (bool)

ForceUpgrade bool

Force app V2 chart upgrade. Default: false (bool)

Labels Dictionary<string, object>

Labels for the app v2 (map)

Name string

The name of the app v2 (string)

Namespace string

The namespace of the app v2 (string)

ProjectId string

Deploy the app v2 within project ID (string)

RepoName string

Repo name (string)

Values string

The app v2 values yaml. Yaml format is required (string)

Wait bool

Wait until app is deployed. Default: true (bool)

Annotations map[string]interface{}

Annotations for the app v2 (map)

ChartName string

The app v2 chart name (string)

ChartVersion string

The app v2 chart version (string)

CleanupOnFail bool

Cleanup app v2 on failed chart upgrade. Default: false (bool)

ClusterId string

The cluster id of the app (string)

ClusterName string

(Computed) The cluster name of the app (string)

DisableHooks bool

Disable app v2 chart hooks. Default: false (bool)

DisableOpenApiValidation bool

Disable app V2 Open API Validation. Default: false (bool)

ForceUpgrade bool

Force app V2 chart upgrade. Default: false (bool)

Labels map[string]interface{}

Labels for the app v2 (map)

Name string

The name of the app v2 (string)

Namespace string

The namespace of the app v2 (string)

ProjectId string

Deploy the app v2 within project ID (string)

RepoName string

Repo name (string)

Values string

The app v2 values yaml. Yaml format is required (string)

Wait bool

Wait until app is deployed. Default: true (bool)

annotations {[key: string]: any}

Annotations for the app v2 (map)

chartName string

The app v2 chart name (string)

chartVersion string

The app v2 chart version (string)

cleanupOnFail boolean

Cleanup app v2 on failed chart upgrade. Default: false (bool)

clusterId string

The cluster id of the app (string)

clusterName string

(Computed) The cluster name of the app (string)

disableHooks boolean

Disable app v2 chart hooks. Default: false (bool)

disableOpenApiValidation boolean

Disable app V2 Open API Validation. Default: false (bool)

forceUpgrade boolean

Force app V2 chart upgrade. Default: false (bool)

labels {[key: string]: any}

Labels for the app v2 (map)

name string

The name of the app v2 (string)

namespace string

The namespace of the app v2 (string)

projectId string

Deploy the app v2 within project ID (string)

repoName string

Repo name (string)

values string

The app v2 values yaml. Yaml format is required (string)

wait boolean

Wait until app is deployed. Default: true (bool)

annotations Mapping[str, Any]

Annotations for the app v2 (map)

chart_name str

The app v2 chart name (string)

chart_version str

The app v2 chart version (string)

cleanup_on_fail bool

Cleanup app v2 on failed chart upgrade. Default: false (bool)

cluster_id str

The cluster id of the app (string)

cluster_name str

(Computed) The cluster name of the app (string)

disable_hooks bool

Disable app v2 chart hooks. Default: false (bool)

disable_open_api_validation bool

Disable app V2 Open API Validation. Default: false (bool)

force_upgrade bool

Force app V2 chart upgrade. Default: false (bool)

labels Mapping[str, Any]

Labels for the app v2 (map)

name str

The name of the app v2 (string)

namespace str

The namespace of the app v2 (string)

project_id str

Deploy the app v2 within project ID (string)

repo_name str

Repo name (string)

values str

The app v2 values yaml. Yaml format is required (string)

wait bool

Wait until app is deployed. Default: true (bool)

Import

V2 apps can be imported using the Rancher cluster ID and App V2 name.

 $ pulumi import rancher2:index/appV2:AppV2 foo &lt;CLUSTER_ID&gt;.&lt;APP_V2_NAME&gt;

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.