kubernetes

Documentation

Overview

A Pulumi package for creating and managing Kubernetes resources.

Index

• type Provider
  • func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, ...) (*Provider, error)
• type ProviderArgs
  • func (ProviderArgs) ElementType() reflect.Type
• type UntypedArgs
  • func (UntypedArgs) ElementType() reflect.Type

Types

type Provider

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the kubernetes package.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

type ProviderArgs

type ProviderArgs struct {
	// If present, the name of the kubeconfig cluster to use.
	Cluster pulumi.StringPtrInput
	// If present, the name of the kubeconfig context to use.
	Context pulumi.StringPtrInput
	// 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.
	EnableDryRun pulumi.BoolPtrInput
	// The contents of a kubeconfig file. If this is set, this config will be used instead of $KUBECONFIG.
	Kubeconfig pulumi.StringPtrInput
	// 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.
	Namespace pulumi.StringPtrInput
	// 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.
	RenderYamlToDirectory pulumi.StringPtrInput
	// 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.
	SuppressDeprecationWarnings pulumi.BoolPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type UntypedArgs

type UntypedArgs map[string]interface{}

UntypedArgs is an untyped interface that is required for YAML and CustomResource support.

func (UntypedArgs) ElementType

func (UntypedArgs) ElementType() reflect.Type