1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. DockerConnector
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.DockerConnector

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Resource for creating a Docker connector.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        // credentials username password
        var test = new Harness.Platform.DockerConnector("test", new()
        {
            Credentials = new Harness.Platform.Inputs.DockerConnectorCredentialsArgs
            {
                PasswordRef = "account.secret_id",
                Username = "admin",
            },
            DelegateSelectors = new[]
            {
                "harness-delegate",
            },
            Description = "test",
            Identifier = "identifer",
            Tags = new[]
            {
                "foo:bar",
            },
            Type = "DockerHub",
            Url = "https://hub.docker.com",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewDockerConnector(ctx, "test", &platform.DockerConnectorArgs{
    			Credentials: &platform.DockerConnectorCredentialsArgs{
    				PasswordRef: pulumi.String("account.secret_id"),
    				Username:    pulumi.String("admin"),
    			},
    			DelegateSelectors: pulumi.StringArray{
    				pulumi.String("harness-delegate"),
    			},
    			Description: pulumi.String("test"),
    			Identifier:  pulumi.String("identifer"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    			},
    			Type: pulumi.String("DockerHub"),
    			Url:  pulumi.String("https://hub.docker.com"),
    		})
    		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.harness.platform.DockerConnector;
    import com.pulumi.harness.platform.DockerConnectorArgs;
    import com.pulumi.harness.platform.inputs.DockerConnectorCredentialsArgs;
    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 test = new DockerConnector("test", DockerConnectorArgs.builder()        
                .credentials(DockerConnectorCredentialsArgs.builder()
                    .passwordRef("account.secret_id")
                    .username("admin")
                    .build())
                .delegateSelectors("harness-delegate")
                .description("test")
                .identifier("identifer")
                .tags("foo:bar")
                .type("DockerHub")
                .url("https://hub.docker.com")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    # credentials username password
    test = harness.platform.DockerConnector("test",
        credentials=harness.platform.DockerConnectorCredentialsArgs(
            password_ref="account.secret_id",
            username="admin",
        ),
        delegate_selectors=["harness-delegate"],
        description="test",
        identifier="identifer",
        tags=["foo:bar"],
        type="DockerHub",
        url="https://hub.docker.com")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@lbrlabs/pulumi-harness";
    
    // credentials username password
    const test = new harness.platform.DockerConnector("test", {
        credentials: {
            passwordRef: "account.secret_id",
            username: "admin",
        },
        delegateSelectors: ["harness-delegate"],
        description: "test",
        identifier: "identifer",
        tags: ["foo:bar"],
        type: "DockerHub",
        url: "https://hub.docker.com",
    });
    
    resources:
      # credentials username password
      test:
        type: harness:platform:DockerConnector
        properties:
          credentials:
            passwordRef: account.secret_id
            username: admin
          delegateSelectors:
            - harness-delegate
          description: test
          identifier: identifer
          tags:
            - foo:bar
          type: DockerHub
          url: https://hub.docker.com
    

    Create DockerConnector Resource

    new DockerConnector(name: string, args: DockerConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def DockerConnector(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        credentials: Optional[DockerConnectorCredentialsArgs] = None,
                        delegate_selectors: Optional[Sequence[str]] = None,
                        description: Optional[str] = None,
                        identifier: Optional[str] = None,
                        name: Optional[str] = None,
                        org_id: Optional[str] = None,
                        project_id: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None,
                        type: Optional[str] = None,
                        url: Optional[str] = None)
    @overload
    def DockerConnector(resource_name: str,
                        args: DockerConnectorArgs,
                        opts: Optional[ResourceOptions] = None)
    func NewDockerConnector(ctx *Context, name string, args DockerConnectorArgs, opts ...ResourceOption) (*DockerConnector, error)
    public DockerConnector(string name, DockerConnectorArgs args, CustomResourceOptions? opts = null)
    public DockerConnector(String name, DockerConnectorArgs args)
    public DockerConnector(String name, DockerConnectorArgs args, CustomResourceOptions options)
    
    type: harness:platform:DockerConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DockerConnectorArgs
    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 DockerConnectorArgs
    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 DockerConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DockerConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DockerConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Identifier string

    Unique identifier of the resource.

    Type string

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    Url string

    The URL of the docker registry.

    Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.DockerConnectorCredentials

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    DelegateSelectors List<string>

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    Tags List<string>

    Tags to associate with the resource.

    Identifier string

    Unique identifier of the resource.

    Type string

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    Url string

    The URL of the docker registry.

    Credentials DockerConnectorCredentialsArgs

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    DelegateSelectors []string

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    Tags []string

    Tags to associate with the resource.

    identifier String

    Unique identifier of the resource.

    type String

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url String

    The URL of the docker registry.

    credentials DockerConnectorCredentials

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    tags List<String>

    Tags to associate with the resource.

    identifier string

    Unique identifier of the resource.

    type string

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url string

    The URL of the docker registry.

    credentials DockerConnectorCredentials

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegateSelectors string[]

    Tags to filter delegates for connection.

    description string

    Description of the resource.

    name string

    Name of the resource.

    orgId string

    Unique identifier of the organization.

    projectId string

    Unique identifier of the project.

    tags string[]

    Tags to associate with the resource.

    identifier str

    Unique identifier of the resource.

    type str

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url str

    The URL of the docker registry.

    credentials DockerConnectorCredentialsArgs

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegate_selectors Sequence[str]

    Tags to filter delegates for connection.

    description str

    Description of the resource.

    name str

    Name of the resource.

    org_id str

    Unique identifier of the organization.

    project_id str

    Unique identifier of the project.

    tags Sequence[str]

    Tags to associate with the resource.

    identifier String

    Unique identifier of the resource.

    type String

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url String

    The URL of the docker registry.

    credentials Property Map

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    tags List<String>

    Tags to associate with the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DockerConnector 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 DockerConnector Resource

    Get an existing DockerConnector 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?: DockerConnectorState, opts?: CustomResourceOptions): DockerConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials: Optional[DockerConnectorCredentialsArgs] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            type: Optional[str] = None,
            url: Optional[str] = None) -> DockerConnector
    func GetDockerConnector(ctx *Context, name string, id IDInput, state *DockerConnectorState, opts ...ResourceOption) (*DockerConnector, error)
    public static DockerConnector Get(string name, Input<string> id, DockerConnectorState? state, CustomResourceOptions? opts = null)
    public static DockerConnector get(String name, Output<String> id, DockerConnectorState 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:
    Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.DockerConnectorCredentials

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    DelegateSelectors List<string>

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    Identifier string

    Unique identifier of the resource.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    Tags List<string>

    Tags to associate with the resource.

    Type string

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    Url string

    The URL of the docker registry.

    Credentials DockerConnectorCredentialsArgs

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    DelegateSelectors []string

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    Identifier string

    Unique identifier of the resource.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    Tags []string

    Tags to associate with the resource.

    Type string

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    Url string

    The URL of the docker registry.

    credentials DockerConnectorCredentials

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    identifier String

    Unique identifier of the resource.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    tags List<String>

    Tags to associate with the resource.

    type String

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url String

    The URL of the docker registry.

    credentials DockerConnectorCredentials

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegateSelectors string[]

    Tags to filter delegates for connection.

    description string

    Description of the resource.

    identifier string

    Unique identifier of the resource.

    name string

    Name of the resource.

    orgId string

    Unique identifier of the organization.

    projectId string

    Unique identifier of the project.

    tags string[]

    Tags to associate with the resource.

    type string

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url string

    The URL of the docker registry.

    credentials DockerConnectorCredentialsArgs

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegate_selectors Sequence[str]

    Tags to filter delegates for connection.

    description str

    Description of the resource.

    identifier str

    Unique identifier of the resource.

    name str

    Name of the resource.

    org_id str

    Unique identifier of the organization.

    project_id str

    Unique identifier of the project.

    tags Sequence[str]

    Tags to associate with the resource.

    type str

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url str

    The URL of the docker registry.

    credentials Property Map

    The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    identifier String

    Unique identifier of the resource.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    tags List<String>

    Tags to associate with the resource.

    type String

    The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay

    url String

    The URL of the docker registry.

    Supporting Types

    DockerConnectorCredentials, DockerConnectorCredentialsArgs

    PasswordRef string

    The reference to the Harness secret containing the password to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    Username string

    The username to use for the docker registry.

    UsernameRef string

    The reference to the Harness secret containing the username to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    PasswordRef string

    The reference to the Harness secret containing the password to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    Username string

    The username to use for the docker registry.

    UsernameRef string

    The reference to the Harness secret containing the username to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    passwordRef String

    The reference to the Harness secret containing the password to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    username String

    The username to use for the docker registry.

    usernameRef String

    The reference to the Harness secret containing the username to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    passwordRef string

    The reference to the Harness secret containing the password to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    username string

    The username to use for the docker registry.

    usernameRef string

    The reference to the Harness secret containing the username to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    password_ref str

    The reference to the Harness secret containing the password to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    username str

    The username to use for the docker registry.

    username_ref str

    The reference to the Harness secret containing the username to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    passwordRef String

    The reference to the Harness secret containing the password to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    username String

    The username to use for the docker registry.

    usernameRef String

    The reference to the Harness secret containing the username to use for the docker registry. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    Import

    Import account level docker connector

     $ pulumi import harness:platform/dockerConnector:DockerConnector example <connector_id>
    

    Import org level docker connector

     $ pulumi import harness:platform/dockerConnector:DockerConnector example <ord_id>/<connector_id>
    

    Import project level docker connector

     $ pulumi import harness:platform/dockerConnector:DockerConnector example <org_id>/<project_id>/<connector_id>
    

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the harness Terraform Provider.

    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs