Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Qovery
  3. API Docs
  4. Helm
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
dirien/pulumi-qovery

qovery.Helm

Explore with Pulumi AI

qovery logo
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien
dirien/pulumi-qovery

    # qovery.Helm (Resource)

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

    Example

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.Helm;
import com.pulumi.qovery.HelmArgs;
import com.pulumi.qovery.inputs.HelmSourceArgs;
import com.pulumi.qovery.inputs.HelmValuesOverrideArgs;
import com.pulumi.qovery.inputs.HelmValuesOverrideFileArgs;
import com.pulumi.qovery.inputs.HelmEnvironmentVariableArgs;
import com.pulumi.qovery.inputs.HelmEnvironmentVariableAliasArgs;
import com.pulumi.qovery.inputs.HelmEnvironmentVariableOverrideArgs;
import com.pulumi.qovery.inputs.HelmSecretArgs;
import com.pulumi.qovery.inputs.HelmSecretAliasArgs;
import com.pulumi.qovery.inputs.HelmSecretOverrideArgs;
import com.pulumi.qovery.inputs.HelmDeploymentRestrictionArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 myHelm = new Helm("myHelm", HelmArgs.builder()
            .environmentId(qovery_environment.my_environment().id())
            .allowClusterWideResources(false)
            .source(HelmSourceArgs.builder()
                .helm_repository(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .valuesOverride(HelmValuesOverrideArgs.builder()
%!v(PANIC=Format method: interface conversion: model.Expression is *model.TemplateExpression, not *model.LiteralValueExpression))
                .autoPreview("true")
                .environmentVariables(HelmEnvironmentVariableArgs.builder()
                    .key("MY_TERRAFORM_HELM_VARIABLE")
                    .value("MY_TERRAFORM_HELM_VARIABLE_VALUE")
                    .build())
                .environmentVariableAliases(HelmEnvironmentVariableAliasArgs.builder()
                    .key("ENV_VAR_KEY_ALIAS")
                    .value("ENV_VAR_KEY")
                    .build())
                .environmentVariableOverrides(HelmEnvironmentVariableOverrideArgs.builder()
                    .key("SOME_PROJECT_VARIABLE")
                    .value("OVERRIDDEN_VALUE")
                    .build())
                .secrets(HelmSecretArgs.builder()
                    .key("MY_TERRAFORM_HELM_SECRET")
                    .value("MY_TERRAFORM_HELM_SECRET_VALUE")
                    .build())
                .secretAliases(HelmSecretAliasArgs.builder()
                    .key("SECRET_KEY_ALIAS")
                    .value("SECRET_KEY")
                    .build())
                .secretOverrides(HelmSecretOverrideArgs.builder()
                    .key("SOME_PROJECT_SECRET")
                    .value("OVERRIDDEN_VALUE")
                    .build())
                .deploymentRestrictions(HelmDeploymentRestrictionArgs.builder()
                    .mode("MATCH")
                    .type("PATH")
                    .value("path/or/file")
                    .build())
                .advancedSettingsJson(serializeJson(
                    jsonObject(

                    )))
                .build(), CustomResourceOptions.builder()
                    .dependsOn(qovery_environment.my_environment())
                    .build());

        }
}

    resources:
  myHelm:
    type: qovery:Helm
    properties:
      # Required
      environmentId: ${qovery_environment.my_environment.id}
      allowClusterWideResources: false
      source:
        helm_repository:
          helmRepositoryId: 5a4a2dd6-02e1-4e3a-a3cc-8ebb97e135a9
          chartName: httpbin
          chartVersion: 1.0.0
      valuesOverride:
        set:
          key1: 6600
          key2: values1
        set_string:
          s-key1: value1
          s-key2: value2
        set_json:
          j-key1: '{}'
          j-key2: '{}'
        file:
          raw:
            file1:
              content: "--- \n ssss"
            file2:
              content: "a \n eee"
      # Optional
      autoPreview: 'true'
      environmentVariables:
        - key: MY_TERRAFORM_HELM_VARIABLE
          value: MY_TERRAFORM_HELM_VARIABLE_VALUE
      environmentVariableAliases:
        - key: ENV_VAR_KEY_ALIAS
          value: ENV_VAR_KEY
      environmentVariableOverrides:
        - key: SOME_PROJECT_VARIABLE
          value: OVERRIDDEN_VALUE
      secrets:
        - key: MY_TERRAFORM_HELM_SECRET
          value: MY_TERRAFORM_HELM_SECRET_VALUE
      secretAliases:
        - key: SECRET_KEY_ALIAS
          value: SECRET_KEY
      secretOverrides:
        - key: SOME_PROJECT_SECRET
          value: OVERRIDDEN_VALUE
      deploymentRestrictions:
        - mode: MATCH
          type: PATH
          value: path/or/file
      advancedSettingsJson:
        fn::toJSON: {}
    options:
      dependson:
        - ${qovery_environment.my_environment}

    Create Helm Resource

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

    Constructor syntax

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

@overload
def Helm(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         environment_id: Optional[str] = None,
         allow_cluster_wide_resources: Optional[bool] = None,
         values_override: Optional[HelmValuesOverrideArgs] = None,
         source: Optional[HelmSourceArgs] = None,
         environment_variable_overrides: Optional[Sequence[HelmEnvironmentVariableOverrideArgs]] = None,
         name: Optional[str] = None,
         deployment_restrictions: Optional[Sequence[HelmDeploymentRestrictionArgs]] = None,
         deployment_stage_id: Optional[str] = None,
         auto_preview: Optional[bool] = None,
         environment_variable_aliases: Optional[Sequence[HelmEnvironmentVariableAliasArgs]] = None,
         advanced_settings_json: Optional[str] = None,
         environment_variables: Optional[Sequence[HelmEnvironmentVariableArgs]] = None,
         icon_uri: Optional[str] = None,
         custom_domains: Optional[Sequence[HelmCustomDomainArgs]] = None,
         ports: Optional[Mapping[str, HelmPortsArgs]] = None,
         secret_aliases: Optional[Sequence[HelmSecretAliasArgs]] = None,
         secret_overrides: Optional[Sequence[HelmSecretOverrideArgs]] = None,
         secrets: Optional[Sequence[HelmSecretArgs]] = None,
         auto_deploy: Optional[bool] = None,
         timeout_sec: Optional[int] = None,
         arguments: Optional[Sequence[str]] = None)
    func NewHelm(ctx *Context, name string, args HelmArgs, opts ...ResourceOption) (*Helm, error)
    public Helm(string name, HelmArgs args, CustomResourceOptions? opts = null)
    public Helm(String name, HelmArgs args)
