kubeconfig

Documentation

Overview

Package kubeconfig implements utilities for working with kubeconfigs.

Index

• Variables
• func CreateSecret(ctx context.Context, c client.Client, cluster *clusterv1.Cluster) error
• func CreateSecretWithOwner(ctx context.Context, c client.Client, clusterName client.ObjectKey, ...) error
• func FromEnvTestConfig(cfg *rest.Config, cluster *clusterv1.Cluster) []byte
• func FromSecret(ctx context.Context, c client.Reader, cluster client.ObjectKey) ([]byte, error)
• func GenerateSecret(cluster *clusterv1.Cluster, data []byte) *corev1.Secret
• func GenerateSecretWithOwner(clusterName client.ObjectKey, data []byte, owner metav1.OwnerReference) *corev1.Secret
• func NeedsClientCertRotation(configSecret *corev1.Secret, threshold time.Duration) (bool, error)
• func New(clusterName, endpoint string, caCert *x509.Certificate, caKey crypto.Signer) (*api.Config, error)
• func RegenerateSecret(ctx context.Context, c client.Client, configSecret *corev1.Secret) error

Variables

var (
	// ErrDependentCertificateNotFound signals that a CA secret could not be found.
	ErrDependentCertificateNotFound = errors.New("could not find secret ca")
)

Functions

func CreateSecret

func CreateSecret(ctx context.Context, c client.Client, cluster *clusterv1.Cluster) error

CreateSecret creates the Kubeconfig secret for the given cluster.

func CreateSecretWithOwner

func CreateSecretWithOwner(ctx context.Context, c client.Client, clusterName client.ObjectKey, endpoint string, owner metav1.OwnerReference) error

CreateSecretWithOwner creates the Kubeconfig secret for the given cluster name, namespace, endpoint, and owner reference.

func FromEnvTestConfig

func FromEnvTestConfig(cfg *rest.Config, cluster *clusterv1.Cluster) []byte

FromEnvTestConfig returns a new Kubeconfig in byte form when running in envtest.

func FromSecret

func FromSecret(ctx context.Context, c client.Reader, cluster client.ObjectKey) ([]byte, error)

FromSecret fetches the Kubeconfig for a Cluster.

func GenerateSecret

func GenerateSecret(cluster *clusterv1.Cluster, data []byte) *corev1.Secret

GenerateSecret returns a Kubernetes secret for the given Cluster and kubeconfig data.

func GenerateSecretWithOwner

func GenerateSecretWithOwner(clusterName client.ObjectKey, data []byte, owner metav1.OwnerReference) *corev1.Secret

GenerateSecretWithOwner returns a Kubernetes secret for the given Cluster name, namespace, kubeconfig data, and ownerReference.

func NeedsClientCertRotation

func NeedsClientCertRotation(configSecret *corev1.Secret, threshold time.Duration) (bool, error)

NeedsClientCertRotation returns whether any of the Kubeconfig secret's client certificates will expire before the given threshold.

func New

func New(clusterName, endpoint string, caCert *x509.Certificate, caKey crypto.Signer) (*api.Config, error)

New creates a new Kubeconfig using the cluster name and specified endpoint.

func RegenerateSecret

func RegenerateSecret(ctx context.Context, c client.Client, configSecret *corev1.Secret) error

RegenerateSecret creates and stores a new Kubeconfig in the given secret.