Docs Packages
  1. Packages
  2. Rancher2
  3. API Docs
  4. App
Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-rancher2

rancher2.App

Explore with Pulumi AI

rancher2 logo
Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-rancher2

    Provides a Rancher v2 app resource. This can be used to deploy apps within Rancher v2 projects.

    This resource can also modify Rancher v2 apps in 3 ways:

    • Update: If description, annotations or labels arguments are modified the app will be updated. No new revision_id will be generated in Rancher.
    • Upgrade: If answers, catalog_name, template_name, template_version or values_yaml arguments are modified, the app will be upgraded. A new revision_id will be generated in Rancher.
    • Rollback: If revision_id argument is provided or modified the app will be rolled back accordingly. A new revision_id will be generated in Rancher. It will also generate a non-empty pulumi preview that will require manual .tf file intervention. Use carefully.

    Note: In case of multiple resource modifications in a row, rollback has preference over upgrade.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

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

    import pulumi
import pulumi_rancher2 as rancher2

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

    package main

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

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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

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

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.App;
import com.pulumi.rancher2.AppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new rancher2 App
        var foo = new App("foo", AppArgs.builder()        
            .catalogName("<catalog_name>")
            .name("foo")
            .description("Foo app")
            .projectId("<project_id>")
            .templateName("<template_name>")
            .templateVersion("<template_version>")
            .targetNamespace("<namespace_name>")
            .answers(Map.ofEntries(
                Map.entry("ingress_host", "test.xip.io"),
                Map.entry("foo", "bar"),
                Map.entry("ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect", true)
            ))
            .build());

    }
}

    resources:
  # Create a new rancher2 App
  foo:
    type: rancher2:App
    properties:
      catalogName: <catalog_name>
      name: foo
      description: Foo app
      projectId: <project_id>
      templateName: <template_name>
      templateVersion: <template_version>
      targetNamespace: <namespace_name>
      answers:
        ingress_host: test.xip.io
        foo: bar
        ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect: true

    import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 App in a new namespace
const foo = new rancher2.Namespace("foo", {
    name: "foo",
    description: "Foo namespace",
    projectId: "<project_id>",
    resourceQuota: {
        limit: {
            limitsCpu: "100m",
            limitsMemory: "100Mi",
            requestsStorage: "1Gi",
        },
    },
});
const fooApp = new rancher2.App("foo", {
    catalogName: "<catalog_name>",
    name: "foo",
    description: "Foo app",
    projectId: "<project_id>",
    templateName: "<template_name>",
    templateVersion: "<template_version>",
    targetNamespace: foo.id,
    answers: {
        ingress_host: "test.xip.io",
        foo: "bar",
        "ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect": true,
    },
});

    import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 App in a new namespace
foo = rancher2.Namespace("foo",
    name="foo",
    description="Foo namespace",
    project_id="<project_id>",
    resource_quota=rancher2.NamespaceResourceQuotaArgs(
        limit=rancher2.NamespaceResourceQuotaLimitArgs(
            limits_cpu="100m",
            limits_memory="100Mi",
            requests_storage="1Gi",
        ),
    ))
