Docs Packages
  1. Packages
  2. Qovery
  3. API Docs
  4. HelmRepository
Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien
dirien/pulumi-qovery

qovery.HelmRepository

Explore with Pulumi AI

qovery logo
Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien
dirien/pulumi-qovery

    # qovery.HelmRepository (Resource)

    Provides a Qovery helm repository resource. This can be used to create and manage Qovery helm repository.

    Example

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  myHelmRepository:
    type: qovery:HelmRepository
    properties:
      # Required
      organizationId: ${qovery_organization.my_organization.id}
      kind: OCI_DOCKER_HUB
      url: https://docker.io
      skipTlsCertificate: false
      # Optional
      description: My Helm repository
      config:
        username: <my_username>
        password: <my_password>
    options:
      dependson:
        - ${qovery_organization.my_organization}

    Create HelmRepository Resource

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

    Constructor syntax

    new HelmRepository(name: string, args: HelmRepositoryArgs, opts?: CustomResourceOptions);
    @overload
def HelmRepository(resource_name: str,
                   args: HelmRepositoryArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def HelmRepository(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   kind: Optional[str] = None,
                   organization_id: Optional[str] = None,
                   skip_tls_verification: Optional[bool] = None,
                   url: Optional[str] = None,
                   config: Optional[HelmRepositoryConfigArgs] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None)
    func NewHelmRepository(ctx *Context, name string, args HelmRepositoryArgs, opts ...ResourceOption) (*HelmRepository, error)
    public HelmRepository(string name, HelmRepositoryArgs args, CustomResourceOptions? opts = null)
    public HelmRepository(String name, HelmRepositoryArgs args)
public HelmRepository(String name, HelmRepositoryArgs args, CustomResourceOptions options)

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

    Constructor example

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

    var helmRepositoryResource = new Qovery.HelmRepository("helmRepositoryResource", new()
{
    Kind = "string",
    OrganizationId = "string",
    SkipTlsVerification = false,
    Url = "string",
    Config = new Qovery.Inputs.HelmRepositoryConfigArgs
    {
        AccessKeyId = "string",
        Password = "string",
        Region = "string",
        ScalewayAccessKey = "string",
        ScalewaySecretKey = "string",
        SecretAccessKey = "string",
        Username = "string",
    },
    Description = "string",
    Name = "string",
});

    example, err := qovery.NewHelmRepository(ctx, "helmRepositoryResource", &qovery.HelmRepositoryArgs{
	Kind:                pulumi.String("string"),
	OrganizationId:      pulumi.String("string"),
	SkipTlsVerification: pulumi.Bool(false),
	Url:                 pulumi.String("string"),
	Config: &qovery.HelmRepositoryConfigArgs{
		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 helmRepositoryResource = new HelmRepository("helmRepositoryResource", HelmRepositoryArgs.builder()
    .kind("string")
    .organizationId("string")
    .skipTlsVerification(false)
    .url("string")
    .config(HelmRepositoryConfigArgs.builder()
        .accessKeyId("string")
        .password("string")
        .region("string")
        .scalewayAccessKey("string")
        .scalewaySecretKey("string")
        .secretAccessKey("string")
        .username("string")
        .build())
    .description("string")
    .name("string")
    .build());

    helm_repository_resource = qovery.HelmRepository("helmRepositoryResource",
    kind="string",
    organization_id="string",
    skip_tls_verification=False,
    url="string",
    config=qovery.HelmRepositoryConfigArgs(
        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 helmRepositoryResource = new qovery.HelmRepository("helmRepositoryResource", {
    kind: "string",
    organizationId: "string",
    skipTlsVerification: false,
    url: "string",
    config: {
        accessKeyId: "string",
        password: "string",
        region: "string",
        scalewayAccessKey: "string",
        scalewaySecretKey: "string",
        secretAccessKey: "string",
        username: "string",
    },
    description: "string",
    name: "string",
});

    type: qovery:HelmRepository
properties:
    config:
        accessKeyId: string
        password: string
        region: string
        scalewayAccessKey: string
        scalewaySecretKey: string
        secretAccessKey: string
        username: string
    description: string
    kind: string
    name: string
    organizationId: string
    skipTlsVerification: false
    url: string

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

    Kind string
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    OrganizationId string
    Id of the organization.
    SkipTlsVerification bool
    Bypass tls certificate verification when connecting to repository
    Url string
    URL of the helm repository.
    Config ediri.Qovery.Inputs.HelmRepositoryConfig
    Configuration needed to authenticate the helm repository.
    Description string
    Description of the helm repository.
    Name string
    Name of the helm repository.
    Kind string
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    OrganizationId string
    Id of the organization.
    SkipTlsVerification bool
    Bypass tls certificate verification when connecting to repository
    Url string
    URL of the helm repository.
    Config HelmRepositoryConfigArgs
    Configuration needed to authenticate the helm repository.
    Description string
    Description of the helm repository.
    Name string
    Name of the helm repository.
    kind String
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    organizationId String
    Id of the organization.
    skipTlsVerification Boolean
    Bypass tls certificate verification when connecting to repository
    url String
    URL of the helm repository.
    config HelmRepositoryConfig
    Configuration needed to authenticate the helm repository.
    description String
    Description of the helm repository.
    name String
    Name of the helm repository.
    kind string
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    organizationId string
    Id of the organization.
    skipTlsVerification boolean
    Bypass tls certificate verification when connecting to repository
    url string
    URL of the helm repository.
    config HelmRepositoryConfig
    Configuration needed to authenticate the helm repository.
    description string
    Description of the helm repository.
    name string
    Name of the helm repository.
    kind str
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    organization_id str
    Id of the organization.
    skip_tls_verification bool
    Bypass tls certificate verification when connecting to repository
    url str
    URL of the helm repository.
    config HelmRepositoryConfigArgs
    Configuration needed to authenticate the helm repository.
    description str
    Description of the helm repository.
    name str
    Name of the helm repository.
    kind String
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    organizationId String
    Id of the organization.
    skipTlsVerification Boolean
    Bypass tls certificate verification when connecting to repository
    url String
    URL of the helm repository.
    config Property Map
    Configuration needed to authenticate the helm repository.
    description String
    Description of the helm repository.
    name String
    Name of the helm repository.

    Outputs

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

    Get an existing HelmRepository 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?: HelmRepositoryState, opts?: CustomResourceOptions): HelmRepository
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[HelmRepositoryConfigArgs] = None,
        description: Optional[str] = None,
        kind: Optional[str] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        skip_tls_verification: Optional[bool] = None,
        url: Optional[str] = None) -> HelmRepository
    func GetHelmRepository(ctx *Context, name string, id IDInput, state *HelmRepositoryState, opts ...ResourceOption) (*HelmRepository, error)
    public static HelmRepository Get(string name, Input<string> id, HelmRepositoryState? state, CustomResourceOptions? opts = null)
    public static HelmRepository get(String name, Output<String> id, HelmRepositoryState 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.HelmRepositoryConfig
    Configuration needed to authenticate the helm repository.
    Description string
    Description of the helm repository.
    Kind string
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    Name string
    Name of the helm repository.
    OrganizationId string
    Id of the organization.
    SkipTlsVerification bool
    Bypass tls certificate verification when connecting to repository
    Url string
    URL of the helm repository.
    Config HelmRepositoryConfigArgs
    Configuration needed to authenticate the helm repository.
    Description string
    Description of the helm repository.
    Kind string
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    Name string
    Name of the helm repository.
    OrganizationId string
    Id of the organization.
    SkipTlsVerification bool
    Bypass tls certificate verification when connecting to repository
    Url string
    URL of the helm repository.
    config HelmRepositoryConfig
    Configuration needed to authenticate the helm repository.
    description String
    Description of the helm repository.
    kind String
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    name String
    Name of the helm repository.
    organizationId String
    Id of the organization.
    skipTlsVerification Boolean
    Bypass tls certificate verification when connecting to repository
    url String
    URL of the helm repository.
    config HelmRepositoryConfig
    Configuration needed to authenticate the helm repository.
    description string
    Description of the helm repository.
    kind string
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    name string
    Name of the helm repository.
    organizationId string
    Id of the organization.
    skipTlsVerification boolean
    Bypass tls certificate verification when connecting to repository
    url string
    URL of the helm repository.
    config HelmRepositoryConfigArgs
    Configuration needed to authenticate the helm repository.
    description str
    Description of the helm repository.
    kind str
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    name str
    Name of the helm repository.
    organization_id str
    Id of the organization.
    skip_tls_verification bool
    Bypass tls certificate verification when connecting to repository
    url str
    URL of the helm repository.
    config Property Map
    Configuration needed to authenticate the helm repository.
    description String
    Description of the helm repository.
    kind String
    Kind of the helm repository. - Can be: HTTPS, OCI_DOCKER_HUB, OCI_DOCR, OCI_ECR, OCI_GENERIC_CR, OCI_GITHUB_CR, OCI_GITLAB_CR, OCI_PUBLIC_ECR, OCI_SCALEWAY_CR.
    name String
    Name of the helm repository.
    organizationId String
    Id of the organization.
    skipTlsVerification Boolean
    Bypass tls certificate verification when connecting to repository
    url String
    URL of the helm repository.

    Supporting Types

    HelmRepositoryConfig, HelmRepositoryConfigArgs

    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/helmRepository:HelmRepository my_helm_repository "<organization_id>,<helm_repository_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.10 published on Friday, Jun 7, 2024 by dirien
    dirien/pulumi-qovery