kubeconfig

Documentation

Overview

Package kubeconfig provides Kubernetes config file handling.

Index

• func DefaultPath() (string, error)
• func Generate(in *GenerateInput, out io.Writer) error
• func GenerateAdmin(config GenerateAdminInput, out io.Writer) error
• func SinglePath() (string, error)
• type ConfigComponent
• type ConflictDecision
• type GenerateAdminInput
• type GenerateInput
• type MergeOptions
• type Merger
  • func Load(path string) (*Merger, error)
  • func (merger *Merger) Merge(config *clientcmdapi.Config, options MergeOptions) error
  • func (merger *Merger) Write(path string) error

Functions

func DefaultPath

func DefaultPath() (string, error)

DefaultPath returns path to ~/.kube/config.

func Generate

func Generate(in *GenerateInput, out io.Writer) error

Generate a kubeconfig for the cluster from the given Input.

func GenerateAdmin

func GenerateAdmin(config GenerateAdminInput, out io.Writer) error

GenerateAdmin generates admin kubeconfig for the cluster.

func SinglePath

func SinglePath() (string, error)

SinglePath parses KUBECONFIG and the default kubeconfig file location and ensures there is only one to return.

Types

type ConfigComponent

type ConfigComponent string

ConfigComponent identifies part of kubeconfig.

const (
	Cluster  ConfigComponent = "cluster"
	AuthInfo ConfigComponent = "auth"
	Context  ConfigComponent = "context"
)

Kubeconfig components.

type ConflictDecision

type ConflictDecision string

ConflictDecision is returned from ConflictHandler.

const (
	OverwriteDecision ConflictDecision = "overwrite"
	RenameDecision    ConflictDecision = "rename"
)

Conflict decisions.

type GenerateAdminInput

type GenerateAdminInput interface {
	Name() string
	Endpoint() *url.URL
	CA() *x509.PEMEncodedCertificateAndKey
	AdminKubeconfig() config.AdminKubeconfig
}

GenerateAdminInput is the interface for the GenerateAdmin function.

This interface is implemented by config.Cluster().

type GenerateInput

type GenerateInput struct {
	ClusterName string

	CA                  *x509.PEMEncodedCertificateAndKey
	CertificateLifetime time.Duration

	CommonName   string
	Organization string

	Endpoint    string
	Username    string
	ContextName string
}

GenerateInput are input parameters for Generate.

type MergeOptions

type MergeOptions struct {
	ForceContextName string
	ActivateContext  bool
	ConflictHandler  func(ConfigComponent, string) (ConflictDecision, error)
	OutputWriter     io.Writer
}

MergeOptions controls Merge process.

type Merger

type Merger clientcmdapi.Config

Merger handles merging of Kubernetes client config files.

func Load

func Load(path string) (*Merger, error)

Load the kubeconfig from file.

func (*Merger) Merge

func (merger *Merger) Merge(config *clientcmdapi.Config, options MergeOptions) error

Merge the provided kubernetes config in.

func (*Merger) Write

func (merger *Merger) Write(path string) error

Write the kubeconfig back to the file.