foo_app = rancher2.App("foo",
    catalog_name="<catalog_name>",
    name="foo",
    description="Foo app",
    project_id="<project_id>",
    template_name="<template_name>",
    template_version="<template_version>",
    target_namespace=foo.id,
    answers={
        "ingress_host": "test.xip.io",
        "foo": "bar",
        "ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect": True,
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new rancher2 App in a new namespace
		foo, err := rancher2.NewNamespace(ctx, "foo", &rancher2.NamespaceArgs{
			Name:        pulumi.String("foo"),
			Description: pulumi.String("Foo namespace"),
			ProjectId:   pulumi.String("<project_id>"),
			ResourceQuota: &rancher2.NamespaceResourceQuotaArgs{
				Limit: &rancher2.NamespaceResourceQuotaLimitArgs{
					LimitsCpu:       pulumi.String("100m"),
					LimitsMemory:    pulumi.String("100Mi"),
					RequestsStorage: pulumi.String("1Gi"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = rancher2.NewApp(ctx, "foo", &rancher2.AppArgs{
			CatalogName:     pulumi.String("<catalog_name>"),
			Name:            pulumi.String("foo"),
			Description:     pulumi.String("Foo app"),
			ProjectId:       pulumi.String("<project_id>"),
			TemplateName:    pulumi.String("<template_name>"),
			TemplateVersion: pulumi.String("<template_version>"),
			TargetNamespace: foo.ID(),
			Answers: pulumi.Map{
				"ingress_host": pulumi.Any("test.xip.io"),
				"foo":          pulumi.Any("bar"),
				"ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect": pulumi.Any(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    // Create a new rancher2 App in a new namespace
    var foo = new Rancher2.Namespace("foo", new()
    {
        Name = "foo",
        Description = "Foo namespace",
        ProjectId = "<project_id>",
        ResourceQuota = new Rancher2.Inputs.NamespaceResourceQuotaArgs
        {
            Limit = new Rancher2.Inputs.NamespaceResourceQuotaLimitArgs
            {
                LimitsCpu = "100m",
                LimitsMemory = "100Mi",
                RequestsStorage = "1Gi",
            },
        },
    });

    var fooApp = new Rancher2.App("foo", new()
    {
        CatalogName = "<catalog_name>",
        Name = "foo",
        Description = "Foo app",
        ProjectId = "<project_id>",
        TemplateName = "<template_name>",
        TemplateVersion = "<template_version>",
        TargetNamespace = foo.Id,
        Answers = 
        {
            { "ingress_host", "test.xip.io" },
            { "foo", "bar" },
            { "ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect", true },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Namespace;
import com.pulumi.rancher2.NamespaceArgs;
import com.pulumi.rancher2.inputs.NamespaceResourceQuotaArgs;
import com.pulumi.rancher2.inputs.NamespaceResourceQuotaLimitArgs;
import com.pulumi.rancher2.App;
import com.pulumi.rancher2.AppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new rancher2 App in a new namespace
        var foo = new Namespace("foo", NamespaceArgs.builder()        
            .name("foo")
            .description("Foo namespace")
            .projectId("<project_id>")
            .resourceQuota(NamespaceResourceQuotaArgs.builder()
                .limit(NamespaceResourceQuotaLimitArgs.builder()
                    .limitsCpu("100m")
                    .limitsMemory("100Mi")
                    .requestsStorage("1Gi")
                    .build())
                .build())
            .build());

        var fooApp = new App("fooApp", AppArgs.builder()        
            .catalogName("<catalog_name>")
            .name("foo")
            .description("Foo app")
            .projectId("<project_id>")
            .templateName("<template_name>")
            .templateVersion("<template_version>")
            .targetNamespace(foo.id())
            .answers(Map.ofEntries(
                Map.entry("ingress_host", "test.xip.io"),
                Map.entry("foo", "bar"),
                Map.entry("ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect", true)
            ))
            .build());

    }
}

    resources:
  # Create a new rancher2 App in a new namespace
  foo:
    type: rancher2:Namespace
    properties:
      name: foo
      description: Foo namespace
      projectId: <project_id>
      resourceQuota:
        limit:
          limitsCpu: 100m
          limitsMemory: 100Mi
          requestsStorage: 1Gi
  fooApp:
    type: rancher2:App
    name: foo
    properties:
      catalogName: <catalog_name>
      name: foo
      description: Foo app
      projectId: <project_id>
      templateName: <template_name>
      templateVersion: <template_version>
      targetNamespace: ${foo.id}
      answers:
        ingress_host: test.xip.io
        foo: bar
        ingress.annotations.nginx.ingress.kubernetes.io/force-ssl-redirect: true

    Create App Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new App(name: string, args: AppArgs, opts?: CustomResourceOptions);
    @overload
def App(resource_name: str,
        args: AppArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        project_id: Optional[str] = None,
        template_name: Optional[str] = None,
        catalog_name: Optional[str] = None,
        target_namespace: Optional[str] = None,
        description: Optional[str] = None,
        labels: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        force_upgrade: Optional[bool] = None,
        revision_id: Optional[str] = None,
        annotations: Optional[Mapping[str, Any]] = None,
        answers: Optional[Mapping[str, Any]] = None,
        template_version: Optional[str] = None,
        values_yaml: Optional[str] = None,
        wait: Optional[bool] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var appResource = new Rancher2.App("appResource", new()
{
    ProjectId = "string",
    TemplateName = "string",
    CatalogName = "string",
    TargetNamespace = "string",
    Description = "string",
    Labels = 
    {
        { "string", "any" },
    },
    Name = "string",
    ForceUpgrade = false,
    RevisionId = "string",
    Annotations = 
    {
        { "string", "any" },
    },
    Answers = 
    {
        { "string", "any" },
    },
    TemplateVersion = "string",
    ValuesYaml = "string",
    Wait = false,
});

    example, err := rancher2.NewApp(ctx, "appResource", &rancher2.AppArgs{
	ProjectId:       pulumi.String("string"),
	TemplateName:    pulumi.String("string"),
	CatalogName:     pulumi.String("string"),
	TargetNamespace: pulumi.String("string"),
	Description:     pulumi.String("string"),
	Labels: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Name:         pulumi.String("string"),
	ForceUpgrade: pulumi.Bool(false),
	RevisionId:   pulumi.String("string"),
	Annotations: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Answers: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	TemplateVersion: pulumi.String("string"),
	ValuesYaml:      pulumi.String("string"),
	Wait:            pulumi.Bool(false),
})

    var appResource = new App("appResource", AppArgs.builder()
    .projectId("string")
    .templateName("string")
    .catalogName("string")
    .targetNamespace("string")
    .description("string")
    .labels(Map.of("string", "any"))
    .name("string")
    .forceUpgrade(false)
    .revisionId("string")
    .annotations(Map.of("string", "any"))
    .answers(Map.of("string", "any"))
    .templateVersion("string")
    .valuesYaml("string")
    .wait(false)
    .build());

    app_resource = rancher2.App("appResource",
    project_id="string",
    template_name="string",
    catalog_name="string",
    target_namespace="string",
    description="string",
    labels={
        "string": "any",
    },
    name="string",
    force_upgrade=False,
    revision_id="string",
    annotations={
        "string": "any",
    },
    answers={
        "string": "any",
    },
    template_version="string",
    values_yaml="string",
    wait=False)

    const appResource = new rancher2.App("appResource", {
    projectId: "string",
    templateName: "string",
    catalogName: "string",
    targetNamespace: "string",
    description: "string",
    labels: {
        string: "any",
    },
    name: "string",
    forceUpgrade: false,
    revisionId: "string",
    annotations: {
        string: "any",
    },
    answers: {
        string: "any",
    },
    templateVersion: "string",
    valuesYaml: "string",
    wait: false,
});

    type: rancher2:App
properties:
    annotations:
        string: any
    answers:
        string: any
    catalogName: string
    description: string
    forceUpgrade: false
    labels:
        string: any
    name: string
    projectId: string
    revisionId: string
    targetNamespace: string
    templateName: string
    templateVersion: string
    valuesYaml: string
    wait: false

    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 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)

    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;

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-rancher2