kubernetes.Provider
Explore with Pulumi AI
The provider type for the kubernetes package.
Create Provider Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Provider(name: string, args?: Provider, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
args: Optional[ProviderArgs] = None,
opts: Optional[ResourceOptions] = None)
@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_server_side_apply: 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,
skip_update_unreachable: Optional[bool] = None,
suppress_deprecation_warnings: Optional[bool] = None,
suppress_helm_hook_warnings: Optional[bool] = 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.
Parameters
- 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.
- Delete
Unreachable bool - If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_DELETE_UNREACHABLE
- Enable
Config boolMap Mutable 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:
- This
enableConfigMapMutable
parameter. - The
PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
environment variable. It can also be sourced from the following environment variable:PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
- This
- Enable
Server boolSide Apply - If present and set to false, disable Server-Side Apply mode.
See https://github.com/pulumi/pulumi-kubernetes/issues/2011 for additional details. It can also be sourced from the following environment variable:
PULUMI_K8S_ENABLE_SERVER_SIDE_APPLY
- Helm
Release HelmSettings Release Settings - Options to configure the Helm Release resource.
- Kube
Client KubeSettings Client Settings - Options for tuning the Kubernetes client used by a Provider.
- Kube
Config 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:
.metadata.namespace
set on the resource.- This
namespace
parameter. namespace
set for the active context in the kubeconfig.
- Render
Yaml stringTo Directory 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.
- Skip
Update boolUnreachable - If present and set to true, the provider will skip resources update associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_SKIP_UPDATE_UNREACHABLE
- Suppress
Deprecation boolWarnings - 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 boolHook Warnings - 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.
- Delete
Unreachable bool - If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_DELETE_UNREACHABLE
- Enable
Config boolMap Mutable 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:
- This
enableConfigMapMutable
parameter. - The
PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
environment variable. It can also be sourced from the following environment variable:PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
- This
- Enable
Server boolSide Apply - If present and set to false, disable Server-Side Apply mode.
See https://github.com/pulumi/pulumi-kubernetes/issues/2011 for additional details. It can also be sourced from the following environment variable:
PULUMI_K8S_ENABLE_SERVER_SIDE_APPLY
- Helm
Release HelmSettings Release Settings Args - Options to configure the Helm Release resource.
- Kube
Client KubeSettings Client Settings Args - 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:
.metadata.namespace
set on the resource.- This
namespace
parameter. namespace
set for the active context in the kubeconfig.
- Render
Yaml stringTo Directory 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.
- Skip
Update boolUnreachable - If present and set to true, the provider will skip resources update associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_SKIP_UPDATE_UNREACHABLE
- Suppress
Deprecation boolWarnings - 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 boolHook Warnings - 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.
- delete
Unreachable Boolean - If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_DELETE_UNREACHABLE
- enable
Config BooleanMap Mutable 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:
- This
enableConfigMapMutable
parameter. - The
PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
environment variable. It can also be sourced from the following environment variable:PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
- This
- enable
Server BooleanSide Apply - If present and set to false, disable Server-Side Apply mode.
See https://github.com/pulumi/pulumi-kubernetes/issues/2011 for additional details. It can also be sourced from the following environment variable:
PULUMI_K8S_ENABLE_SERVER_SIDE_APPLY
- helm
Release HelmSettings Release Settings - Options to configure the Helm Release resource.
- kube
Client KubeSettings Client Settings - 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:
.metadata.namespace
set on the resource.- This
namespace
parameter. namespace
set for the active context in the kubeconfig.
- render
Yaml StringTo Directory 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.
- skip
Update BooleanUnreachable - If present and set to true, the provider will skip resources update associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_SKIP_UPDATE_UNREACHABLE
- suppress
Deprecation BooleanWarnings - 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 BooleanHook Warnings - 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.
- delete
Unreachable boolean - If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_DELETE_UNREACHABLE
- enable
Config booleanMap Mutable 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:
- This
enableConfigMapMutable
parameter. - The
PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
environment variable. It can also be sourced from the following environment variable:PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
- This
- enable
Server booleanSide Apply - If present and set to false, disable Server-Side Apply mode.
See https://github.com/pulumi/pulumi-kubernetes/issues/2011 for additional details. It can also be sourced from the following environment variable:
PULUMI_K8S_ENABLE_SERVER_SIDE_APPLY
- helm
Release HelmSettings Release Settings - Options to configure the Helm Release resource.
- kube
Client KubeSettings Client Settings - 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:
.metadata.namespace
set on the resource.- This
namespace
parameter. namespace
set for the active context in the kubeconfig.
- render
Yaml stringTo Directory 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.
- skip
Update booleanUnreachable - If present and set to true, the provider will skip resources update associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_SKIP_UPDATE_UNREACHABLE
- suppress
Deprecation booleanWarnings - 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 booleanHook Warnings - 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 It can also be sourced from the following environment variable:
PULUMI_K8S_DELETE_UNREACHABLE
- enable_
config_ boolmap_ mutable 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:
- This
enableConfigMapMutable
parameter. - The
PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
environment variable. It can also be sourced from the following environment variable:PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
- This
- enable_
server_ boolside_ apply - If present and set to false, disable Server-Side Apply mode.
See https://github.com/pulumi/pulumi-kubernetes/issues/2011 for additional details. It can also be sourced from the following environment variable:
PULUMI_K8S_ENABLE_SERVER_SIDE_APPLY
- helm_
release_ Helmsettings Release Settings Args - Options to configure the Helm Release resource.
- kube_
client_ Kubesettings Client Settings Args - 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:
.metadata.namespace
set on the resource.- This
namespace
parameter. namespace
set for the active context in the kubeconfig.
- render_
yaml_ strto_ directory 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.
- skip_
update_ boolunreachable - If present and set to true, the provider will skip resources update associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_SKIP_UPDATE_UNREACHABLE
- suppress_
deprecation_ boolwarnings - 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_ boolhook_ warnings - 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.
- delete
Unreachable Boolean - If present and set to true, the provider will delete resources associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_DELETE_UNREACHABLE
- enable
Config BooleanMap Mutable 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:
- This
enableConfigMapMutable
parameter. - The
PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
environment variable. It can also be sourced from the following environment variable:PULUMI_K8S_ENABLE_CONFIGMAP_MUTABLE
- This
- enable
Server BooleanSide Apply - If present and set to false, disable Server-Side Apply mode.
See https://github.com/pulumi/pulumi-kubernetes/issues/2011 for additional details. It can also be sourced from the following environment variable:
PULUMI_K8S_ENABLE_SERVER_SIDE_APPLY
- helm
Release Property MapSettings - Options to configure the Helm Release resource.
- kube
Client Property MapSettings - 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:
.metadata.namespace
set on the resource.- This
namespace
parameter. namespace
set for the active context in the kubeconfig.
- render
Yaml StringTo Directory 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.
- skip
Update BooleanUnreachable - If present and set to true, the provider will skip resources update associated with an unreachable Kubernetes cluster from Pulumi state It can also be sourced from the following environment variable:
PULUMI_K8S_SKIP_UPDATE_UNREACHABLE
- suppress
Deprecation BooleanWarnings - 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 BooleanHook Warnings - 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, HelmReleaseSettingsArgs
- Driver string
- The backend storage driver for Helm. Values are: configmap, secret, memory, sql.
- Plugins
Path string - The path to the helm plugins directory.
- Registry
Config stringPath - The path to the registry config file.
- Repository
Cache string - The path to the directory containing cached repository indexes.
- Repository
Config stringPath - The path to the file containing repository names and URLs.
- Driver string
- The backend storage driver for Helm. Values are: configmap, secret, memory, sql.
- Plugins
Path string - The path to the helm plugins directory.
- Registry
Config stringPath - The path to the registry config file.
- Repository
Cache string - The path to the directory containing cached repository indexes.
- Repository
Config stringPath - The path to the file containing repository names and URLs.
- driver String
- The backend storage driver for Helm. Values are: configmap, secret, memory, sql.
- plugins
Path String - The path to the helm plugins directory.
- registry
Config StringPath - The path to the registry config file.
- repository
Cache String - The path to the directory containing cached repository indexes.
- repository
Config StringPath - The path to the file containing repository names and URLs.
- driver string
- The backend storage driver for Helm. Values are: configmap, secret, memory, sql.
- plugins
Path string - The path to the helm plugins directory.
- registry
Config stringPath - The path to the registry config file.
- repository
Cache string - The path to the directory containing cached repository indexes.
- repository
Config stringPath - 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_ strpath - The path to the registry config file.
- repository_
cache str - The path to the directory containing cached repository indexes.
- repository_
config_ strpath - The path to the file containing repository names and URLs.
- driver String
- The backend storage driver for Helm. Values are: configmap, secret, memory, sql.
- plugins
Path String - The path to the helm plugins directory.
- registry
Config StringPath - The path to the registry config file.
- repository
Cache String - The path to the directory containing cached repository indexes.
- repository
Config StringPath - The path to the file containing repository names and URLs.
KubeClientSettings, KubeClientSettingsArgs
Package Details
- Repository
- Kubernetes pulumi/pulumi-kubernetes
- License
- Apache-2.0