1. Packages
  2. Qovery
  3. API Docs
  4. ContainerRegistry
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

qovery.ContainerRegistry

Explore with Pulumi AI

qovery logo
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

    # qovery.ContainerRegistry (Resource)

    Provides a Qovery container registry resource. This can be used to create and manage Qovery container registry.

    Example

    import * as pulumi from "@pulumi/pulumi";
    import * as qovery from "@ediri/qovery";
    
    const myContainerRegistry = new qovery.ContainerRegistry("myContainerRegistry", {
        organizationId: qovery_organization.my_organization.id,
        kind: "DOCKER_HUB",
        url: "https://docker.io",
        config: {
            username: "<my_username>",
            password: "<my_password>",
        },
        description: "My Docker Hub Registry",
    }, {
        dependsOn: [qovery_organization.my_organization],
    });
    
    import pulumi
    import ediri_qovery as qovery
    
    my_container_registry = qovery.ContainerRegistry("myContainerRegistry",
        organization_id=qovery_organization["my_organization"]["id"],
        kind="DOCKER_HUB",
        url="https://docker.io",
        config=qovery.ContainerRegistryConfigArgs(
            username="<my_username>",
            password="<my_password>",
        ),
        description="My Docker Hub Registry",
        opts=pulumi.ResourceOptions(depends_on=[qovery_organization["my_organization"]]))
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Qovery = ediri.Qovery;
    
    return await Deployment.RunAsync(() => 
    {
        var myContainerRegistry = new Qovery.ContainerRegistry("myContainerRegistry", new()
        {
            OrganizationId = qovery_organization.My_organization.Id,
            Kind = "DOCKER_HUB",
            Url = "https://docker.io",
            Config = new Qovery.Inputs.ContainerRegistryConfigArgs
            {
                Username = "<my_username>",
                Password = "<my_password>",
            },
            Description = "My Docker Hub Registry",
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                qovery_organization.My_organization,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/dirien/pulumi-qovery/sdk/go/qovery"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := qovery.NewContainerRegistry(ctx, "myContainerRegistry", &qovery.ContainerRegistryArgs{
    			OrganizationId: pulumi.Any(qovery_organization.My_organization.Id),
    			Kind:           pulumi.String("DOCKER_HUB"),
    			Url:            pulumi.String("https://docker.io"),
    			Config: &qovery.ContainerRegistryConfigArgs{
    				Username: pulumi.String("<my_username>"),
    				Password: pulumi.String("<my_password>"),
    			},
    			Description: pulumi.String("My Docker Hub Registry"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			qovery_organization.My_organization,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.qovery.ContainerRegistry;
    import com.pulumi.qovery.ContainerRegistryArgs;
    import com.pulumi.qovery.inputs.ContainerRegistryConfigArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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) {
            var myContainerRegistry = new ContainerRegistry("myContainerRegistry", ContainerRegistryArgs.builder()        
                .organizationId(qovery_organization.my_organization().id())
                .kind("DOCKER_HUB")
                .url("https://docker.io")
                .config(ContainerRegistryConfigArgs.builder()
                    .username("<my_username>")
                    .password("<my_password>")
                    .build())
                .description("My Docker Hub Registry")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(qovery_organization.my_organization())
                    .build());
    
        }
    }
    
    resources:
      myContainerRegistry:
        type: qovery:ContainerRegistry
        properties:
          # Required
          organizationId: ${qovery_organization.my_organization.id}
          kind: DOCKER_HUB
          url: https://docker.io
          config:
            username: <my_username>
            password: <my_password>
          # Optional
          description: My Docker Hub Registry
        options:
          dependson:
            - ${qovery_organization.my_organization}
    

    Create ContainerRegistry Resource

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

    Constructor syntax

    new ContainerRegistry(name: string, args: ContainerRegistryArgs, opts?: CustomResourceOptions);
    @overload
    def ContainerRegistry(resource_name: str,
                          args: ContainerRegistryArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ContainerRegistry(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          kind: Optional[str] = None,
                          organization_id: Optional[str] = None,
                          url: Optional[str] = None,
                          config: Optional[ContainerRegistryConfigArgs] = None,
                          description: Optional[str] = None,
                          name: Optional[str] = None)
    func NewContainerRegistry(ctx *Context, name string, args ContainerRegistryArgs, opts ...ResourceOption) (*ContainerRegistry, error)
    public ContainerRegistry(string name, ContainerRegistryArgs args, CustomResourceOptions? opts = null)
    public ContainerRegistry(String name, ContainerRegistryArgs args)
    public ContainerRegistry(String name, ContainerRegistryArgs args, CustomResourceOptions options)
    
    type: qovery:ContainerRegistry
    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 ContainerRegistryArgs
    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 ContainerRegistryArgs
    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 ContainerRegistryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContainerRegistryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContainerRegistryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var containerRegistryResource = new Qovery.ContainerRegistry("containerRegistryResource", new()
    {
        Kind = "string",
        OrganizationId = "string",
        Url = "string",
        Config = new Qovery.Inputs.ContainerRegistryConfigArgs
        {
            AccessKeyId = "string",
            Password = "string",
            Region = "string",
            ScalewayAccessKey = "string",
            ScalewaySecretKey = "string",
            SecretAccessKey = "string",
            Username = "string",
        },
        Description = "string",
        Name = "string",
    });
    
    example, err := qovery.NewContainerRegistry(ctx, "containerRegistryResource", &qovery.ContainerRegistryArgs{
    	Kind:           pulumi.String("string"),
    	OrganizationId: pulumi.String("string"),
    	Url:            pulumi.String("string"),
    	Config: &qovery.ContainerRegistryConfigArgs{
    		AccessKeyId:       pulumi.String("string"),
    		Password:          pulumi.String("string"),
    		Region:            pulumi.String("string"),
    		ScalewayAccessKey: pulumi.String("string"),
    		ScalewaySecretKey: pulumi.String("string"),
    		SecretAccessKey:   pulumi.String("string"),
    		Username:          pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var containerRegistryResource = new ContainerRegistry("containerRegistryResource", ContainerRegistryArgs.builder()        
        .kind("string")
        .organizationId("string")
        .url("string")
        .config(ContainerRegistryConfigArgs.builder()
            .accessKeyId("string")
            .password("string")
            .region("string")
            .scalewayAccessKey("string")
            .scalewaySecretKey("string")
            .secretAccessKey("string")
            .username("string")
            .build())
        .description("string")
        .name("string")
        .build());
    
    container_registry_resource = qovery.ContainerRegistry("containerRegistryResource",
        kind="string",
        organization_id="string",
        url="string",
        config=qovery.ContainerRegistryConfigArgs(
            access_key_id="string",
            password="string",
            region="string",
            scaleway_access_key="string",
            scaleway_secret_key="string",
            secret_access_key="string",
            username="string",
        ),
        description="string",
        name="string")
    
    const containerRegistryResource = new qovery.ContainerRegistry("containerRegistryResource", {
        kind: "string",
        organizationId: "string",
        url: "string",
        config: {
            accessKeyId: "string",
            password: "string",
            region: "string",
            scalewayAccessKey: "string",
            scalewaySecretKey: "string",
            secretAccessKey: "string",
            username: "string",
        },
        description: "string",
        name: "string",
    });
    
    type: qovery:ContainerRegistry
    properties:
        config:
            accessKeyId: string
            password: string
            region: string
            scalewayAccessKey: string
            scalewaySecretKey: string
            secretAccessKey: string
            username: string
        description: string
        kind: string
        name: string
        organizationId: string
        url: string
    

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

    Kind string
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    OrganizationId string
    Id of the organization.
    Url string
    URL of the container registry.
    Config ediri.Qovery.Inputs.ContainerRegistryConfig
    Configuration needed to authenticate the container registry.
    Description string
    Description of the container registry.
    Name string
    Name of the container registry.
    Kind string
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    OrganizationId string
    Id of the organization.
    Url string
    URL of the container registry.
    Config ContainerRegistryConfigArgs
    Configuration needed to authenticate the container registry.
    Description string
    Description of the container registry.
    Name string
    Name of the container registry.
    kind String
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    organizationId String
    Id of the organization.
    url String
    URL of the container registry.
    config ContainerRegistryConfig
    Configuration needed to authenticate the container registry.
    description String
    Description of the container registry.
    name String
    Name of the container registry.
    kind string
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    organizationId string
    Id of the organization.
    url string
    URL of the container registry.
    config ContainerRegistryConfig
    Configuration needed to authenticate the container registry.
    description string
    Description of the container registry.
    name string
    Name of the container registry.
    kind str
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    organization_id str
    Id of the organization.
    url str
    URL of the container registry.
    config ContainerRegistryConfigArgs
    Configuration needed to authenticate the container registry.
    description str
    Description of the container registry.
    name str
    Name of the container registry.
    kind String
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    organizationId String
    Id of the organization.
    url String
    URL of the container registry.
    config Property Map
    Configuration needed to authenticate the container registry.
    description String
    Description of the container registry.
    name String
    Name of the container registry.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ContainerRegistry Resource

    Get an existing ContainerRegistry 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?: ContainerRegistryState, opts?: CustomResourceOptions): ContainerRegistry
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            config: Optional[ContainerRegistryConfigArgs] = None,
            description: Optional[str] = None,
            kind: Optional[str] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            url: Optional[str] = None) -> ContainerRegistry
    func GetContainerRegistry(ctx *Context, name string, id IDInput, state *ContainerRegistryState, opts ...ResourceOption) (*ContainerRegistry, error)
    public static ContainerRegistry Get(string name, Input<string> id, ContainerRegistryState? state, CustomResourceOptions? opts = null)
    public static ContainerRegistry get(String name, Output<String> id, ContainerRegistryState 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:
    Config ediri.Qovery.Inputs.ContainerRegistryConfig
    Configuration needed to authenticate the container registry.
    Description string
    Description of the container registry.
    Kind string
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    Name string
    Name of the container registry.
    OrganizationId string
    Id of the organization.
    Url string
    URL of the container registry.
    Config ContainerRegistryConfigArgs
    Configuration needed to authenticate the container registry.
    Description string
    Description of the container registry.
    Kind string
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    Name string
    Name of the container registry.
    OrganizationId string
    Id of the organization.
    Url string
    URL of the container registry.
    config ContainerRegistryConfig
    Configuration needed to authenticate the container registry.
    description String
    Description of the container registry.
    kind String
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    name String
    Name of the container registry.
    organizationId String
    Id of the organization.
    url String
    URL of the container registry.
    config ContainerRegistryConfig
    Configuration needed to authenticate the container registry.
    description string
    Description of the container registry.
    kind string
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    name string
    Name of the container registry.
    organizationId string
    Id of the organization.
    url string
    URL of the container registry.
    config ContainerRegistryConfigArgs
    Configuration needed to authenticate the container registry.
    description str
    Description of the container registry.
    kind str
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    name str
    Name of the container registry.
    organization_id str
    Id of the organization.
    url str
    URL of the container registry.
    config Property Map
    Configuration needed to authenticate the container registry.
    description String
    Description of the container registry.
    kind String
    Kind of the container registry. - Can be: DOCKER_HUB, DOCR, ECR, GCP_ARTIFACT_REGISTRY, GENERIC_CR, GITHUB_CR, GITLAB_CR, PUBLIC_ECR, SCALEWAY_CR.
    name String
    Name of the container registry.
    organizationId String
    Id of the organization.
    url String
    URL of the container registry.

    Supporting Types

    ContainerRegistryConfig, ContainerRegistryConfigArgs

    AccessKeyId string
    Required if kind is ECR or PUBLIC_ECR.
    Password string
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    Region string
    Required if kind is ECR or SCALEWAY_CR.
    ScalewayAccessKey string
    Required if kind is SCALEWAY_CR.
    ScalewaySecretKey string
    Required if kind is SCALEWAY_CR.
    SecretAccessKey string
    Required if kind is ECR or PUBLIC_ECR.
    Username string
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    AccessKeyId string
    Required if kind is ECR or PUBLIC_ECR.
    Password string
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    Region string
    Required if kind is ECR or SCALEWAY_CR.
    ScalewayAccessKey string
    Required if kind is SCALEWAY_CR.
    ScalewaySecretKey string
    Required if kind is SCALEWAY_CR.
    SecretAccessKey string
    Required if kind is ECR or PUBLIC_ECR.
    Username string
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    accessKeyId String
    Required if kind is ECR or PUBLIC_ECR.
    password String
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    region String
    Required if kind is ECR or SCALEWAY_CR.
    scalewayAccessKey String
    Required if kind is SCALEWAY_CR.
    scalewaySecretKey String
    Required if kind is SCALEWAY_CR.
    secretAccessKey String
    Required if kind is ECR or PUBLIC_ECR.
    username String
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    accessKeyId string
    Required if kind is ECR or PUBLIC_ECR.
    password string
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    region string
    Required if kind is ECR or SCALEWAY_CR.
    scalewayAccessKey string
    Required if kind is SCALEWAY_CR.
    scalewaySecretKey string
    Required if kind is SCALEWAY_CR.
    secretAccessKey string
    Required if kind is ECR or PUBLIC_ECR.
    username string
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    access_key_id str
    Required if kind is ECR or PUBLIC_ECR.
    password str
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    region str
    Required if kind is ECR or SCALEWAY_CR.
    scaleway_access_key str
    Required if kind is SCALEWAY_CR.
    scaleway_secret_key str
    Required if kind is SCALEWAY_CR.
    secret_access_key str
    Required if kind is ECR or PUBLIC_ECR.
    username str
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    accessKeyId String
    Required if kind is ECR or PUBLIC_ECR.
    password String
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.
    region String
    Required if kind is ECR or SCALEWAY_CR.
    scalewayAccessKey String
    Required if kind is SCALEWAY_CR.
    scalewaySecretKey String
    Required if kind is SCALEWAY_CR.
    secretAccessKey String
    Required if kind is ECR or PUBLIC_ECR.
    username String
    Required if kinds are DOCKER_HUB, GITHUB_CR, GITLABCR, GENERIC_CR`.

    Import

     $ pulumi import qovery:index/containerRegistry:ContainerRegistry my_container_registry "<organization_id>,<container_registry_id>"
    

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

    Package Details

    Repository
    qovery dirien/pulumi-qovery
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the qovery Terraform Provider.
    qovery logo
    Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien