Rancher2

Pulumi Official
Package maintained by Pulumi
v3.8.0 published on Tuesday, May 31, 2022 by Pulumi

App

Import

Apps can be imported using the app ID in the format <project_id>:<app_name>

 $ pulumi import rancher2:index/app:App foo &lt;PROJECT_ID_ID&gt;:&lt;APP_NAME&gt;

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 App
        var foo = new Rancher2.App("foo", new Rancher2.AppArgs
        {
            Answers = 
            {
                { "foo", "bar" },
                { "ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect", true },
                { "ingress_host", "test.xip.io" },
            },
            CatalogName = "<catalog_name>",
            Description = "Foo app",
            ProjectId = "<project_id>",
            TargetNamespace = "<namespace_name>",
            TemplateName = "<template_name>",
            TemplateVersion = "<template_version>",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v3/go/rancher2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.NewApp(ctx, "foo", &rancher2.AppArgs{
			Answers: pulumi.AnyMap{
				"foo": pulumi.Any("bar"),
				"ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect": pulumi.Any(true),
				"ingress_host": pulumi.Any("test.xip.io"),
			},
			CatalogName:     pulumi.String("<catalog_name>"),
			Description:     pulumi.String("Foo app"),
			ProjectId:       pulumi.String("<project_id>"),
			TargetNamespace: pulumi.String("<namespace_name>"),
			TemplateName:    pulumi.String("<template_name>"),
			TemplateVersion: pulumi.String("<template_version>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 App
foo = rancher2.App("foo",
    answers={
        "foo": "bar",
        "ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect": True,
        "ingress_host": "test.xip.io",
    },
    catalog_name="<catalog_name>",
    description="Foo app",
    project_id="<project_id>",
    target_namespace="<namespace_name>",
    template_name="<template_name>",
    template_version="<template_version>")
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 App
const foo = new rancher2.App("foo", {
    answers: {
        foo: "bar",
        "ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect": true,
        ingress_host: "test.xip.io",
    },
    catalogName: "<catalog_name>",
    description: "Foo app",
    projectId: "<project_id>",
    targetNamespace: "<namespace_name>",
    templateName: "<template_name>",
    templateVersion: "<template_version>",
});

Coming soon!

Create a App Resource

new App(name: string, args: AppArgs, opts?: CustomResourceOptions);
@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, Any]] = None,
        answers: Optional[Mapping[str, Any]] = None,
        catalog_name: Optional[str] = None,
        description: Optional[str] = None,
        force_upgrade: Optional[bool] = None,
        labels: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        revision_id: Optional[str] = None,
        target_namespace: Optional[str] = None,
        template_name: Optional[str] = None,
        template_version: Optional[str] = None,
        values_yaml: Optional[str] = None,
        wait: Optional[bool] = None)
@overload
def App(resource_name: str,
        args: AppArgs,
        opts: Optional[ResourceOptions] = None)
func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs args, CustomResourceOptions? opts = null)
public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)
type: rancher2:App
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

App Resource Properties

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

Inputs

The App resource accepts the following input properties:

CatalogName string

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
ProjectId string

The project id where the app will be installed (string)

TargetNamespace string

The namespace id where the app will be installed (string)

TemplateName string

Template name of the app. If modified, app will be upgraded (string)

Annotations Dictionary<string, object>

Annotations for App object (map)

Answers Dictionary<string, object>

Answers for the app template. If modified, app will be upgraded (map)

Description string

Description for the app (string)

ForceUpgrade bool

Force app upgrade (string)

Labels Dictionary<string, object>

Labels for App object (map)

Name string

The name of the app (string)

RevisionId string

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

TemplateVersion string

Template version of the app. If modified, app will be upgraded. Default: latest (string)

ValuesYaml string

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

Wait bool

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

CatalogName string

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
ProjectId string

The project id where the app will be installed (string)

TargetNamespace string

The namespace id where the app will be installed (string)

TemplateName string

Template name of the app. If modified, app will be upgraded (string)

Annotations map[string]interface{}

Annotations for App object (map)

Answers map[string]interface{}

Answers for the app template. If modified, app will be upgraded (map)

Description string

Description for the app (string)

ForceUpgrade bool

Force app upgrade (string)

Labels map[string]interface{}

Labels for App object (map)

Name string

The name of the app (string)

RevisionId string

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

TemplateVersion string

Template version of the app. If modified, app will be upgraded. Default: latest (string)

