1. Packages
  2. Qovery
  3. API Docs
  4. HelmRepository
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien

qovery.HelmRepository

Explore with Pulumi AI

# qovery.HelmRepository (Resource)

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

Example

import * as pulumi from "@pulumi/pulumi";
import * as qovery from "@ediri/qovery";

const myHelmRepository = new qovery.HelmRepository("myHelmRepository", {
    organizationId: qovery_organization.my_organization.id,
    kind: "OCI_DOCKER_HUB",
    url: "https://docker.io",
    skipTlsVerification: false,
    description: "My Helm repository",
    config: {
        username: "<my_username>",
        password: "<my_password>",
    },
}, {
    dependsOn: [qovery_organization.my_organization],
});
Copy
import pulumi
import ediri_qovery as qovery

my_helm_repository = qovery.HelmRepository("myHelmRepository",
    organization_id=qovery_organization["my_organization"]["id"],
    kind="OCI_DOCKER_HUB",
    url="https://docker.io",
    skip_tls_verification=False,
    description="My Helm repository",
    config={
        "username": "<my_username>",
        "password": "<my_password>",
    },
    opts = pulumi.ResourceOptions(depends_on=[qovery_organization["my_organization"]]))
Copy
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.NewHelmRepository(ctx, "myHelmRepository", &qovery.HelmRepositoryArgs{
			OrganizationId:      pulumi.Any(qovery_organization.My_organization.Id),
			Kind:                pulumi.String("OCI_DOCKER_HUB"),
			Url:                 pulumi.String("https://docker.io"),
			SkipTlsVerification: pulumi.Bool(false),
			Description:         pulumi.String("My Helm repository"),
			Config: &qovery.HelmRepositoryConfigArgs{
				Username: pulumi.String("<my_username>"),
				Password: pulumi.String("<my_password>"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			qovery_organization.My_organization,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Qovery = ediri.Qovery;

return await Deployment.RunAsync(() => 
{
    var myHelmRepository = new Qovery.HelmRepository("myHelmRepository", new()
    {
        OrganizationId = qovery_organization.My_organization.Id,
        Kind = "OCI_DOCKER_HUB",
        Url = "https://docker.io",
        SkipTlsVerification = false,
        Description = "My Helm repository",
        Config = new Qovery.Inputs.HelmRepositoryConfigArgs
        {
            Username = "<my_username>",
            Password = "<my_password>",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            qovery_organization.My_organization,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.HelmRepository;
import com.pulumi.qovery.HelmRepositoryArgs;
import com.pulumi.qovery.inputs.HelmRepositoryConfigArgs;
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 myHelmRepository = new HelmRepository("myHelmRepository", HelmRepositoryArgs.builder()
            .organizationId(qovery_organization.my_organization().id())
            .kind("OCI_DOCKER_HUB")
            .url("https://docker.io")
            .skipTlsVerification(false)
            .description("My Helm repository")
            .config(HelmRepositoryConfigArgs.builder()
                .username("<my_username>")
                .password("<my_password>")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(qovery_organization.my_organization())
                .build());

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

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 This property is required. string
The unique name of the resource.
args This property is required. HelmRepositoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. HelmRepositoryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HelmRepositoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
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());
Copy
helm_repository_resource = qovery.HelmRepository("helmRepositoryResource",
    kind="string",
    organization_id="string",
    skip_tls_verification=False,
    url="string",
    config={
        "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")
Copy
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",
});
Copy
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
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HelmRepository resource accepts the following input properties:

Kind This property is required. 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 This property is required. string
Id of the organization.
SkipTlsVerification This property is required. bool
Bypass tls certificate verification when connecting to repository
Url This property is required. 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 This property is required. 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 This property is required. string
Id of the organization.
SkipTlsVerification This property is required. bool
Bypass tls certificate verification when connecting to repository
Url This property is required. 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 This property is required. 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 This property is required. String
Id of the organization.
skipTlsVerification This property is required. Boolean
Bypass tls certificate verification when connecting to repository
url This property is required. 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 This property is required. 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 This property is required. string
Id of the organization.
skipTlsVerification This property is required. boolean
Bypass tls certificate verification when connecting to repository
url This property is required. 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 This property is required. 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 This property is required. str
Id of the organization.
skip_tls_verification This property is required. bool
Bypass tls certificate verification when connecting to repository
url This property is required. 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 This property is required. 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 This property is required. String
Id of the organization.
skipTlsVerification This property is required. Boolean
Bypass tls certificate verification when connecting to repository
url This property is required. 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)
resources:  _:    type: qovery:HelmRepository    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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>"
Copy

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.