mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/tests/testdata/codegen/kubernetes20/docs/provider/_index.md

32 KiB
Raw Permalink Blame History

title: "Provider" title_tag: "kubernetes.Provider" meta_desc: "Documentation for the kubernetes.Provider resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

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,
             kube_client_settings: Optional[KubeClientSettingsArgs] = None,
             kubeconfig: Optional[str] = None,
             namespace: Optional[str] = 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

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

The Provider resource accepts the following input properties:

KubeClientSettings Pulumi.Kubernetes.Inputs.KubeClientSettings
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.
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.
kubeClientSettings KubeClientSettings
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.
kubeClientSettings KubeClientSettings
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.
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.
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.

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

KubeClientSettings, KubeClientSettingsArgs

Timeout int
Maximum time in seconds to wait before cancelling a HTTP request to the Kubernetes server. Default value is 32. It can also be sourced from the following environment variable: PULUMI_K8S_CLIENT_TIMEOUT
Timeout int
Maximum time in seconds to wait before cancelling a HTTP request to the Kubernetes server. Default value is 32. It can also be sourced from the following environment variable: PULUMI_K8S_CLIENT_TIMEOUT
timeout Integer
Maximum time in seconds to wait before cancelling a HTTP request to the Kubernetes server. Default value is 32. It can also be sourced from the following environment variable: PULUMI_K8S_CLIENT_TIMEOUT
timeout number
Maximum time in seconds to wait before cancelling a HTTP request to the Kubernetes server. Default value is 32. It can also be sourced from the following environment variable: PULUMI_K8S_CLIENT_TIMEOUT
timeout int
Maximum time in seconds to wait before cancelling a HTTP request to the Kubernetes server. Default value is 32. It can also be sourced from the following environment variable: PULUMI_K8S_CLIENT_TIMEOUT
timeout Number
Maximum time in seconds to wait before cancelling a HTTP request to the Kubernetes server. Default value is 32. It can also be sourced from the following environment variable: PULUMI_K8S_CLIENT_TIMEOUT

Package Details

Repository
Kubernetes pulumi/pulumi-kubernetes
License
Apache-2.0