ValuesYaml string

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

Wait bool

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

catalogName String

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
projectId String

The project id where the app will be installed (string)

targetNamespace String

The namespace id where the app will be installed (string)

templateName String

Template name of the app. If modified, app will be upgraded (string)

annotations Map<String,Object>

Annotations for App object (map)

answers Map<String,Object>

Answers for the app template. If modified, app will be upgraded (map)

description String

Description for the app (string)

forceUpgrade Boolean

Force app upgrade (string)

labels Map<String,Object>

Labels for App object (map)

name String

The name of the app (string)

revisionId String

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

templateVersion String

Template version of the app. If modified, app will be upgraded. Default: latest (string)

valuesYaml String

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait_ Boolean

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

catalogName string

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
projectId string

The project id where the app will be installed (string)

targetNamespace string

The namespace id where the app will be installed (string)

templateName string

Template name of the app. If modified, app will be upgraded (string)

annotations {[key: string]: any}

Annotations for App object (map)

answers {[key: string]: any}

Answers for the app template. If modified, app will be upgraded (map)

description string

Description for the app (string)

forceUpgrade boolean

Force app upgrade (string)

labels {[key: string]: any}

Labels for App object (map)

name string

The name of the app (string)

revisionId string

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

templateVersion string

Template version of the app. If modified, app will be upgraded. Default: latest (string)

valuesYaml string

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait boolean

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

catalog_name str

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
project_id str

The project id where the app will be installed (string)

target_namespace str

The namespace id where the app will be installed (string)

template_name str

Template name of the app. If modified, app will be upgraded (string)

annotations Mapping[str, Any]

Annotations for App object (map)

answers Mapping[str, Any]

Answers for the app template. If modified, app will be upgraded (map)

description str

Description for the app (string)

force_upgrade bool

Force app upgrade (string)

labels Mapping[str, Any]

Labels for App object (map)

name str

The name of the app (string)

revision_id str

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

template_version str

Template version of the app. If modified, app will be upgraded. Default: latest (string)

values_yaml str

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait bool

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

catalogName String

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
projectId String

The project id where the app will be installed (string)

targetNamespace String

The namespace id where the app will be installed (string)

templateName String

Template name of the app. If modified, app will be upgraded (string)

annotations Map<Any>

Annotations for App object (map)

answers Map<Any>

Answers for the app template. If modified, app will be upgraded (map)

description String

Description for the app (string)

forceUpgrade Boolean

Force app upgrade (string)

labels Map<Any>

Labels for App object (map)

name String

The name of the app (string)

revisionId String

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

templateVersion String

Template version of the app. If modified, app will be upgraded. Default: latest (string)

valuesYaml String

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait Boolean

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

Outputs

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

ExternalId string

(Computed) The url of the app template on a catalog (string)

Id string

The provider-assigned unique ID for this managed resource.

ExternalId string

(Computed) The url of the app template on a catalog (string)

Id string

The provider-assigned unique ID for this managed resource.

externalId String

(Computed) The url of the app template on a catalog (string)

id String

The provider-assigned unique ID for this managed resource.

externalId string

(Computed) The url of the app template on a catalog (string)

id string

The provider-assigned unique ID for this managed resource.

external_id str

(Computed) The url of the app template on a catalog (string)

id str

The provider-assigned unique ID for this managed resource.

externalId String

(Computed) The url of the app template on a catalog (string)

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing App Resource

Get an existing App 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?: AppState, opts?: CustomResourceOptions): App
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, Any]] = None,
        answers: Optional[Mapping[str, Any]] = None,
        catalog_name: Optional[str] = None,
        description: Optional[str] = None,
        external_id: Optional[str] = None,
        force_upgrade: Optional[bool] = None,
        labels: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        revision_id: Optional[str] = None,
        target_namespace: Optional[str] = None,
        template_name: Optional[str] = None,
        template_version: Optional[str] = None,
        values_yaml: Optional[str] = None,
        wait: Optional[bool] = None) -> App
func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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 App object (map)

Answers Dictionary<string, object>

Answers for the app template. If modified, app will be upgraded (map)

CatalogName string

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
Description string

Description for the app (string)

ExternalId string

(Computed) The url of the app template on a catalog (string)

ForceUpgrade bool

Force app upgrade (string)

Labels Dictionary<string, object>

Labels for App object (map)

Name string

The name of the app (string)

ProjectId string

The project id where the app will be installed (string)

