Class Catalog

Provides a Rancher v2 Catalog resource. This can be used to create cluster, global and/or project catalogs for Rancher v2 environments and retrieve their information.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new Rancher2 Global Catalog
    var foo_global = new Rancher2.Catalog("foo-global", new Rancher2.CatalogArgs
    {
        Url = "https://<CATALOG_URL>",
    });
    // Create a new Rancher2 Cluster Catalog
    var foo_cluster = new Rancher2.Catalog("foo-cluster", new Rancher2.CatalogArgs
    {
        Scope = "cluster",
        Url = "https://<CATALOG_URL>",
    });
    // Create a new Rancher2 Project Catalog
    var foo_project = new Rancher2.Catalog("foo-project", new Rancher2.CatalogArgs
    {
        Scope = "project",
        Url = "https://<CATALOG_URL>",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Catalog

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Rancher2

Assembly: Pulumi.Rancher2.dll

Syntax

public class Catalog : CustomResource

Constructors

Catalog(String, CatalogArgs, CustomResourceOptions)

Create a Catalog resource with the given unique name, arguments, and options.

Declaration

public Catalog(string name, CatalogArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
CatalogArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Annotations

Annotations for the catalog (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Branch

The branch of the catalog repo to use. Default master (string)

Declaration

public Output<string> Branch { get; }

Property Value

Type	Description
Output<System.String>

ClusterId

The cluster id of the catalog. Mandatory if scope = cluster (string)

Declaration

public Output<string> ClusterId { get; }

Property Value

Type	Description
Output<System.String>

Description

A catalog description (string)

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Kind

The kind of the catalog. Just helm by the moment (string)

Declaration

public Output<string> Kind { get; }

Property Value

Type	Description
Output<System.String>

Labels

Labels for the catalog (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Name

The name of the catalog (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Password

The password to access the catalog if needed (string)

Declaration

public Output<string> Password { get; }

Property Value

Type	Description
Output<System.String>

ProjectId

The project id of the catalog. Mandatory if scope = project (string)

Declaration

public Output<string> ProjectId { get; }

Property Value

Type	Description
Output<System.String>

Refresh

Catalog will wait for refresh after tf creation and on every tf read. Default false (bool)

Declaration

public Output<bool?> Refresh { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Scope

The scope of the catalog. cluster, global, and project are supported. Default global (string)

Declaration

public Output<string> Scope { get; }

Property Value

Type	Description
Output<System.String>

Url

The url of the catalog repo (string)

Declaration

public Output<string> Url { get; }

Property Value

Type	Description
Output<System.String>

Username

The username to access the catalog if needed (string)

Declaration

public Output<string> Username { get; }

Property Value

Type	Description
Output<System.String>

Version

Helm version for the catalog. Available options: helm_v2 and helm_v3 (string)

Declaration

public Output<string> Version { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, CatalogState, CustomResourceOptions)

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

Declaration

public static Catalog Get(string name, Input<string> id, CatalogState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
CatalogState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Catalog