kubeconfig

package module

v0.1.0 Latest Latest Go to latest Published: Oct 24, 2022 License: MPL-2.0 Imports: 8 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/siderolabs/go-kubeconfig

Links

Open Source Insights

README ¶

go-kubeconfig

A package to handle client Kubernetes configuration.

Documentation ¶

Overview ¶

Package kubeconfig provides Kubernetes config file handling.

Index ¶

func DefaultPath() (string, error)
func SinglePath() (string, error)
type ConfigComponent
type ConflictDecision
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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultPath ¶

func DefaultPath() (string, error)

DefaultPath returns path to ~/.kube/config.

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 MergeOptions ¶

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

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL