Rancher 2 v4.0.0, Apr 20 23

rancher2.CatalogV2

Explore with Pulumi AI

Provides a Rancher Catalog v2 resource. This can be used to create cluster helm catalogs for Rancher v2 environments and retrieve their information. Catalog v2 resource is available at Rancher v2.5.x and above.

Create CatalogV2 Resource

new CatalogV2(name: string, args: CatalogV2Args, opts?: CustomResourceOptions);

@overload
def CatalogV2(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              annotations: Optional[Mapping[str, Any]] = None,
              ca_bundle: Optional[str] = None,
              cluster_id: Optional[str] = None,
              enabled: Optional[bool] = None,
              git_branch: Optional[str] = None,
              git_repo: Optional[str] = None,
              insecure: Optional[bool] = None,
              labels: Optional[Mapping[str, Any]] = None,
              name: Optional[str] = None,
              secret_name: Optional[str] = None,
              secret_namespace: Optional[str] = None,
              service_account: Optional[str] = None,
              service_account_namespace: Optional[str] = None,
              url: Optional[str] = None)
@overload
def CatalogV2(resource_name: str,
              args: CatalogV2Args,
              opts: Optional[ResourceOptions] = None)

func NewCatalogV2(ctx *Context, name string, args CatalogV2Args, opts ...ResourceOption) (*CatalogV2, error)

public CatalogV2(string name, CatalogV2Args args, CustomResourceOptions? opts = null)

public CatalogV2(String name, CatalogV2Args args)
public CatalogV2(String name, CatalogV2Args args, CustomResourceOptions options)

type: rancher2:CatalogV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CatalogV2Args: 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 CatalogV2Args: 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 CatalogV2Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CatalogV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CatalogV2Args: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

CatalogV2 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 CatalogV2 resource accepts the following input properties:

ClusterId string: The cluster id of the catalog V2 (string)
Annotations Dictionary<string, object>: Annotations for the catalog v2 (map)
CaBundle string: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
Enabled bool: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
GitBranch string: Git Repository branch containing Helm chart definitions. Default master (string)
GitRepo string: The url of the catalog v2 repo. Conflicts with url (string)
Insecure bool: Use insecure HTTPS to download the repo's index. Default: false (bool)
Labels Dictionary<string, object>: Labels for the catalog v2 (map)
Name string: The name of the catalog v2 (string)
SecretName string: K8s secret name to be used to connect to the repo (string)
SecretNamespace string: K8s secret namespace (string)
ServiceAccount string: K8s service account used to deploy charts instead of the end users credentials (string)
ServiceAccountNamespace string: The username to access the catalog if needed (string)
Url string: URL to an index generated by Helm. Conflicts with git_repo (string)

ClusterId string: The cluster id of the catalog V2 (string)
Annotations map[string]interface{}: Annotations for the catalog v2 (map)
CaBundle string: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
Enabled bool: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
GitBranch string: Git Repository branch containing Helm chart definitions. Default master (string)
GitRepo string: The url of the catalog v2 repo. Conflicts with url (string)
Insecure bool: Use insecure HTTPS to download the repo's index. Default: false (bool)
Labels map[string]interface{}: Labels for the catalog v2 (map)
Name string: The name of the catalog v2 (string)
SecretName string: K8s secret name to be used to connect to the repo (string)
SecretNamespace string: K8s secret namespace (string)
ServiceAccount string: K8s service account used to deploy charts instead of the end users credentials (string)
ServiceAccountNamespace string: The username to access the catalog if needed (string)
Url string: URL to an index generated by Helm. Conflicts with git_repo (string)

clusterId String: The cluster id of the catalog V2 (string)
annotations Map<String,Object>: Annotations for the catalog v2 (map)
caBundle String: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
enabled Boolean: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
gitBranch String: Git Repository branch containing Helm chart definitions. Default master (string)
gitRepo String: The url of the catalog v2 repo. Conflicts with url (string)
insecure Boolean: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels Map<String,Object>: Labels for the catalog v2 (map)
name String: The name of the catalog v2 (string)
secretName String: K8s secret name to be used to connect to the repo (string)
secretNamespace String: K8s secret namespace (string)
serviceAccount String: K8s service account used to deploy charts instead of the end users credentials (string)
serviceAccountNamespace String: The username to access the catalog if needed (string)
url String: URL to an index generated by Helm. Conflicts with git_repo (string)

