The Automation API is now available. No CLI. No human-in-the-loop. Just your code. Learn More

Provider

The provider type for the kubernetes package.

Create a Provider Resource

new Provider(name: string, args?: Provider, opts?: CustomResourceOptions);
def Provider(resource_name: str, opts: Optional[ResourceOptions] = None, cluster: Optional[str] = None, context: Optional[str] = None, enable_dry_run: Optional[bool] = None, kubeconfig: Optional[str] = None, namespace: Optional[str] = None, render_yaml_to_directory: Optional[str] = None, suppress_deprecation_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)
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.
opts ResourceOptions
A bag of options that control this 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.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
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.

This config can be specified in the following ways, using this precedence: 1. This enableDryRun parameter. 2. The PULUMI_K8S_ENABLE_DRY_RUN environment variable.

KubeConfig string
The contents of a kubeconfig file or the path to a kubeconfig file. If this is set, this config will be used instead of $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.

This config can be specified in the following ways, using this precedence: 1. This suppressDeprecationWarnings parameter. 2. The PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS environment variable.

Cluster string
If present, the name of the kubeconfig cluster to use.
Context string
If present, the name of the kubeconfig context to use.
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.

This config can be specified in the following ways, using this precedence: 1. This enableDryRun parameter. 2. The PULUMI_K8S_ENABLE_DRY_RUN environment variable.

Kubeconfig string
The contents of a kubeconfig file or the path to a kubeconfig file. If this is set, this config will be used instead of $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.

This config can be specified in the following ways, using this precedence: 1. This suppressDeprecationWarnings parameter. 2. The PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS environment variable.

cluster string
If present, the name of the kubeconfig cluster to use.
context string
If present, the name of the kubeconfig context to use.
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.

This config can be specified in the following ways, using this precedence: 1. This enableDryRun parameter. 2. The PULUMI_K8S_ENABLE_DRY_RUN environment variable.

kubeconfig string
The contents of a kubeconfig file or the path to a kubeconfig file. If this is set, this config will be used instead of $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.

This config can be specified in the following ways, using this precedence: 1. This suppressDeprecationWarnings parameter. 2. The PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS environment variable.

cluster str
If present, the name of the kubeconfig cluster to use.
context str
If present, the name of the kubeconfig context to use.
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.

This config can be specified in the following ways, using this precedence: 1. This enableDryRun parameter. 2. The PULUMI_K8S_ENABLE_DRY_RUN environment variable.

kubeconfig str
The contents of a kubeconfig file or the path to a kubeconfig file. If this is set, this config will be used instead of $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.

This config can be specified in the following ways, using this precedence: 1. This suppressDeprecationWarnings parameter. 2. The PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS environment variable.

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 str
The provider-assigned unique ID for this managed resource.

Package Details

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