Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Rancher 2
  5. getRegistry

getRegistry

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

Depending of the availability, there are 2 types of Rancher v2 docker registries: - Project registry: Available to all namespaces in the project_id - Namespaced registry: Available to just namespace_id in the project_id

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Rancher2.GetRegistry.InvokeAsync(new Rancher2.GetRegistryArgs
        {
            Name = "<name>",
            ProjectId = "<project_id>",
        }));
    }

}

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.LookupRegistry(ctx, &rancher2.LookupRegistryArgs{
            Name:      "<name>",
            ProjectId: "<project_id>",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_registry(name="<name>",
    project_id="<project_id>")
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Retrieve a rancher2 Project Registry
const foo = pulumi.output(rancher2.getRegistry({
    name: "<name>",
    projectId: "<project_id>",
}, { async: true }));

Using getRegistry

function getRegistry(args: GetRegistryArgs, opts?: InvokeOptions): Promise<GetRegistryResult>
def get_registry(name: Optional[str] = None, namespace_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetRegistryResult
func LookupRegistry(ctx *Context, args *LookupRegistryArgs, opts ...InvokeOption) (*LookupRegistryResult, error)

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

public static class GetRegistry {
    public static Task<GetRegistryResult> InvokeAsync(GetRegistryArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the registry (string)

ProjectId string

The project id where to assign the registry (string)

NamespaceId string

The namespace id where to assign the namespaced registry (string)

Name string

The name of the registry (string)

ProjectId string

The project id where to assign the registry (string)

NamespaceId string

The namespace id where to assign the namespaced registry (string)

name string

The name of the registry (string)

projectId string

The project id where to assign the registry (string)

namespaceId string

The namespace id where to assign the namespaced registry (string)

name str

The name of the registry (string)

project_id str

The project id where to assign the registry (string)

namespace_id str

The namespace id where to assign the namespaced registry (string)

getRegistry Result

The following output properties are available:

Annotations Dictionary<string, object>

(Computed) Annotations for Registry object (map)

Description string

(Computed) A registry description (string)

Id string

The provider-assigned unique ID for this managed resource.

Labels Dictionary<string, object>

(Computed) Labels for Registry object (map)

Name string
ProjectId string
Registries List<GetRegistryRegistry>

(Computed) Registries data for registry (list)

NamespaceId string
Annotations map[string]interface{}

(Computed) Annotations for Registry object (map)

Description string

(Computed) A registry description (string)

Id string

The provider-assigned unique ID for this managed resource.

Labels map[string]interface{}

(Computed) Labels for Registry object (map)

Name string
ProjectId string
Registries []GetRegistryRegistry

(Computed) Registries data for registry (list)

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

(Computed) Annotations for Registry object (map)

description string

(Computed) A registry description (string)

id string

The provider-assigned unique ID for this managed resource.

labels {[key: string]: any}

(Computed) Labels for Registry object (map)

name string
projectId string
registries GetRegistryRegistry[]

(Computed) Registries data for registry (list)

namespaceId string
annotations Mapping[str, Any]

(Computed) Annotations for Registry object (map)

description str

(Computed) A registry description (string)

id str

The provider-assigned unique ID for this managed resource.

labels Mapping[str, Any]

(Computed) Labels for Registry object (map)

name str
project_id str
registries Sequence[GetRegistryRegistry]

(Computed) Registries data for registry (list)

namespace_id str

Supporting Types

GetRegistryRegistry

Address string
Password string
Username string
Address string
Password string
Username string
address string
password string
username string

Package Details

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