clusterId string: The cluster id of the catalog V2 (string)
annotations {[key: string]: any}: Annotations for the catalog v2 (map)
caBundle string: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
enabled boolean: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
gitBranch string: Git Repository branch containing Helm chart definitions. Default master (string)
gitRepo string: The url of the catalog v2 repo. Conflicts with url (string)
insecure boolean: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels {[key: string]: any}: Labels for the catalog v2 (map)
name string: The name of the catalog v2 (string)
secretName string: K8s secret name to be used to connect to the repo (string)
secretNamespace string: K8s secret namespace (string)
serviceAccount string: K8s service account used to deploy charts instead of the end users credentials (string)
serviceAccountNamespace string: The username to access the catalog if needed (string)
url string: URL to an index generated by Helm. Conflicts with git_repo (string)

cluster_id str: The cluster id of the catalog V2 (string)
annotations Mapping[str, Any]: Annotations for the catalog v2 (map)
ca_bundle str: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
enabled bool: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
git_branch str: Git Repository branch containing Helm chart definitions. Default master (string)
git_repo str: The url of the catalog v2 repo. Conflicts with url (string)
insecure bool: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels Mapping[str, Any]: Labels for the catalog v2 (map)
name str: The name of the catalog v2 (string)
secret_name str: K8s secret name to be used to connect to the repo (string)
secret_namespace str: K8s secret namespace (string)
service_account str: K8s service account used to deploy charts instead of the end users credentials (string)
service_account_namespace str: The username to access the catalog if needed (string)
url str: URL to an index generated by Helm. Conflicts with git_repo (string)

clusterId String: The cluster id of the catalog V2 (string)
annotations Map<Any>: Annotations for the catalog v2 (map)
caBundle String: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
enabled Boolean: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
gitBranch String: Git Repository branch containing Helm chart definitions. Default master (string)
gitRepo String: The url of the catalog v2 repo. Conflicts with url (string)
insecure Boolean: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels Map<Any>: Labels for the catalog v2 (map)
name String: The name of the catalog v2 (string)
secretName String: K8s secret name to be used to connect to the repo (string)
secretNamespace String: K8s secret namespace (string)
serviceAccount String: K8s service account used to deploy charts instead of the end users credentials (string)
serviceAccountNamespace String: The username to access the catalog if needed (string)
url String: URL to an index generated by Helm. Conflicts with git_repo (string)

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
ResourceVersion string: (Computed) The k8s resource version (string)

Id string: The provider-assigned unique ID for this managed resource.
ResourceVersion string: (Computed) The k8s resource version (string)

id String: The provider-assigned unique ID for this managed resource.
resourceVersion String: (Computed) The k8s resource version (string)

id string: The provider-assigned unique ID for this managed resource.
resourceVersion string: (Computed) The k8s resource version (string)

id str: The provider-assigned unique ID for this managed resource.
resource_version str: (Computed) The k8s resource version (string)

id String: The provider-assigned unique ID for this managed resource.
resourceVersion String: (Computed) The k8s resource version (string)

Look up Existing CatalogV2 Resource

Get an existing CatalogV2 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?: CatalogV2State, opts?: CustomResourceOptions): CatalogV2

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, Any]] = None,
        ca_bundle: Optional[str] = None,
        cluster_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        git_branch: Optional[str] = None,
        git_repo: Optional[str] = None,
        insecure: Optional[bool] = None,
        labels: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        resource_version: Optional[str] = None,
        secret_name: Optional[str] = None,
        secret_namespace: Optional[str] = None,
        service_account: Optional[str] = None,
        service_account_namespace: Optional[str] = None,
        url: Optional[str] = None) -> CatalogV2

func GetCatalogV2(ctx *Context, name string, id IDInput, state *CatalogV2State, opts ...ResourceOption) (*CatalogV2, error)

public static CatalogV2 Get(string name, Input<string> id, CatalogV2State? state, CustomResourceOptions? opts = null)