public Helm(String name, HelmArgs args, CustomResourceOptions options)

    type: qovery:Helm
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 HelmArgs
    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 HelmArgs
    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 HelmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HelmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HelmArgs
    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 helmResource = new Qovery.Helm("helmResource", new()
{
    EnvironmentId = "string",
    AllowClusterWideResources = false,
    ValuesOverride = new Qovery.Inputs.HelmValuesOverrideArgs
    {
        File = new Qovery.Inputs.HelmValuesOverrideFileArgs
        {
            GitRepository = new Qovery.Inputs.HelmValuesOverrideFileGitRepositoryArgs
            {
                Branch = "string",
                Paths = new[]
                {
                    "string",
                },
                Url = "string",
                GitTokenId = "string",
            },
            Raw = 
            {
                { "string", new Qovery.Inputs.HelmValuesOverrideFileRawArgs
                {
                    Content = "string",
                } },
            },
        },
        Set = 
        {
            { "string", "string" },
        },
        SetJson = 
        {
            { "string", "string" },
        },
        SetString = 
        {
            { "string", "string" },
        },
    },
    Source = new Qovery.Inputs.HelmSourceArgs
    {
        GitRepository = new Qovery.Inputs.HelmSourceGitRepositoryArgs
        {
            Url = "string",
            Branch = "string",
            GitTokenId = "string",
            RootPath = "string",
        },
        HelmRepository = new Qovery.Inputs.HelmSourceHelmRepositoryArgs
        {
            ChartName = "string",
            ChartVersion = "string",
            HelmRepositoryId = "string",
        },
    },
    EnvironmentVariableOverrides = new[]
    {
        new Qovery.Inputs.HelmEnvironmentVariableOverrideArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    Name = "string",
    DeploymentRestrictions = new[]
    {
        new Qovery.Inputs.HelmDeploymentRestrictionArgs
        {
            Mode = "string",
            Type = "string",
            Value = "string",
            Id = "string",
        },
    },
    DeploymentStageId = "string",
    AutoPreview = false,
    EnvironmentVariableAliases = new[]
    {
        new Qovery.Inputs.HelmEnvironmentVariableAliasArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    AdvancedSettingsJson = "string",
    EnvironmentVariables = new[]
    {
        new Qovery.Inputs.HelmEnvironmentVariableArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    IconUri = "string",
    CustomDomains = new[]
    {
        new Qovery.Inputs.HelmCustomDomainArgs
        {
            Domain = "string",
            GenerateCertificate = false,
            Id = "string",
            Status = "string",
            UseCdn = false,
            ValidationDomain = "string",
        },
    },
    Ports = 
    {
        { "string", new Qovery.Inputs.HelmPortsArgs
        {
            ExternalPort = 0,
            InternalPort = 0,
            IsDefault = false,
            ServiceName = "string",
            Namespace = "string",
            Protocol = "string",
        } },
    },
    SecretAliases = new[]
    {
        new Qovery.Inputs.HelmSecretAliasArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    SecretOverrides = new[]
    {
        new Qovery.Inputs.HelmSecretOverrideArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    Secrets = new[]
    {
        new Qovery.Inputs.HelmSecretArgs
        {
            Key = "string",
            Value = "string",
            Description = "string",
            Id = "string",
        },
    },
    AutoDeploy = false,
    TimeoutSec = 0,
    Arguments = new[]
    {
        "string",
    },
});

    example, err := qovery.NewHelm(ctx, "helmResource", &qovery.HelmArgs{
	EnvironmentId:             pulumi.String("string"),
	AllowClusterWideResources: pulumi.Bool(false),
	ValuesOverride: &qovery.HelmValuesOverrideArgs{
		File: &qovery.HelmValuesOverrideFileArgs{
			GitRepository: &qovery.HelmValuesOverrideFileGitRepositoryArgs{
				Branch: pulumi.String("string"),
				Paths: pulumi.StringArray{
					pulumi.String("string"),
				},
				Url:        pulumi.String("string"),
				GitTokenId: pulumi.String("string"),
			},
			Raw: qovery.HelmValuesOverrideFileRawMap{
				"string": &qovery.HelmValuesOverrideFileRawArgs{
					Content: pulumi.String("string"),
				},
			},
		},
		Set: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		SetJson: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		SetString: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Source: &qovery.HelmSourceArgs{
		GitRepository: &qovery.HelmSourceGitRepositoryArgs{
			Url:        pulumi.String("string"),
			Branch:     pulumi.String("string"),
			GitTokenId: pulumi.String("string"),
			RootPath:   pulumi.String("string"),
		},
		HelmRepository: &qovery.HelmSourceHelmRepositoryArgs{
			ChartName:        pulumi.String("string"),
			ChartVersion:     pulumi.String("string"),
			HelmRepositoryId: pulumi.String("string"),
		},
	},
	EnvironmentVariableOverrides: qovery.HelmEnvironmentVariableOverrideArray{
		&qovery.HelmEnvironmentVariableOverrideArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	DeploymentRestrictions: qovery.HelmDeploymentRestrictionArray{
		&qovery.HelmDeploymentRestrictionArgs{
			Mode:  pulumi.String("string"),
			Type:  pulumi.String("string"),
			Value: pulumi.String("string"),
			Id:    pulumi.String("string"),
		},
	},
	DeploymentStageId: pulumi.String("string"),
	AutoPreview:       pulumi.Bool(false),
	EnvironmentVariableAliases: qovery.HelmEnvironmentVariableAliasArray{
		&qovery.HelmEnvironmentVariableAliasArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	AdvancedSettingsJson: pulumi.String("string"),
	EnvironmentVariables: qovery.HelmEnvironmentVariableArray{
		&qovery.HelmEnvironmentVariableArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	IconUri: pulumi.String("string"),
	CustomDomains: qovery.HelmCustomDomainArray{
		&qovery.HelmCustomDomainArgs{
			Domain:              pulumi.String("string"),
			GenerateCertificate: pulumi.Bool(false),
			Id:                  pulumi.String("string"),
			Status:              pulumi.String("string"),
			UseCdn:              pulumi.Bool(false),
			ValidationDomain:    pulumi.String("string"),
		},
	},
	Ports: qovery.HelmPortsMap{
		"string": &qovery.HelmPortsArgs{
			ExternalPort: pulumi.Int(0),
			InternalPort: pulumi.Int(0),
			IsDefault:    pulumi.Bool(false),
			ServiceName:  pulumi.String("string"),
			Namespace:    pulumi.String("string"),
			Protocol:     pulumi.String("string"),
		},
	},
	SecretAliases: qovery.HelmSecretAliasArray{
		&qovery.HelmSecretAliasArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	SecretOverrides: qovery.HelmSecretOverrideArray{
		&qovery.HelmSecretOverrideArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	Secrets: qovery.HelmSecretArray{
		&qovery.HelmSecretArgs{
			Key:         pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Id:          pulumi.String("string"),
		},
	},
	AutoDeploy: pulumi.Bool(false),
	TimeoutSec: pulumi.Int(0),
	Arguments: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var helmResource = new Helm("helmResource", HelmArgs.builder()
    .environmentId("string")
    .allowClusterWideResources(false)
    .valuesOverride(HelmValuesOverrideArgs.builder()
        .file(HelmValuesOverrideFileArgs.builder()
            .gitRepository(HelmValuesOverrideFileGitRepositoryArgs.builder()
                .branch("string")
                .paths("string")
                .url("string")
                .gitTokenId("string")
                .build())
            .raw(Map.of("string", Map.of("content", "string")))
            .build())
        .set(Map.of("string", "string"))
        .setJson(Map.of("string", "string"))
        .setString(Map.of("string", "string"))
        .build())
    .source(HelmSourceArgs.builder()
        .gitRepository(HelmSourceGitRepositoryArgs.builder()
            .url("string")
            .branch("string")
            .gitTokenId("string")
            .rootPath("string")
            .build())
        .helmRepository(HelmSourceHelmRepositoryArgs.builder()
            .chartName("string")
            .chartVersion("string")
            .helmRepositoryId("string")
            .build())
        .build())
    .environmentVariableOverrides(HelmEnvironmentVariableOverrideArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .name("string")
    .deploymentRestrictions(HelmDeploymentRestrictionArgs.builder()
        .mode("string")
        .type("string")
        .value("string")
        .id("string")
        .build())
    .deploymentStageId("string")
    .autoPreview(false)
    .environmentVariableAliases(HelmEnvironmentVariableAliasArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .advancedSettingsJson("string")
    .environmentVariables(HelmEnvironmentVariableArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .iconUri("string")
    .customDomains(HelmCustomDomainArgs.builder()
        .domain("string")
        .generateCertificate(false)
        .id("string")
        .status("string")
        .useCdn(false)
        .validationDomain("string")
        .build())
    .ports(Map.of("string", Map.ofEntries(
        Map.entry("externalPort", 0),
        Map.entry("internalPort", 0),
        Map.entry("isDefault", false),
        Map.entry("serviceName", "string"),
        Map.entry("namespace", "string"),
        Map.entry("protocol", "string")
    )))
    .secretAliases(HelmSecretAliasArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .secretOverrides(HelmSecretOverrideArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .secrets(HelmSecretArgs.builder()
        .key("string")
        .value("string")
        .description("string")
        .id("string")
        .build())
    .autoDeploy(false)
    .timeoutSec(0)
    .arguments("string")
    .build());

    helm_resource = qovery.Helm("helmResource",
    environment_id="string",
    allow_cluster_wide_resources=False,
    values_override={
        "file": {
            "git_repository": {
                "branch": "string",
                "paths": ["string"],
                "url": "string",
                "git_token_id": "string",
            },
            "raw": {
                "string": {
                    "content": "string",
                },
            },
        },
        "set": {
            "string": "string",
        },
        "set_json": {
            "string": "string",
        },
        "set_string": {
            "string": "string",
        },
    },
    source={
        "git_repository": {
            "url": "string",
            "branch": "string",
            "git_token_id": "string",
            "root_path": "string",
        },
        "helm_repository": {
            "chart_name": "string",
            "chart_version": "string",
            "helm_repository_id": "string",
        },
    },
    environment_variable_overrides=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    name="string",
    deployment_restrictions=[{
        "mode": "string",
        "type": "string",
        "value": "string",
        "id": "string",
    }],
    deployment_stage_id="string",
    auto_preview=False,
    environment_variable_aliases=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    advanced_settings_json="string",
    environment_variables=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    icon_uri="string",
    custom_domains=[{
        "domain": "string",
        "generate_certificate": False,
        "id": "string",
        "status": "string",
        "use_cdn": False,
        "validation_domain": "string",
    }],
    ports={
        "string": {
            "external_port": 0,
            "internal_port": 0,
            "is_default": False,
            "service_name": "string",
            "namespace": "string",
            "protocol": "string",
        },
    },
    secret_aliases=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    secret_overrides=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    secrets=[{
        "key": "string",
        "value": "string",
        "description": "string",
        "id": "string",
    }],
    auto_deploy=False,
    timeout_sec=0,
    arguments=["string"])

    const helmResource = new qovery.Helm("helmResource", {
    environmentId: "string",
    allowClusterWideResources: false,
    valuesOverride: {
        file: {
            gitRepository: {
                branch: "string",
                paths: ["string"],
                url: "string",
                gitTokenId: "string",
            },
            raw: {
                string: {
                    content: "string",
                },
            },
        },
        set: {
            string: "string",
        },
        setJson: {
            string: "string",
        },
        setString: {
            string: "string",
        },
    },
    source: {
        gitRepository: {
            url: "string",
            branch: "string",
            gitTokenId: "string",
            rootPath: "string",
        },
        helmRepository: {
            chartName: "string",
            chartVersion: "string",
            helmRepositoryId: "string",
        },
    },
    environmentVariableOverrides: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    name: "string",
    deploymentRestrictions: [{
        mode: "string",
        type: "string",
        value: "string",
        id: "string",
    }],
    deploymentStageId: "string",
    autoPreview: false,
    environmentVariableAliases: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    advancedSettingsJson: "string",
    environmentVariables: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    iconUri: "string",
    customDomains: [{
        domain: "string",
        generateCertificate: false,
        id: "string",
        status: "string",
        useCdn: false,
        validationDomain: "string",
    }],
    ports: {
        string: {
            externalPort: 0,
            internalPort: 0,
            isDefault: false,
            serviceName: "string",
            namespace: "string",
            protocol: "string",
        },
    },
    secretAliases: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    secretOverrides: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    secrets: [{
        key: "string",
        value: "string",
        description: "string",
        id: "string",
    }],
    autoDeploy: false,
    timeoutSec: 0,
    arguments: ["string"],
});

    type: qovery:Helm
properties:
    advancedSettingsJson: string
    allowClusterWideResources: false
    arguments:
        - string
    autoDeploy: false
    autoPreview: false
    customDomains:
        - domain: string
          generateCertificate: false
          id: string
          status: string
          useCdn: false
          validationDomain: string
    deploymentRestrictions:
        - id: string
          mode: string
          type: string
          value: string
    deploymentStageId: string
    environmentId: string
    environmentVariableAliases:
        - description: string
          id: string
          key: string
          value: string
    environmentVariableOverrides:
        - description: string
          id: string
          key: string
          value: string
    environmentVariables:
        - description: string
          id: string
          key: string
          value: string
    iconUri: string
    name: string
    ports:
        string:
            externalPort: 0
            internalPort: 0
            isDefault: false
            namespace: string
            protocol: string
            serviceName: string
    secretAliases:
        - description: string
          id: string
          key: string
          value: string
    secretOverrides:
        - description: string
          id: string
          key: string
          value: string
    secrets:
        - description: string
          id: string
          key: string
          value: string
    source:
        gitRepository:
            branch: string
            gitTokenId: string
            rootPath: string
            url: string
        helmRepository:
            chartName: string
            chartVersion: string
            helmRepositoryId: string
    timeoutSec: 0
    valuesOverride:
        file:
            gitRepository:
                branch: string
                gitTokenId: string
                paths:
                    - string
                url: string
            raw:
                string:
                    content: string
        set:
            string: string
        setJson:
            string: string
        setString:
            string: string

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

    AllowClusterWideResources bool
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    EnvironmentId string
    Id of the environment.
    Source ediri.Qovery.Inputs.HelmSource
    Helm chart from a Helm repository or from a git repository
    ValuesOverride ediri.Qovery.Inputs.HelmValuesOverride
    Define your own overrides to customize the helm chart behaviour.
    AdvancedSettingsJson string
    Advanced settings.
    Arguments List<string>
    Helm arguments
    AutoDeploy bool
    Specify if service will be automatically updated on every new commit on the branch.
    AutoPreview bool
    Specify if the environment preview option is activated or not for this helm.
    CustomDomains List<ediri.Qovery.Inputs.HelmCustomDomain>
    List of custom domains linked to this helm.
    DeploymentRestrictions List<ediri.Qovery.Inputs.HelmDeploymentRestriction>
    List of deployment restrictions
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentVariableAliases List<ediri.Qovery.Inputs.HelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    EnvironmentVariableOverrides List<ediri.Qovery.Inputs.HelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    EnvironmentVariables List<ediri.Qovery.Inputs.HelmEnvironmentVariable>
    List of environment variables linked to this helm.
    IconUri string
    Icon URI representing the helm service.
    Name string
    Name of the helm.
    Ports Dictionary<string, ediri.Qovery.Inputs.HelmPortsArgs>
    List of ports linked to this helm.
    SecretAliases List<ediri.Qovery.Inputs.HelmSecretAlias>
    List of secret aliases linked to this helm.
    SecretOverrides List<ediri.Qovery.Inputs.HelmSecretOverride>
    List of secret overrides linked to this helm.
    Secrets List<ediri.Qovery.Inputs.HelmSecret>
    List of secrets linked to this helm.
    TimeoutSec int
    Helm timeout in seconds
    AllowClusterWideResources bool
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    EnvironmentId string
    Id of the environment.
    Source HelmSourceArgs
    Helm chart from a Helm repository or from a git repository
    ValuesOverride HelmValuesOverrideArgs
    Define your own overrides to customize the helm chart behaviour.
    AdvancedSettingsJson string
    Advanced settings.
    Arguments []string
    Helm arguments
    AutoDeploy bool
    Specify if service will be automatically updated on every new commit on the branch.
    AutoPreview bool
    Specify if the environment preview option is activated or not for this helm.
    CustomDomains []HelmCustomDomainArgs
    List of custom domains linked to this helm.
    DeploymentRestrictions []HelmDeploymentRestrictionArgs
    List of deployment restrictions
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentVariableAliases []HelmEnvironmentVariableAliasArgs
    List of environment variable aliases linked to this helm.
    EnvironmentVariableOverrides []HelmEnvironmentVariableOverrideArgs
    List of environment variable overrides linked to this helm.
    EnvironmentVariables []HelmEnvironmentVariableArgs
    List of environment variables linked to this helm.
    IconUri string
    Icon URI representing the helm service.
    Name string
    Name of the helm.
    Ports map[string]HelmPortsArgs
    List of ports linked to this helm.
    SecretAliases []HelmSecretAliasArgs
    List of secret aliases linked to this helm.
    SecretOverrides []HelmSecretOverrideArgs
    List of secret overrides linked to this helm.
    Secrets []HelmSecretArgs
    List of secrets linked to this helm.
    TimeoutSec int
    Helm timeout in seconds
    allowClusterWideResources Boolean
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    environmentId String
    Id of the environment.
    source HelmSource
    Helm chart from a Helm repository or from a git repository
    valuesOverride HelmValuesOverride
    Define your own overrides to customize the helm chart behaviour.
    advancedSettingsJson String
    Advanced settings.
    arguments List<String>
    Helm arguments
    autoDeploy Boolean
    Specify if service will be automatically updated on every new commit on the branch.
    autoPreview Boolean
    Specify if the environment preview option is activated or not for this helm.
    customDomains List<HelmCustomDomain>
    List of custom domains linked to this helm.
    deploymentRestrictions List<HelmDeploymentRestriction>
    List of deployment restrictions
    deploymentStageId String
    Id of the deployment stage.
    environmentVariableAliases List<HelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides List<HelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    environmentVariables List<HelmEnvironmentVariable>
    List of environment variables linked to this helm.
    iconUri String
    Icon URI representing the helm service.
    name String
    Name of the helm.
    ports Map<String,HelmPortsArgs>
    List of ports linked to this helm.
    secretAliases List<HelmSecretAlias>
    List of secret aliases linked to this helm.
    secretOverrides List<HelmSecretOverride>
    List of secret overrides linked to this helm.
    secrets List<HelmSecret>
    List of secrets linked to this helm.
    timeoutSec Integer
    Helm timeout in seconds
    allowClusterWideResources boolean
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    environmentId string
    Id of the environment.
    source HelmSource
    Helm chart from a Helm repository or from a git repository
    valuesOverride HelmValuesOverride
    Define your own overrides to customize the helm chart behaviour.
    advancedSettingsJson string
    Advanced settings.
    arguments string[]
    Helm arguments
    autoDeploy boolean
    Specify if service will be automatically updated on every new commit on the branch.
    autoPreview boolean
    Specify if the environment preview option is activated or not for this helm.
    customDomains HelmCustomDomain[]
    List of custom domains linked to this helm.
    deploymentRestrictions HelmDeploymentRestriction[]
    List of deployment restrictions
    deploymentStageId string
    Id of the deployment stage.
    environmentVariableAliases HelmEnvironmentVariableAlias[]
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides HelmEnvironmentVariableOverride[]
    List of environment variable overrides linked to this helm.
    environmentVariables HelmEnvironmentVariable[]
    List of environment variables linked to this helm.
    iconUri string
    Icon URI representing the helm service.
    name string
    Name of the helm.
    ports {[key: string]: HelmPortsArgs}
    List of ports linked to this helm.
    secretAliases HelmSecretAlias[]
    List of secret aliases linked to this helm.
    secretOverrides HelmSecretOverride[]
    List of secret overrides linked to this helm.
    secrets HelmSecret[]
    List of secrets linked to this helm.
    timeoutSec number
    Helm timeout in seconds
    allow_cluster_wide_resources bool
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    environment_id str
    Id of the environment.
    source HelmSourceArgs
    Helm chart from a Helm repository or from a git repository
    values_override HelmValuesOverrideArgs
    Define your own overrides to customize the helm chart behaviour.
    advanced_settings_json str
    Advanced settings.
    arguments Sequence[str]
    Helm arguments
    auto_deploy bool
    Specify if service will be automatically updated on every new commit on the branch.
    auto_preview bool
    Specify if the environment preview option is activated or not for this helm.
    custom_domains Sequence[HelmCustomDomainArgs]
    List of custom domains linked to this helm.
    deployment_restrictions Sequence[HelmDeploymentRestrictionArgs]
    List of deployment restrictions
    deployment_stage_id str
    Id of the deployment stage.
    environment_variable_aliases Sequence[HelmEnvironmentVariableAliasArgs]
    List of environment variable aliases linked to this helm.
    environment_variable_overrides Sequence[HelmEnvironmentVariableOverrideArgs]
    List of environment variable overrides linked to this helm.
    environment_variables Sequence[HelmEnvironmentVariableArgs]
    List of environment variables linked to this helm.
    icon_uri str
    Icon URI representing the helm service.
    name str
    Name of the helm.
    ports Mapping[str, HelmPortsArgs]
    List of ports linked to this helm.
    secret_aliases Sequence[HelmSecretAliasArgs]
    List of secret aliases linked to this helm.
    secret_overrides Sequence[HelmSecretOverrideArgs]
    List of secret overrides linked to this helm.
    secrets Sequence[HelmSecretArgs]
    List of secrets linked to this helm.
    timeout_sec int
    Helm timeout in seconds
    allowClusterWideResources Boolean
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    environmentId String
    Id of the environment.
    source Property Map
    Helm chart from a Helm repository or from a git repository
    valuesOverride Property Map
    Define your own overrides to customize the helm chart behaviour.
    advancedSettingsJson String
    Advanced settings.
    arguments List<String>
    Helm arguments
    autoDeploy Boolean
    Specify if service will be automatically updated on every new commit on the branch.
    autoPreview Boolean
    Specify if the environment preview option is activated or not for this helm.
    customDomains List<Property Map>
    List of custom domains linked to this helm.
    deploymentRestrictions List<Property Map>
    List of deployment restrictions
    deploymentStageId String
    Id of the deployment stage.
    environmentVariableAliases List<Property Map>
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides List<Property Map>
    List of environment variable overrides linked to this helm.
    environmentVariables List<Property Map>
    List of environment variables linked to this helm.
    iconUri String
    Icon URI representing the helm service.
    name String
    Name of the helm.
    ports Map<Property Map>
    List of ports linked to this helm.
    secretAliases List<Property Map>
    List of secret aliases linked to this helm.
    secretOverrides List<Property Map>
    List of secret overrides linked to this helm.
    secrets List<Property Map>
    List of secrets linked to this helm.
    timeoutSec Number
    Helm timeout in seconds

    Outputs

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

    BuiltInEnvironmentVariables List<ediri.Qovery.Outputs.HelmBuiltInEnvironmentVariable>
    List of built-in environment variables linked to this helm.
    ExternalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalHost string
    The helm internal host.
    BuiltInEnvironmentVariables []HelmBuiltInEnvironmentVariable
    List of built-in environment variables linked to this helm.
    ExternalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalHost string
    The helm internal host.
    builtInEnvironmentVariables List<HelmBuiltInEnvironmentVariable>
    List of built-in environment variables linked to this helm.
    externalHost String
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id String
    The provider-assigned unique ID for this managed resource.
    internalHost String
    The helm internal host.
    builtInEnvironmentVariables HelmBuiltInEnvironmentVariable[]
    List of built-in environment variables linked to this helm.
    externalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id string
    The provider-assigned unique ID for this managed resource.
    internalHost string
    The helm internal host.
    built_in_environment_variables Sequence[HelmBuiltInEnvironmentVariable]
    List of built-in environment variables linked to this helm.
    external_host str
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id str
    The provider-assigned unique ID for this managed resource.
    internal_host str
    The helm internal host.
    builtInEnvironmentVariables List<Property Map>
    List of built-in environment variables linked to this helm.
    externalHost String
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id String
    The provider-assigned unique ID for this managed resource.
    internalHost String
    The helm internal host.

    Look up Existing Helm Resource

    Get an existing Helm 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?: HelmState, opts?: CustomResourceOptions): Helm
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advanced_settings_json: Optional[str] = None,
        allow_cluster_wide_resources: Optional[bool] = None,
        arguments: Optional[Sequence[str]] = None,
        auto_deploy: Optional[bool] = None,
        auto_preview: Optional[bool] = None,
        built_in_environment_variables: Optional[Sequence[HelmBuiltInEnvironmentVariableArgs]] = None,
        custom_domains: Optional[Sequence[HelmCustomDomainArgs]] = None,
        deployment_restrictions: Optional[Sequence[HelmDeploymentRestrictionArgs]] = None,
        deployment_stage_id: Optional[str] = None,
        environment_id: Optional[str] = None,
        environment_variable_aliases: Optional[Sequence[HelmEnvironmentVariableAliasArgs]] = None,
        environment_variable_overrides: Optional[Sequence[HelmEnvironmentVariableOverrideArgs]] = None,
        environment_variables: Optional[Sequence[HelmEnvironmentVariableArgs]] = None,
        external_host: Optional[str] = None,
        icon_uri: Optional[str] = None,
        internal_host: Optional[str] = None,
        name: Optional[str] = None,
        ports: Optional[Mapping[str, HelmPortsArgs]] = None,
        secret_aliases: Optional[Sequence[HelmSecretAliasArgs]] = None,
        secret_overrides: Optional[Sequence[HelmSecretOverrideArgs]] = None,
        secrets: Optional[Sequence[HelmSecretArgs]] = None,
        source: Optional[HelmSourceArgs] = None,
        timeout_sec: Optional[int] = None,
        values_override: Optional[HelmValuesOverrideArgs] = None) -> Helm
    func GetHelm(ctx *Context, name string, id IDInput, state *HelmState, opts ...ResourceOption) (*Helm, error)
    public static Helm Get(string name, Input<string> id, HelmState? state, CustomResourceOptions? opts = null)
    public static Helm get(String name, Output<String> id, HelmState state, CustomResourceOptions options)
    resources:  _:    type: qovery:Helm    get:      id: ${id}
    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:
    AdvancedSettingsJson string
    Advanced settings.
    AllowClusterWideResources bool
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    Arguments List<string>
    Helm arguments
    AutoDeploy bool
    Specify if service will be automatically updated on every new commit on the branch.
    AutoPreview bool
    Specify if the environment preview option is activated or not for this helm.
    BuiltInEnvironmentVariables List<ediri.Qovery.Inputs.HelmBuiltInEnvironmentVariable>
    List of built-in environment variables linked to this helm.
    CustomDomains List<ediri.Qovery.Inputs.HelmCustomDomain>
    List of custom domains linked to this helm.
    DeploymentRestrictions List<ediri.Qovery.Inputs.HelmDeploymentRestriction>
    List of deployment restrictions
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentId string
    Id of the environment.
    EnvironmentVariableAliases List<ediri.Qovery.Inputs.HelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    EnvironmentVariableOverrides List<ediri.Qovery.Inputs.HelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    EnvironmentVariables List<ediri.Qovery.Inputs.HelmEnvironmentVariable>
    List of environment variables linked to this helm.
    ExternalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    IconUri string
    Icon URI representing the helm service.
    InternalHost string
    The helm internal host.
    Name string
    Name of the helm.
    Ports Dictionary<string, ediri.Qovery.Inputs.HelmPortsArgs>
    List of ports linked to this helm.
    SecretAliases List<ediri.Qovery.Inputs.HelmSecretAlias>
    List of secret aliases linked to this helm.
    SecretOverrides List<ediri.Qovery.Inputs.HelmSecretOverride>
    List of secret overrides linked to this helm.
    Secrets List<ediri.Qovery.Inputs.HelmSecret>
    List of secrets linked to this helm.
    Source ediri.Qovery.Inputs.HelmSource
    Helm chart from a Helm repository or from a git repository
    TimeoutSec int
    Helm timeout in seconds
    ValuesOverride ediri.Qovery.Inputs.HelmValuesOverride
    Define your own overrides to customize the helm chart behaviour.
    AdvancedSettingsJson string
    Advanced settings.
    AllowClusterWideResources bool
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    Arguments []string
    Helm arguments
    AutoDeploy bool
    Specify if service will be automatically updated on every new commit on the branch.
    AutoPreview bool
    Specify if the environment preview option is activated or not for this helm.
    BuiltInEnvironmentVariables []HelmBuiltInEnvironmentVariableArgs
    List of built-in environment variables linked to this helm.
    CustomDomains []HelmCustomDomainArgs
    List of custom domains linked to this helm.
    DeploymentRestrictions []HelmDeploymentRestrictionArgs
    List of deployment restrictions
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentId string
    Id of the environment.
    EnvironmentVariableAliases []HelmEnvironmentVariableAliasArgs
    List of environment variable aliases linked to this helm.
    EnvironmentVariableOverrides []HelmEnvironmentVariableOverrideArgs
    List of environment variable overrides linked to this helm.
    EnvironmentVariables []HelmEnvironmentVariableArgs
    List of environment variables linked to this helm.
    ExternalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    IconUri string
    Icon URI representing the helm service.
    InternalHost string
    The helm internal host.
    Name string
    Name of the helm.
    Ports map[string]HelmPortsArgs
    List of ports linked to this helm.
    SecretAliases []HelmSecretAliasArgs
    List of secret aliases linked to this helm.
    SecretOverrides []HelmSecretOverrideArgs
    List of secret overrides linked to this helm.
    Secrets []HelmSecretArgs
    List of secrets linked to this helm.
    Source HelmSourceArgs
    Helm chart from a Helm repository or from a git repository
    TimeoutSec int
    Helm timeout in seconds
    ValuesOverride HelmValuesOverrideArgs
    Define your own overrides to customize the helm chart behaviour.
    advancedSettingsJson String
    Advanced settings.
    allowClusterWideResources Boolean
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    arguments List<String>
    Helm arguments
    autoDeploy Boolean
    Specify if service will be automatically updated on every new commit on the branch.
    autoPreview Boolean
    Specify if the environment preview option is activated or not for this helm.
    builtInEnvironmentVariables List<HelmBuiltInEnvironmentVariable>
    List of built-in environment variables linked to this helm.
    customDomains List<HelmCustomDomain>
    List of custom domains linked to this helm.
    deploymentRestrictions List<HelmDeploymentRestriction>
    List of deployment restrictions
    deploymentStageId String
    Id of the deployment stage.
    environmentId String
    Id of the environment.
    environmentVariableAliases List<HelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides List<HelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    environmentVariables List<HelmEnvironmentVariable>
    List of environment variables linked to this helm.
    externalHost String
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    iconUri String
    Icon URI representing the helm service.
    internalHost String
    The helm internal host.
    name String
    Name of the helm.
    ports Map<String,HelmPortsArgs>
    List of ports linked to this helm.
    secretAliases List<HelmSecretAlias>
    List of secret aliases linked to this helm.
    secretOverrides List<HelmSecretOverride>
    List of secret overrides linked to this helm.
    secrets List<HelmSecret>
    List of secrets linked to this helm.
    source HelmSource
    Helm chart from a Helm repository or from a git repository
    timeoutSec Integer
    Helm timeout in seconds
    valuesOverride HelmValuesOverride
    Define your own overrides to customize the helm chart behaviour.
    advancedSettingsJson string
    Advanced settings.
    allowClusterWideResources boolean
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    arguments string[]
    Helm arguments
    autoDeploy boolean
    Specify if service will be automatically updated on every new commit on the branch.
    autoPreview boolean
    Specify if the environment preview option is activated or not for this helm.
    builtInEnvironmentVariables HelmBuiltInEnvironmentVariable[]
    List of built-in environment variables linked to this helm.
    customDomains HelmCustomDomain[]
    List of custom domains linked to this helm.
    deploymentRestrictions HelmDeploymentRestriction[]
    List of deployment restrictions
    deploymentStageId string
    Id of the deployment stage.
    environmentId string
    Id of the environment.
    environmentVariableAliases HelmEnvironmentVariableAlias[]
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides HelmEnvironmentVariableOverride[]
    List of environment variable overrides linked to this helm.
    environmentVariables HelmEnvironmentVariable[]
    List of environment variables linked to this helm.
    externalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    iconUri string
    Icon URI representing the helm service.
    internalHost string
    The helm internal host.
    name string
    Name of the helm.
    ports {[key: string]: HelmPortsArgs}
    List of ports linked to this helm.
    secretAliases HelmSecretAlias[]
    List of secret aliases linked to this helm.
    secretOverrides HelmSecretOverride[]
    List of secret overrides linked to this helm.
    secrets HelmSecret[]
    List of secrets linked to this helm.
    source HelmSource
    Helm chart from a Helm repository or from a git repository
    timeoutSec number
    Helm timeout in seconds
    valuesOverride HelmValuesOverride
    Define your own overrides to customize the helm chart behaviour.
    advanced_settings_json str
    Advanced settings.
    allow_cluster_wide_resources bool
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    arguments Sequence[str]
    Helm arguments
    auto_deploy bool
    Specify if service will be automatically updated on every new commit on the branch.
    auto_preview bool
    Specify if the environment preview option is activated or not for this helm.
    built_in_environment_variables Sequence[HelmBuiltInEnvironmentVariableArgs]
    List of built-in environment variables linked to this helm.
    custom_domains Sequence[HelmCustomDomainArgs]
    List of custom domains linked to this helm.
    deployment_restrictions Sequence[HelmDeploymentRestrictionArgs]
    List of deployment restrictions
    deployment_stage_id str
    Id of the deployment stage.
    environment_id str
    Id of the environment.
    environment_variable_aliases Sequence[HelmEnvironmentVariableAliasArgs]
    List of environment variable aliases linked to this helm.
    environment_variable_overrides Sequence[HelmEnvironmentVariableOverrideArgs]
    List of environment variable overrides linked to this helm.
    environment_variables Sequence[HelmEnvironmentVariableArgs]
    List of environment variables linked to this helm.
    external_host str
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    icon_uri str
    Icon URI representing the helm service.
    internal_host str
    The helm internal host.
    name str
    Name of the helm.
    ports Mapping[str, HelmPortsArgs]
    List of ports linked to this helm.
    secret_aliases Sequence[HelmSecretAliasArgs]
    List of secret aliases linked to this helm.
    secret_overrides Sequence[HelmSecretOverrideArgs]
    List of secret overrides linked to this helm.
    secrets Sequence[HelmSecretArgs]
    List of secrets linked to this helm.
    source HelmSourceArgs
    Helm chart from a Helm repository or from a git repository
    timeout_sec int
    Helm timeout in seconds
    values_override HelmValuesOverrideArgs
    Define your own overrides to customize the helm chart behaviour.
    advancedSettingsJson String
    Advanced settings.
    allowClusterWideResources Boolean
    Allow this chart to deploy resources outside of this environment namespace (including CRDs or non-namespaced resources)
    arguments List<String>
    Helm arguments
    autoDeploy Boolean
    Specify if service will be automatically updated on every new commit on the branch.
    autoPreview Boolean
    Specify if the environment preview option is activated or not for this helm.
    builtInEnvironmentVariables List<Property Map>
    List of built-in environment variables linked to this helm.
    customDomains List<Property Map>
    List of custom domains linked to this helm.
    deploymentRestrictions List<Property Map>
    List of deployment restrictions
    deploymentStageId String
    Id of the deployment stage.
    environmentId String
    Id of the environment.
    environmentVariableAliases List<Property Map>
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides List<Property Map>
    List of environment variable overrides linked to this helm.
    environmentVariables List<Property Map>
    List of environment variables linked to this helm.
    externalHost String
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    iconUri String
    Icon URI representing the helm service.
    internalHost String
    The helm internal host.
    name String
    Name of the helm.
    ports Map<Property Map>
    List of ports linked to this helm.
    secretAliases List<Property Map>
    List of secret aliases linked to this helm.
    secretOverrides List<Property Map>
    List of secret overrides linked to this helm.
    secrets List<Property Map>
    List of secrets linked to this helm.
    source Property Map
    Helm chart from a Helm repository or from a git repository
    timeoutSec Number
    Helm timeout in seconds
    valuesOverride Property Map
    Define your own overrides to customize the helm chart behaviour.

    Supporting Types

    HelmBuiltInEnvironmentVariable, HelmBuiltInEnvironmentVariableArgs

    Description string
    Description of the environment variable.
    Id string
    Id of the environment variable.
    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    Description string
    Description of the environment variable.
    Id string
    Id of the environment variable.
    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    description String
    Description of the environment variable.
    id String
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.
    description string
    Description of the environment variable.
    id string
    Id of the environment variable.
    key string
    Key of the environment variable.
    value string
    Value of the environment variable.
    description str
    Description of the environment variable.
    id str
    Id of the environment variable.
    key str
    Key of the environment variable.
    value str
    Value of the environment variable.
    description String
    Description of the environment variable.
    id String
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.

    HelmCustomDomain, HelmCustomDomainArgs

    Domain string
    Your custom domain.
    GenerateCertificate bool
    Qovery will generate and manage the certificate for this domain.
    Id string
    Id of the custom domain.
    Status string
    Status of the custom domain.
    UseCdn bool
    Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

    • If true then we only check the domain points to an IP
    • If false then we check that the domain resolves to the correct service Load Balancer
    ValidationDomain string
    URL provided by Qovery. You must create a CNAME on your DNS provider using that URL.
    Domain string
    Your custom domain.
    GenerateCertificate bool
    Qovery will generate and manage the certificate for this domain.
    Id string
    Id of the custom domain.
    Status string
    Status of the custom domain.
    UseCdn bool
    Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

    • If true then we only check the domain points to an IP
    • If false then we check that the domain resolves to the correct service Load Balancer
    ValidationDomain string
    URL provided by Qovery. You must create a CNAME on your DNS provider using that URL.
    domain String
    Your custom domain.
    generateCertificate Boolean
    Qovery will generate and manage the certificate for this domain.
    id String
    Id of the custom domain.
    status String
    Status of the custom domain.
    useCdn Boolean
    Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

    • If true then we only check the domain points to an IP
    • If false then we check that the domain resolves to the correct service Load Balancer
    validationDomain String
    URL provided by Qovery. You must create a CNAME on your DNS provider using that URL.
    domain string
    Your custom domain.
    generateCertificate boolean
    Qovery will generate and manage the certificate for this domain.
    id string
    Id of the custom domain.
    status string
    Status of the custom domain.
    useCdn boolean
    Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

    • If true then we only check the domain points to an IP
    • If false then we check that the domain resolves to the correct service Load Balancer
    validationDomain string
    URL provided by Qovery. You must create a CNAME on your DNS provider using that URL.
    domain str
    Your custom domain.
    generate_certificate bool
    Qovery will generate and manage the certificate for this domain.
    id str
    Id of the custom domain.
    status str
    Status of the custom domain.
    use_cdn bool
    Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

    • If true then we only check the domain points to an IP
    • If false then we check that the domain resolves to the correct service Load Balancer
    validation_domain str
    URL provided by Qovery. You must create a CNAME on your DNS provider using that URL.
    domain String
    Your custom domain.
    generateCertificate Boolean
    Qovery will generate and manage the certificate for this domain.
    id String
    Id of the custom domain.
    status String
    Status of the custom domain.
    useCdn Boolean
    Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

    • If true then we only check the domain points to an IP
    • If false then we check that the domain resolves to the correct service Load Balancer
    validationDomain String
    URL provided by Qovery. You must create a CNAME on your DNS provider using that URL.

    HelmDeploymentRestriction, HelmDeploymentRestrictionArgs

    Mode string
    Can be EXCLUDE or MATCH
    Type string
    Currently, only PATH is accepted
    Value string
    Value of the deployment restriction
    Id string
    Id of the deployment restriction
    Mode string
    Can be EXCLUDE or MATCH
    Type string
    Currently, only PATH is accepted
    Value string
    Value of the deployment restriction
    Id string
    Id of the deployment restriction
    mode String
    Can be EXCLUDE or MATCH
    type String
    Currently, only PATH is accepted
    value String
    Value of the deployment restriction
    id String
    Id of the deployment restriction
    mode string
    Can be EXCLUDE or MATCH
    type string
    Currently, only PATH is accepted
    value string
    Value of the deployment restriction
    id string
    Id of the deployment restriction
    mode str
    Can be EXCLUDE or MATCH
    type str
    Currently, only PATH is accepted
    value str
    Value of the deployment restriction
    id str
    Id of the deployment restriction
    mode String
    Can be EXCLUDE or MATCH
    type String
    Currently, only PATH is accepted
    value String
    Value of the deployment restriction
    id String
    Id of the deployment restriction

    HelmEnvironmentVariable, HelmEnvironmentVariableArgs

    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    Description string
    Description of the environment variable.
    Id string
    Id of the environment variable.
    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    Description string
    Description of the environment variable.
    Id string
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.
    description String
    Description of the environment variable.
    id String
    Id of the environment variable.
    key string
    Key of the environment variable.
    value string
    Value of the environment variable.
    description string
    Description of the environment variable.
    id string
    Id of the environment variable.
    key str
    Key of the environment variable.
    value str
    Value of the environment variable.
    description str
    Description of the environment variable.
    id str
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.
    description String
    Description of the environment variable.
    id String
    Id of the environment variable.

    HelmEnvironmentVariableAlias, HelmEnvironmentVariableAliasArgs

    Key string
    Name of the environment variable alias.
    Value string
    Name of the variable to alias.
    Description string
    Description of the environment variable alias.
    Id string
    Id of the environment variable alias.
    Key string
    Name of the environment variable alias.
    Value string
    Name of the variable to alias.
    Description string
    Description of the environment variable alias.
    Id string
    Id of the environment variable alias.
    key String
    Name of the environment variable alias.
    value String
    Name of the variable to alias.
    description String
    Description of the environment variable alias.
    id String
    Id of the environment variable alias.
    key string
    Name of the environment variable alias.
    value string
    Name of the variable to alias.
    description string
    Description of the environment variable alias.
    id string
    Id of the environment variable alias.
    key str
    Name of the environment variable alias.
    value str
    Name of the variable to alias.
    description str
    Description of the environment variable alias.
    id str
    Id of the environment variable alias.
    key String
    Name of the environment variable alias.
    value String
    Name of the variable to alias.
    description String
    Description of the environment variable alias.
    id String
    Id of the environment variable alias.

    HelmEnvironmentVariableOverride, HelmEnvironmentVariableOverrideArgs

    Key string
    Name of the environment variable override.
    Value string
    Value of the environment variable override.
    Description string
    Description of the environment variable override.
    Id string
    Id of the environment variable override.
    Key string
    Name of the environment variable override.
    Value string
    Value of the environment variable override.
    Description string
    Description of the environment variable override.
    Id string
    Id of the environment variable override.
    key String
    Name of the environment variable override.
    value String
    Value of the environment variable override.
    description String
    Description of the environment variable override.
    id String
    Id of the environment variable override.
    key string
    Name of the environment variable override.
    value string
    Value of the environment variable override.
    description string
    Description of the environment variable override.
    id string
    Id of the environment variable override.
    key str
    Name of the environment variable override.
    value str
    Value of the environment variable override.
    description str
    Description of the environment variable override.
    id str
    Id of the environment variable override.
    key String
    Name of the environment variable override.
    value String
    Value of the environment variable override.
    description String
    Description of the environment variable override.
    id String
    Id of the environment variable override.

    HelmPorts, HelmPortsArgs

    ExternalPort int
    External port of the container. - Required if: ports.publicly_accessible=true. - Must be: >= 1 and <= 65535.
    InternalPort int
    Internal port of the container. - Must be: >= 1 and <= 65535.
    IsDefault bool
    If this port will be used for the root domain
    ServiceName string
    Namespace string
    Protocol string
    Protocol used for the port of the container. - Can be: GRPC, HTTP. - Default: HTTP.
    ExternalPort int
    External port of the container. - Required if: ports.publicly_accessible=true. - Must be: >= 1 and <= 65535.
    InternalPort int
    Internal port of the container. - Must be: >= 1 and <= 65535.
    IsDefault bool
    If this port will be used for the root domain
    ServiceName string
    Namespace string
    Protocol string
    Protocol used for the port of the container. - Can be: GRPC, HTTP. - Default: HTTP.
    externalPort Integer
    External port of the container. - Required if: ports.publicly_accessible=true. - Must be: >= 1 and <= 65535.
    internalPort Integer
    Internal port of the container. - Must be: >= 1 and <= 65535.
    isDefault Boolean
    If this port will be used for the root domain
    serviceName String
    namespace String
    protocol String
    Protocol used for the port of the container. - Can be: GRPC, HTTP. - Default: HTTP.
    externalPort number
    External port of the container. - Required if: ports.publicly_accessible=true. - Must be: >= 1 and <= 65535.
    internalPort number
    Internal port of the container. - Must be: >= 1 and <= 65535.
    isDefault boolean
    If this port will be used for the root domain
    serviceName string
    namespace string
    protocol string
    Protocol used for the port of the container. - Can be: GRPC, HTTP. - Default: HTTP.
    external_port int
    External port of the container. - Required if: ports.publicly_accessible=true. - Must be: >= 1 and <= 65535.
    internal_port int
    Internal port of the container. - Must be: >= 1 and <= 65535.
    is_default bool
    If this port will be used for the root domain
    service_name str
    namespace str
    protocol str
    Protocol used for the port of the container. - Can be: GRPC, HTTP. - Default: HTTP.
    externalPort Number
    External port of the container. - Required if: ports.publicly_accessible=true. - Must be: >= 1 and <= 65535.
    internalPort Number
    Internal port of the container. - Must be: >= 1 and <= 65535.
    isDefault Boolean
    If this port will be used for the root domain
    serviceName String
    namespace String
    protocol String
    Protocol used for the port of the container. - Can be: GRPC, HTTP. - Default: HTTP.

    HelmSecret, HelmSecretArgs

    Key string
    Key of the secret.
    Value string
    Value of the secret.
    Description string
    Description of the secret.
    Id string
    Id of the secret.
    Key string
    Key of the secret.
    Value string
    Value of the secret.
    Description string
    Description of the secret.
    Id string
    Id of the secret.
    key String
    Key of the secret.
    value String
    Value of the secret.
    description String
    Description of the secret.
    id String
    Id of the secret.
    key string
    Key of the secret.
    value string
    Value of the secret.
    description string
    Description of the secret.
    id string
    Id of the secret.
    key str
    Key of the secret.
    value str
    Value of the secret.
    description str
    Description of the secret.
    id str
    Id of the secret.
    key String
    Key of the secret.
    value String
    Value of the secret.
    description String
    Description of the secret.
    id String
    Id of the secret.

    HelmSecretAlias, HelmSecretAliasArgs

    Key string
    Name of the secret alias.
    Value string
    Name of the secret to alias.
    Description string
    Description of the secret alias.
    Id string
    Id of the secret alias.
    Key string
    Name of the secret alias.
    Value string
    Name of the secret to alias.
    Description string
    Description of the secret alias.
    Id string
    Id of the secret alias.
    key String
    Name of the secret alias.
    value String
    Name of the secret to alias.
    description String
    Description of the secret alias.
    id String
    Id of the secret alias.
    key string
    Name of the secret alias.
    value string
    Name of the secret to alias.
    description string
    Description of the secret alias.
    id string
    Id of the secret alias.
    key str
    Name of the secret alias.
    value str
    Name of the secret to alias.
    description str
    Description of the secret alias.
    id str
    Id of the secret alias.
    key String
    Name of the secret alias.
    value String
    Name of the secret to alias.
    description String
    Description of the secret alias.
    id String
    Id of the secret alias.

    HelmSecretOverride, HelmSecretOverrideArgs

    Key string
    Name of the secret override.
    Value string
    Value of the secret override.
    Description string
    Description of the secret override.
    Id string
    Id of the secret override.
    Key string
    Name of the secret override.
    Value string
    Value of the secret override.
    Description string
    Description of the secret override.
    Id string
    Id of the secret override.
    key String
    Name of the secret override.
    value String
    Value of the secret override.
    description String
    Description of the secret override.
    id String
    Id of the secret override.
    key string
    Name of the secret override.
    value string
    Value of the secret override.
    description string
    Description of the secret override.
    id string
    Id of the secret override.
    key str
    Name of the secret override.
    value str
    Value of the secret override.
    description str
    Description of the secret override.
    id str
    Id of the secret override.
    key String
    Name of the secret override.
    value String
    Value of the secret override.
    description String
    Description of the secret override.
    id String
    Id of the secret override.

    HelmSource, HelmSourceArgs

    GitRepository HelmSourceGitRepository
    Git repository
    HelmRepository HelmSourceHelmRepository
    Helm repositories can be private or public
    gitRepository HelmSourceGitRepository
    Git repository
    helmRepository HelmSourceHelmRepository
    Helm repositories can be private or public
    gitRepository HelmSourceGitRepository
    Git repository
    helmRepository HelmSourceHelmRepository
    Helm repositories can be private or public
    git_repository HelmSourceGitRepository
    Git repository
    helm_repository HelmSourceHelmRepository
    Helm repositories can be private or public
    gitRepository Property Map
    Git repository
    helmRepository Property Map
    Helm repositories can be private or public

    HelmSourceGitRepository, HelmSourceGitRepositoryArgs

    Url string
    Helm's source git repository URL
    Branch string
    Helm's source git repository branch
    GitTokenId string
    The git token ID to be used
    RootPath string
    Helm's source git repository root path
    Url string
    Helm's source git repository URL
    Branch string
    Helm's source git repository branch
    GitTokenId string
    The git token ID to be used
    RootPath string
    Helm's source git repository root path
    url String
    Helm's source git repository URL
    branch String
    Helm's source git repository branch
    gitTokenId String
    The git token ID to be used
    rootPath String
    Helm's source git repository root path
    url string
    Helm's source git repository URL
    branch string
    Helm's source git repository branch
    gitTokenId string
    The git token ID to be used
    rootPath string
    Helm's source git repository root path
    url str
    Helm's source git repository URL
    branch str
    Helm's source git repository branch
    git_token_id str
    The git token ID to be used
    root_path str
    Helm's source git repository root path
    url String
    Helm's source git repository URL
    branch String
    Helm's source git repository branch
    gitTokenId String
    The git token ID to be used
    rootPath String
    Helm's source git repository root path

    HelmSourceHelmRepository, HelmSourceHelmRepositoryArgs

    ChartName string
    Chart name
    ChartVersion string
    Chart version
    HelmRepositoryId string
    helm repository id
    ChartName string
    Chart name
    ChartVersion string
    Chart version
    HelmRepositoryId string
    helm repository id
    chartName String
    Chart name
    chartVersion String
    Chart version
    helmRepositoryId String
    helm repository id
    chartName string
    Chart name
    chartVersion string
    Chart version
    helmRepositoryId string
    helm repository id
    chart_name str
    Chart name
    chart_version str
    Chart version
    helm_repository_id str
    helm repository id
    chartName String
    Chart name
    chartVersion String
    Chart version
    helmRepositoryId String
    helm repository id

    HelmValuesOverride, HelmValuesOverrideArgs

    File ediri.Qovery.Inputs.HelmValuesOverrideFile
    Define overrides by selecting a YAML file from a git repository (preferred) or by passing raw YAML files.
    Set Dictionary<string, string>
    SetJson Dictionary<string, string>
    SetString Dictionary<string, string>
    File HelmValuesOverrideFile
    Define overrides by selecting a YAML file from a git repository (preferred) or by passing raw YAML files.
    Set map[string]string
    SetJson map[string]string
    SetString map[string]string
    file HelmValuesOverrideFile
    Define overrides by selecting a YAML file from a git repository (preferred) or by passing raw YAML files.
    set Map<String,String>
    setJson Map<String,String>
    setString Map<String,String>
    file HelmValuesOverrideFile
    Define overrides by selecting a YAML file from a git repository (preferred) or by passing raw YAML files.
    set {[key: string]: string}
    setJson {[key: string]: string}
    setString {[key: string]: string}
    file HelmValuesOverrideFile
    Define overrides by selecting a YAML file from a git repository (preferred) or by passing raw YAML files.
    set Mapping[str, str]
    set_json Mapping[str, str]
    set_string Mapping[str, str]
    file Property Map
    Define overrides by selecting a YAML file from a git repository (preferred) or by passing raw YAML files.
    set Map<String>
    setJson Map<String>
    setString Map<String>

    HelmValuesOverrideFile, HelmValuesOverrideFileArgs

    GitRepository ediri.Qovery.Inputs.HelmValuesOverrideFileGitRepository
    YAML file from a git repository
    Raw Dictionary<string, ediri.Qovery.Inputs.HelmValuesOverrideFileRaw>
    Raw YAML files
    GitRepository HelmValuesOverrideFileGitRepository
    YAML file from a git repository
    Raw map[string]HelmValuesOverrideFileRaw
    Raw YAML files
    gitRepository HelmValuesOverrideFileGitRepository
    YAML file from a git repository
    raw Map<String,HelmValuesOverrideFileRaw>
    Raw YAML files
    gitRepository HelmValuesOverrideFileGitRepository
    YAML file from a git repository
    raw {[key: string]: HelmValuesOverrideFileRaw}
    Raw YAML files
    git_repository HelmValuesOverrideFileGitRepository
    YAML file from a git repository
    raw Mapping[str, HelmValuesOverrideFileRaw]
    Raw YAML files
    gitRepository Property Map
    YAML file from a git repository
    raw Map<Property Map>
    Raw YAML files

    HelmValuesOverrideFileGitRepository, HelmValuesOverrideFileGitRepositoryArgs

    Branch string
    YAML file git repository branch
    Paths List<string>
    YAML files git repository paths
    Url string
    YAML file git repository URL
    GitTokenId string
    The git token ID to be used
    Branch string
    YAML file git repository branch
    Paths []string
    YAML files git repository paths
    Url string
    YAML file git repository URL
    GitTokenId string
    The git token ID to be used
    branch String
    YAML file git repository branch
    paths List<String>
    YAML files git repository paths
    url String
    YAML file git repository URL
    gitTokenId String
    The git token ID to be used
    branch string
    YAML file git repository branch
    paths string[]
    YAML files git repository paths
    url string
    YAML file git repository URL
    gitTokenId string
    The git token ID to be used
    branch str
    YAML file git repository branch
    paths Sequence[str]
    YAML files git repository paths
    url str
    YAML file git repository URL
    git_token_id str
    The git token ID to be used
    branch String
    YAML file git repository branch
    paths List<String>
    YAML files git repository paths
    url String
    YAML file git repository URL
    gitTokenId String
    The git token ID to be used

    HelmValuesOverrideFileRaw, HelmValuesOverrideFileRawArgs

    Content string
    content of the file
    Content string
    content of the file
    content String
    content of the file
    content string
    content of the file
    content str
    content of the file
    content String
    content of the file

    Import

    $ pulumi import qovery:index/helm:Helm my_helm "<helm_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.41.0 published on Saturday, Sep 28, 2024 by dirien
    dirien/pulumi-qovery