Kubernetes

Pulumi Official
Package maintained by Pulumi
v3.19.4 published on Tuesday, Jun 21, 2022 by Pulumi

Provider

The provider type for the kubernetes package.

Create a Provider Resource

new Provider(name: string, args?: Provider, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cluster: Optional[str] = None,
             context: Optional[str] = None,
             delete_unreachable: Optional[bool] = None,
             enable_config_map_mutable: Optional[bool] = None,
             enable_dry_run: Optional[bool] = None,
             enable_replace_crd: Optional[bool] = None,
             helm_release_settings: Optional[HelmReleaseSettingsArgs] = None,
             kube_client_settings: Optional[KubeClientSettingsArgs] = None,
             kubeconfig: Optional[str] = None,
             namespace: Optional[str] = None,
             render_yaml_to_directory: Optional[str] = None,
             suppress_deprecation_warnings: Optional[bool] = None,
             suppress_helm_hook_warnings: Optional[bool] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:kubernetes
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Provider resource accepts the following input properties:

Cluster string

If present, the name of the kubeconfig cluster to use.

Context string

If present, the name of the kubeconfig context to use.

DeleteUnreachable bool

If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state

EnableConfigMapMutable bool

BETA FEATURE - If present and set to true, allow ConfigMaps to be mutated. This feature is in developer preview, and is disabled by default.

This config can be specified in the following ways using this precedence:

  1. This enableConfigMapMutable parameter.
  2. The PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE environment variable. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
EnableDryRun bool

BETA FEATURE - If present and set to true, enable server-side diff calculations. This feature is in developer preview, and is disabled by default. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_DRY_RUN

EnableReplaceCRD bool

Obsolete. This option has no effect. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_REPLACE_CRD

Deprecated:

This option is deprecated, and will be removed in a future release.

HelmReleaseSettings HelmReleaseSettingsArgs

Options to configure the Helm Release resource.

KubeClientSettings KubeClientSettingsArgs

Options for tuning the Kubernetes client used by a Provider.

KubeConfig string

The contents of a kubeconfig file or the path to a kubeconfig file. It can also be sourced from the following environment variable: KUBECONFIG

Namespace string

If present, the default namespace to use. This flag is ignored for cluster-scoped resources.

A namespace can be specified in multiple places, and the precedence is as follows:

  1. .metadata.namespace set on the resource.
  2. This namespace parameter.
  3. namespace set for the active context in the kubeconfig.
RenderYamlToDirectory string

BETA FEATURE - If present, render resource manifests to this directory. In this mode, resources will not be created on a Kubernetes cluster, but the rendered manifests will be kept in sync with changes to the Pulumi program. This feature is in developer preview, and is disabled by default.

Note that some computed Outputs such as status fields will not be populated since the resources are not created on a Kubernetes cluster. These Output values will remain undefined, and may result in an error if they are referenced by other resources. Also note that any secret values used in these resources will be rendered in plaintext to the resulting YAML.

SuppressDeprecationWarnings bool

If present and set to true, suppress apiVersion deprecation warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS

SuppressHelmHookWarnings bool

If present and set to true, suppress unsupported Helm hook warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_HELM_HOOK_WARNINGS

Cluster string

If present, the name of the kubeconfig cluster to use.

Context string

If present, the name of the kubeconfig context to use.

DeleteUnreachable bool

If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state

EnableConfigMapMutable bool

BETA FEATURE - If present and set to true, allow ConfigMaps to be mutated. This feature is in developer preview, and is disabled by default.

This config can be specified in the following ways using this precedence:

  1. This enableConfigMapMutable parameter.
  2. The PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE environment variable. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
EnableDryRun bool

BETA FEATURE - If present and set to true, enable server-side diff calculations. This feature is in developer preview, and is disabled by default. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_DRY_RUN

EnableReplaceCRD bool

Obsolete. This option has no effect. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_REPLACE_CRD

Deprecated:

This option is deprecated, and will be removed in a future release.

HelmReleaseSettings HelmReleaseSettingsArgs

Options to configure the Helm Release resource.

KubeClientSettings KubeClientSettingsArgs

Options for tuning the Kubernetes client used by a Provider.

Kubeconfig string

The contents of a kubeconfig file or the path to a kubeconfig file. It can also be sourced from the following environment variable: KUBECONFIG

Namespace string

If present, the default namespace to use. This flag is ignored for cluster-scoped resources.

A namespace can be specified in multiple places, and the precedence is as follows:

  1. .metadata.namespace set on the resource.
  2. This namespace parameter.
  3. namespace set for the active context in the kubeconfig.
RenderYamlToDirectory string

BETA FEATURE - If present, render resource manifests to this directory. In this mode, resources will not be created on a Kubernetes cluster, but the rendered manifests will be kept in sync with changes to the Pulumi program. This feature is in developer preview, and is disabled by default.

Note that some computed Outputs such as status fields will not be populated since the resources are not created on a Kubernetes cluster. These Output values will remain undefined, and may result in an error if they are referenced by other resources. Also note that any secret values used in these resources will be rendered in plaintext to the resulting YAML.

SuppressDeprecationWarnings bool

If present and set to true, suppress apiVersion deprecation warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS

SuppressHelmHookWarnings bool

If present and set to true, suppress unsupported Helm hook warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_HELM_HOOK_WARNINGS

cluster String

If present, the name of the kubeconfig cluster to use.

context String

If present, the name of the kubeconfig context to use.

deleteUnreachable Boolean

If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state

enableConfigMapMutable Boolean

BETA FEATURE - If present and set to true, allow ConfigMaps to be mutated. This feature is in developer preview, and is disabled by default.

This config can be specified in the following ways using this precedence:

  1. This enableConfigMapMutable parameter.
  2. The PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE environment variable. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
enableDryRun Boolean

BETA FEATURE - If present and set to true, enable server-side diff calculations. This feature is in developer preview, and is disabled by default. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_DRY_RUN

enableReplaceCRD Boolean

Obsolete. This option has no effect. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_REPLACE_CRD

Deprecated:

This option is deprecated, and will be removed in a future release.

helmReleaseSettings HelmReleaseSettingsArgs

Options to configure the Helm Release resource.

kubeClientSettings KubeClientSettingsArgs

Options for tuning the Kubernetes client used by a Provider.

kubeconfig String

The contents of a kubeconfig file or the path to a kubeconfig file. It can also be sourced from the following environment variable: KUBECONFIG

namespace String

If present, the default namespace to use. This flag is ignored for cluster-scoped resources.

A namespace can be specified in multiple places, and the precedence is as follows:

  1. .metadata.namespace set on the resource.
  2. This namespace parameter.
  3. namespace set for the active context in the kubeconfig.
renderYamlToDirectory String

BETA FEATURE - If present, render resource manifests to this directory. In this mode, resources will not be created on a Kubernetes cluster, but the rendered manifests will be kept in sync with changes to the Pulumi program. This feature is in developer preview, and is disabled by default.

Note that some computed Outputs such as status fields will not be populated since the resources are not created on a Kubernetes cluster. These Output values will remain undefined, and may result in an error if they are referenced by other resources. Also note that any secret values used in these resources will be rendered in plaintext to the resulting YAML.

suppressDeprecationWarnings Boolean

If present and set to true, suppress apiVersion deprecation warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS

suppressHelmHookWarnings Boolean

If present and set to true, suppress unsupported Helm hook warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_HELM_HOOK_WARNINGS

cluster string

If present, the name of the kubeconfig cluster to use.

context string

If present, the name of the kubeconfig context to use.

deleteUnreachable boolean

If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state

enableConfigMapMutable boolean

BETA FEATURE - If present and set to true, allow ConfigMaps to be mutated. This feature is in developer preview, and is disabled by default.

This config can be specified in the following ways using this precedence:

  1. This enableConfigMapMutable parameter.
  2. The PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE environment variable. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
enableDryRun boolean

BETA FEATURE - If present and set to true, enable server-side diff calculations. This feature is in developer preview, and is disabled by default. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_DRY_RUN

enableReplaceCRD boolean

Obsolete. This option has no effect. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_REPLACE_CRD

Deprecated:

This option is deprecated, and will be removed in a future release.

helmReleaseSettings HelmReleaseSettingsArgs

Options to configure the Helm Release resource.

kubeClientSettings KubeClientSettingsArgs

Options for tuning the Kubernetes client used by a Provider.

kubeconfig string

The contents of a kubeconfig file or the path to a kubeconfig file. It can also be sourced from the following environment variable: KUBECONFIG

namespace string

If present, the default namespace to use. This flag is ignored for cluster-scoped resources.

A namespace can be specified in multiple places, and the precedence is as follows:

  1. .metadata.namespace set on the resource.
  2. This namespace parameter.
  3. namespace set for the active context in the kubeconfig.
renderYamlToDirectory string

BETA FEATURE - If present, render resource manifests to this directory. In this mode, resources will not be created on a Kubernetes cluster, but the rendered manifests will be kept in sync with changes to the Pulumi program. This feature is in developer preview, and is disabled by default.

Note that some computed Outputs such as status fields will not be populated since the resources are not created on a Kubernetes cluster. These Output values will remain undefined, and may result in an error if they are referenced by other resources. Also note that any secret values used in these resources will be rendered in plaintext to the resulting YAML.

suppressDeprecationWarnings boolean

If present and set to true, suppress apiVersion deprecation warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS

suppressHelmHookWarnings boolean

If present and set to true, suppress unsupported Helm hook warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_HELM_HOOK_WARNINGS

cluster str

If present, the name of the kubeconfig cluster to use.

context str

If present, the name of the kubeconfig context to use.

delete_unreachable bool

If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state

enable_config_map_mutable bool

BETA FEATURE - If present and set to true, allow ConfigMaps to be mutated. This feature is in developer preview, and is disabled by default.

This config can be specified in the following ways using this precedence:

  1. This enableConfigMapMutable parameter.
  2. The PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE environment variable. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
enable_dry_run bool

BETA FEATURE - If present and set to true, enable server-side diff calculations. This feature is in developer preview, and is disabled by default. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_DRY_RUN

enable_replace_crd bool

Obsolete. This option has no effect. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_REPLACE_CRD

Deprecated:

This option is deprecated, and will be removed in a future release.

helm_release_settings HelmReleaseSettingsArgs

Options to configure the Helm Release resource.

kube_client_settings KubeClientSettingsArgs

Options for tuning the Kubernetes client used by a Provider.

kubeconfig str

The contents of a kubeconfig file or the path to a kubeconfig file. It can also be sourced from the following environment variable: KUBECONFIG

namespace str

If present, the default namespace to use. This flag is ignored for cluster-scoped resources.

A namespace can be specified in multiple places, and the precedence is as follows:

  1. .metadata.namespace set on the resource.
  2. This namespace parameter.
  3. namespace set for the active context in the kubeconfig.
render_yaml_to_directory str

BETA FEATURE - If present, render resource manifests to this directory. In this mode, resources will not be created on a Kubernetes cluster, but the rendered manifests will be kept in sync with changes to the Pulumi program. This feature is in developer preview, and is disabled by default.

Note that some computed Outputs such as status fields will not be populated since the resources are not created on a Kubernetes cluster. These Output values will remain undefined, and may result in an error if they are referenced by other resources. Also note that any secret values used in these resources will be rendered in plaintext to the resulting YAML.

suppress_deprecation_warnings bool

If present and set to true, suppress apiVersion deprecation warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS

suppress_helm_hook_warnings bool

If present and set to true, suppress unsupported Helm hook warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_HELM_HOOK_WARNINGS

cluster String

If present, the name of the kubeconfig cluster to use.

context String

If present, the name of the kubeconfig context to use.

deleteUnreachable Boolean

If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state

enableConfigMapMutable Boolean

BETA FEATURE - If present and set to true, allow ConfigMaps to be mutated. This feature is in developer preview, and is disabled by default.

This config can be specified in the following ways using this precedence:

  1. This enableConfigMapMutable parameter.
  2. The PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE environment variable. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
enableDryRun Boolean

BETA FEATURE - If present and set to true, enable server-side diff calculations. This feature is in developer preview, and is disabled by default. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_DRY_RUN

enableReplaceCRD Boolean

Obsolete. This option has no effect. It can also be sourced from the following environment variable: PULUMI_K8S_ENABLE_REPLACE_CRD

Deprecated:

This option is deprecated, and will be removed in a future release.

helmReleaseSettings Property Map

Options to configure the Helm Release resource.

kubeClientSettings Property Map

Options for tuning the Kubernetes client used by a Provider.

kubeconfig String

The contents of a kubeconfig file or the path to a kubeconfig file. It can also be sourced from the following environment variable: KUBECONFIG

namespace String

If present, the default namespace to use. This flag is ignored for cluster-scoped resources.

A namespace can be specified in multiple places, and the precedence is as follows:

  1. .metadata.namespace set on the resource.
  2. This namespace parameter.
  3. namespace set for the active context in the kubeconfig.
renderYamlToDirectory String

BETA FEATURE - If present, render resource manifests to this directory. In this mode, resources will not be created on a Kubernetes cluster, but the rendered manifests will be kept in sync with changes to the Pulumi program. This feature is in developer preview, and is disabled by default.

Note that some computed Outputs such as status fields will not be populated since the resources are not created on a Kubernetes cluster. These Output values will remain undefined, and may result in an error if they are referenced by other resources. Also note that any secret values used in these resources will be rendered in plaintext to the resulting YAML.

suppressDeprecationWarnings Boolean

If present and set to true, suppress apiVersion deprecation warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS

suppressHelmHookWarnings Boolean

If present and set to true, suppress unsupported Helm hook warnings from the CLI. It can also be sourced from the following environment variable: PULUMI_K8S_SUPPRESS_HELM_HOOK_WARNINGS

Outputs

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

Supporting Types

HelmReleaseSettings

Driver string

The backend storage driver for Helm. Values are: configmap, secret, memory, sql.

PluginsPath string

The path to the helm plugins directory.

RegistryConfigPath string

The path to the registry config file.

RepositoryCache string

The path to the file containing cached repository indexes.

RepositoryConfigPath string

The path to the file containing repository names and URLs.

Driver string

The backend storage driver for Helm. Values are: configmap, secret, memory, sql.

PluginsPath string

The path to the helm plugins directory.

RegistryConfigPath string

The path to the registry config file.

RepositoryCache string

The path to the file containing cached repository indexes.

RepositoryConfigPath string

The path to the file containing repository names and URLs.

driver String

The backend storage driver for Helm. Values are: configmap, secret, memory, sql.

pluginsPath String

The path to the helm plugins directory.

registryConfigPath String

The path to the registry config file.

repositoryCache String

The path to the file containing cached repository indexes.

repositoryConfigPath String

The path to the file containing repository names and URLs.

driver string

The backend storage driver for Helm. Values are: configmap, secret, memory, sql.

pluginsPath string

The path to the helm plugins directory.

registryConfigPath string

The path to the registry config file.

repositoryCache string

The path to the file containing cached repository indexes.

repositoryConfigPath string

The path to the file containing repository names and URLs.

driver str

The backend storage driver for Helm. Values are: configmap, secret, memory, sql.

plugins_path str

The path to the helm plugins directory.

registry_config_path str

The path to the registry config file.

repository_cache str

The path to the file containing cached repository indexes.

repository_config_path str

The path to the file containing repository names and URLs.

driver String

The backend storage driver for Helm. Values are: configmap, secret, memory, sql.

pluginsPath String

The path to the helm plugins directory.

registryConfigPath String

The path to the registry config file.

repositoryCache String

The path to the file containing cached repository indexes.

repositoryConfigPath String

The path to the file containing repository names and URLs.

KubeClientSettings

Burst int

Maximum burst for throttle. Default value is 10.

Qps double

Maximum queries per second (QPS) to the API server from this client. Default value is 5.

Burst int

Maximum burst for throttle. Default value is 10.

Qps float64

Maximum queries per second (QPS) to the API server from this client. Default value is 5.

burst Integer

Maximum burst for throttle. Default value is 10.

qps Double

Maximum queries per second (QPS) to the API server from this client. Default value is 5.

burst number

Maximum burst for throttle. Default value is 10.

qps number

Maximum queries per second (QPS) to the API server from this client. Default value is 5.

burst int

Maximum burst for throttle. Default value is 10.

qps float

Maximum queries per second (QPS) to the API server from this client. Default value is 5.

burst Number

Maximum burst for throttle. Default value is 10.

qps Number

Maximum queries per second (QPS) to the API server from this client. Default value is 5.

Package Details

Repository
https://github.com/pulumi/pulumi-kubernetes
License
Apache-2.0