public static CatalogV2 get(String name, Output<String> id, CatalogV2State 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 the catalog v2 (map)
CaBundle string: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
ClusterId string: The cluster id of the catalog V2 (string)
Enabled bool: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
GitBranch string: Git Repository branch containing Helm chart definitions. Default master (string)
GitRepo string: The url of the catalog v2 repo. Conflicts with url (string)
Insecure bool: Use insecure HTTPS to download the repo's index. Default: false (bool)
Labels Dictionary<string, object>: Labels for the catalog v2 (map)
Name string: The name of the catalog v2 (string)
ResourceVersion string: (Computed) The k8s resource version (string)
SecretName string: K8s secret name to be used to connect to the repo (string)
SecretNamespace string: K8s secret namespace (string)
ServiceAccount string: K8s service account used to deploy charts instead of the end users credentials (string)
ServiceAccountNamespace string: The username to access the catalog if needed (string)
Url string: URL to an index generated by Helm. Conflicts with git_repo (string)

Annotations map[string]interface{}: Annotations for the catalog v2 (map)
CaBundle string: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
ClusterId string: The cluster id of the catalog V2 (string)
Enabled bool: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
GitBranch string: Git Repository branch containing Helm chart definitions. Default master (string)
GitRepo string: The url of the catalog v2 repo. Conflicts with url (string)
Insecure bool: Use insecure HTTPS to download the repo's index. Default: false (bool)
Labels map[string]interface{}: Labels for the catalog v2 (map)
Name string: The name of the catalog v2 (string)
ResourceVersion string: (Computed) The k8s resource version (string)
SecretName string: K8s secret name to be used to connect to the repo (string)
SecretNamespace string: K8s secret namespace (string)
ServiceAccount string: K8s service account used to deploy charts instead of the end users credentials (string)
ServiceAccountNamespace string: The username to access the catalog if needed (string)
Url string: URL to an index generated by Helm. Conflicts with git_repo (string)

annotations Map<String,Object>: Annotations for the catalog v2 (map)
caBundle String: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
clusterId String: The cluster id of the catalog V2 (string)
enabled Boolean: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
gitBranch String: Git Repository branch containing Helm chart definitions. Default master (string)
gitRepo String: The url of the catalog v2 repo. Conflicts with url (string)
insecure Boolean: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels Map<String,Object>: Labels for the catalog v2 (map)
name String: The name of the catalog v2 (string)
resourceVersion String: (Computed) The k8s resource version (string)
secretName String: K8s secret name to be used to connect to the repo (string)
secretNamespace String: K8s secret namespace (string)
serviceAccount String: K8s service account used to deploy charts instead of the end users credentials (string)
serviceAccountNamespace String: The username to access the catalog if needed (string)
url String: URL to an index generated by Helm. Conflicts with git_repo (string)

annotations {[key: string]: any}: Annotations for the catalog v2 (map)
caBundle string: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
clusterId string: The cluster id of the catalog V2 (string)
enabled boolean: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
gitBranch string: Git Repository branch containing Helm chart definitions. Default master (string)
gitRepo string: The url of the catalog v2 repo. Conflicts with url (string)
insecure boolean: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels {[key: string]: any}: Labels for the catalog v2 (map)
name string: The name of the catalog v2 (string)
resourceVersion string: (Computed) The k8s resource version (string)
secretName string: K8s secret name to be used to connect to the repo (string)
secretNamespace string: K8s secret namespace (string)
serviceAccount string: K8s service account used to deploy charts instead of the end users credentials (string)
serviceAccountNamespace string: The username to access the catalog if needed (string)
url string: URL to an index generated by Helm. Conflicts with git_repo (string)

annotations Mapping[str, Any]: Annotations for the catalog v2 (map)
ca_bundle str: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
cluster_id str: The cluster id of the catalog V2 (string)
enabled bool: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
git_branch str: Git Repository branch containing Helm chart definitions. Default master (string)
git_repo str: The url of the catalog v2 repo. Conflicts with url (string)
insecure bool: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels Mapping[str, Any]: Labels for the catalog v2 (map)
name str: The name of the catalog v2 (string)
resource_version str: (Computed) The k8s resource version (string)
secret_name str: K8s secret name to be used to connect to the repo (string)
secret_namespace str: K8s secret namespace (string)
service_account str: K8s service account used to deploy charts instead of the end users credentials (string)
service_account_namespace str: The username to access the catalog if needed (string)
url str: URL to an index generated by Helm. Conflicts with git_repo (string)

annotations Map<Any>: Annotations for the catalog v2 (map)
caBundle String: PEM encoded CA bundle which will be used to validate the repo's certificate (string)
clusterId String: The cluster id of the catalog V2 (string)
enabled Boolean: If disabled the repo clone will not be updated or allowed to be installed from. Default: true (bool)
gitBranch String: Git Repository branch containing Helm chart definitions. Default master (string)
gitRepo String: The url of the catalog v2 repo. Conflicts with url (string)
insecure Boolean: Use insecure HTTPS to download the repo's index. Default: false (bool)
labels Map<Any>: Labels for the catalog v2 (map)
name String: The name of the catalog v2 (string)
resourceVersion String: (Computed) The k8s resource version (string)
secretName String: K8s secret name to be used to connect to the repo (string)
secretNamespace String: K8s secret namespace (string)
serviceAccount String: K8s service account used to deploy charts instead of the end users credentials (string)
serviceAccountNamespace String: The username to access the catalog if needed (string)
url String: URL to an index generated by Helm. Conflicts with git_repo (string)

Import

V2 catalogs can be imported using the Rancher cluster ID and Catalog V2 name.

 $ pulumi import rancher2:index/catalogV2:CatalogV2 foo &lt;CLUSTER_ID&gt;.&lt;CATALOG_V2_NAME&gt;

Package Details

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