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

getCatalog

Use this data source to retrieve information about a Rancher v2 catalog.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var library = Output.Create(Rancher2.GetCatalog.InvokeAsync(new Rancher2.GetCatalogArgs
        {
            Name = "catalog",
        }));
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.LookupCatalog(ctx, &rancher2.LookupCatalogArgs{
            Name: "catalog",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

library = rancher2.get_catalog(name="catalog")
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const library = pulumi.output(rancher2.getCatalog({
    name: "catalog",
}, { async: true }));

Using getCatalog

function getCatalog(args: GetCatalogArgs, opts?: InvokeOptions): Promise<GetCatalogResult>
def get_catalog(name: Optional[str] = None, scope: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetCatalogResult
func LookupCatalog(ctx *Context, args *LookupCatalogArgs, opts ...InvokeOption) (*LookupCatalogResult, error)

Note: This function is named LookupCatalog in the Go SDK.

public static class GetCatalog {
    public static Task<GetCatalogResult> InvokeAsync(GetCatalogArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The catalog name.

Scope string

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

Name string

The catalog name.

Scope string

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

name string

The catalog name.

scope string

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

name str

The catalog name.

scope str

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

getCatalog Result

The following output properties are available:

Annotations Dictionary<string, object>

(Computed) Annotations for the catalog (map)

Branch string

(Computed) The branch of the catalog repo to use (string)

ClusterId string

(Computed) The cluster id of the catalog (string)

Description string

(Computed) A catalog description (string)

Id string

The provider-assigned unique ID for this managed resource.

Kind string

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

Labels Dictionary<string, object>

(Computed) Labels for the catalog (map)

Name string
Password string

(Computed/Sensitive) The password to access the catalog if needed (string)

ProjectId string

(Computed) The project id of the catalog (string)

Url string

(Computed) The url of the catalog repo (string)

Username string

(Computed/Sensitive) The username to access the catalog if needed (string)

Version string

(Computed) Helm version for the catalog (string)

Scope string
Annotations map[string]interface{}

(Computed) Annotations for the catalog (map)

Branch string

(Computed) The branch of the catalog repo to use (string)

ClusterId string

(Computed) The cluster id of the catalog (string)

Description string

(Computed) A catalog description (string)

Id string

The provider-assigned unique ID for this managed resource.

Kind string

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

Labels map[string]interface{}

(Computed) Labels for the catalog (map)

Name string
Password string

(Computed/Sensitive) The password to access the catalog if needed (string)

ProjectId string

(Computed) The project id of the catalog (string)

Url string

(Computed) The url of the catalog repo (string)

Username string

(Computed/Sensitive) The username to access the catalog if needed (string)

Version string

(Computed) Helm version for the catalog (string)

Scope string
annotations {[key: string]: any}

(Computed) Annotations for the catalog (map)

branch string

(Computed) The branch of the catalog repo to use (string)

clusterId string

(Computed) The cluster id of the catalog (string)

description string

(Computed) A catalog description (string)

id string

The provider-assigned unique ID for this managed resource.

kind string

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

labels {[key: string]: any}

(Computed) Labels for the catalog (map)

name string
password string

(Computed/Sensitive) The password to access the catalog if needed (string)

projectId string

(Computed) The project id of the catalog (string)

url string

(Computed) The url of the catalog repo (string)

username string

(Computed/Sensitive) The username to access the catalog if needed (string)

version string

(Computed) Helm version for the catalog (string)

scope string
annotations Mapping[str, Any]

(Computed) Annotations for the catalog (map)

branch str

(Computed) The branch of the catalog repo to use (string)

cluster_id str

(Computed) The cluster id of the catalog (string)

description str

(Computed) A catalog description (string)

id str

The provider-assigned unique ID for this managed resource.

kind str

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

labels Mapping[str, Any]

(Computed) Labels for the catalog (map)

name str
password str

(Computed/Sensitive) The password to access the catalog if needed (string)

project_id str

(Computed) The project id of the catalog (string)

url str

(Computed) The url of the catalog repo (string)

username str

(Computed/Sensitive) The username to access the catalog if needed (string)

version str

(Computed) Helm version for the catalog (string)

scope str

Package Details

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