RevisionId string

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

TargetNamespace string

The namespace id where the app will be installed (string)

TemplateName string

Template name of the app. If modified, app will be upgraded (string)

TemplateVersion string

Template version of the app. If modified, app will be upgraded. Default: latest (string)

ValuesYaml string

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

Wait bool

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

Annotations map[string]interface{}

Annotations for App object (map)

Answers map[string]interface{}

Answers for the app template. If modified, app will be upgraded (map)

CatalogName string

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
Description string

Description for the app (string)

ExternalId string

(Computed) The url of the app template on a catalog (string)

ForceUpgrade bool

Force app upgrade (string)

Labels map[string]interface{}

Labels for App object (map)

Name string

The name of the app (string)

ProjectId string

The project id where the app will be installed (string)

RevisionId string

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

TargetNamespace string

The namespace id where the app will be installed (string)

TemplateName string

Template name of the app. If modified, app will be upgraded (string)

TemplateVersion string

Template version of the app. If modified, app will be upgraded. Default: latest (string)

ValuesYaml string

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

Wait bool

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

annotations Map<String,Object>

Annotations for App object (map)

answers Map<String,Object>

Answers for the app template. If modified, app will be upgraded (map)

catalogName String

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
description String

Description for the app (string)

externalId String

(Computed) The url of the app template on a catalog (string)

forceUpgrade Boolean

Force app upgrade (string)

labels Map<String,Object>

Labels for App object (map)

name String

The name of the app (string)

projectId String

The project id where the app will be installed (string)

revisionId String

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

targetNamespace String

The namespace id where the app will be installed (string)

templateName String

Template name of the app. If modified, app will be upgraded (string)

templateVersion String

Template version of the app. If modified, app will be upgraded. Default: latest (string)

valuesYaml String

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait_ Boolean

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

annotations {[key: string]: any}

Annotations for App object (map)

answers {[key: string]: any}

Answers for the app template. If modified, app will be upgraded (map)

catalogName string

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
description string

Description for the app (string)

externalId string

(Computed) The url of the app template on a catalog (string)

forceUpgrade boolean

Force app upgrade (string)

labels {[key: string]: any}

Labels for App object (map)

name string

The name of the app (string)

projectId string

The project id where the app will be installed (string)

revisionId string

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

targetNamespace string

The namespace id where the app will be installed (string)

templateName string

Template name of the app. If modified, app will be upgraded (string)

templateVersion string

Template version of the app. If modified, app will be upgraded. Default: latest (string)

valuesYaml string

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait boolean

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

annotations Mapping[str, Any]

Annotations for App object (map)

answers Mapping[str, Any]

Answers for the app template. If modified, app will be upgraded (map)

catalog_name str

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
description str

Description for the app (string)

external_id str

(Computed) The url of the app template on a catalog (string)

force_upgrade bool

Force app upgrade (string)

labels Mapping[str, Any]

Labels for App object (map)

name str

The name of the app (string)

project_id str

The project id where the app will be installed (string)

revision_id str

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

target_namespace str

The namespace id where the app will be installed (string)

template_name str

Template name of the app. If modified, app will be upgraded (string)

template_version str

Template version of the app. If modified, app will be upgraded. Default: latest (string)

values_yaml str

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait bool

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

annotations Map<Any>

Annotations for App object (map)

answers Map<Any>

Answers for the app template. If modified, app will be upgraded (map)

catalogName String

Catalog name of the app. If modified, app will be upgraded. For use scoped catalogs:

  • add cluster ID before name, local:<name> or c-XXXXX:<name>
  • add project ID before name, p-XXXXX:<name>
description String

Description for the app (string)

externalId String

(Computed) The url of the app template on a catalog (string)

forceUpgrade Boolean

Force app upgrade (string)

labels Map<Any>

Labels for App object (map)

name String

The name of the app (string)

projectId String

The project id where the app will be installed (string)

revisionId String

Current revision id for the app. If modified, If this argument is provided or modified, app will be rollbacked to revision_id (string)

targetNamespace String

The namespace id where the app will be installed (string)

templateName String

Template name of the app. If modified, app will be upgraded (string)

templateVersion String

Template version of the app. If modified, app will be upgraded. Default: latest (string)

valuesYaml String

values.yaml base64 encoded file content for the app template. If modified, app will be upgraded (string)

wait Boolean

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

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes

This Pulumi package is based on the rancher2 Terraform Provider.