README
¶
kubernetesutils
Work with kubernetes.
The implementation using the official k8s client-go is available as:
- non object oriented implementation
- object oriented implementation which is on a higher abstraction layer than the non object oriented one.
Examples
- ConfigMap by name exists
- The examples to exec/ run commands as additional process inside a container are in nativekubernetes
- List namespace names
- List node names
- Secret by name exists
- Read and write secret
- Watch ConfigMap. Get callback on create, update, delete
Documentation
¶
Index ¶
- func IsInClusterAuthenticationAvailable(ctx context.Context) bool
- func SecretByNameExists(ctx context.Context, namespace string, secretName string)
- type KubectlContext
- type KubernetesControlplaneHost
- func GetKubernetesControlplaneByHost(host hosts.Host) (kubernetesControlplaneHost *KubernetesControlplaneHost, err error)
- func GetKubernetesControlplaneByHostname(hostname string) (kubernetesControlplaneHost *KubernetesControlplaneHost, err error)
- func NewKubernetesControlplaneHost() (kubernetesControlplaneHost *KubernetesControlplaneHost)
- func (k *KubernetesControlplaneHost) CheckIsKubernetesControlplane(verbose bool) (isKubernetesControlplane bool, err error)
- func (k *KubernetesControlplaneHost) GetJoinCommandAsString(verbose bool) (joinCommand string, err error)
- func (k *KubernetesControlplaneHost) GetJoinCommandAsStringSlice(verbose bool) (joinCommand []string, err error)
- func (k *KubernetesControlplaneHost) IsKubernetesControlplane(verbose bool) (isKubernetesControlplane bool, err error)
- type KubernetesNodeHost
- type WatchEventOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsInClusterAuthenticationAvailable ¶ added in v0.305.0
Types ¶
type KubectlContext ¶
type KubectlContext struct {
// contains filtered or unexported fields
}
func NewKubectlContext ¶
func NewKubectlContext() (k *KubectlContext)
func (*KubectlContext) GetCluster ¶
func (k *KubectlContext) GetCluster() (cluster string, err error)
func (*KubectlContext) GetName ¶
func (k *KubectlContext) GetName() (name string, err error)
func (*KubectlContext) SetCluster ¶
func (k *KubectlContext) SetCluster(cluster string) (err error)
func (*KubectlContext) SetName ¶
func (k *KubectlContext) SetName(name string) (err error)
type KubernetesControlplaneHost ¶
func GetKubernetesControlplaneByHost ¶
func GetKubernetesControlplaneByHost(host hosts.Host) (kubernetesControlplaneHost *KubernetesControlplaneHost, err error)
func GetKubernetesControlplaneByHostname ¶
func GetKubernetesControlplaneByHostname(hostname string) (kubernetesControlplaneHost *KubernetesControlplaneHost, err error)
func NewKubernetesControlplaneHost ¶
func NewKubernetesControlplaneHost() (kubernetesControlplaneHost *KubernetesControlplaneHost)
func (*KubernetesControlplaneHost) CheckIsKubernetesControlplane ¶
func (k *KubernetesControlplaneHost) CheckIsKubernetesControlplane(verbose bool) (isKubernetesControlplane bool, err error)
func (*KubernetesControlplaneHost) GetJoinCommandAsString ¶
func (k *KubernetesControlplaneHost) GetJoinCommandAsString(verbose bool) (joinCommand string, err error)
func (*KubernetesControlplaneHost) GetJoinCommandAsStringSlice ¶
func (k *KubernetesControlplaneHost) GetJoinCommandAsStringSlice(verbose bool) (joinCommand []string, err error)
func (*KubernetesControlplaneHost) IsKubernetesControlplane ¶
func (k *KubernetesControlplaneHost) IsKubernetesControlplane(verbose bool) (isKubernetesControlplane bool, err error)
type KubernetesNodeHost ¶
func GetKubernetesNodeByHost ¶
func GetKubernetesNodeByHost(host hosts.Host) (kubernetesNodeHost *KubernetesNodeHost, err error)
func GetKubernetesNodeByHostname ¶
func GetKubernetesNodeByHostname(hostname string) (kubernetesNodeHost *KubernetesNodeHost, err error)
func NewKubernetesNodeHost ¶
func NewKubernetesNodeHost() (kubernetesNodeHost *KubernetesNodeHost)
func (*KubernetesNodeHost) CheckIsKubernetesNode ¶
func (k *KubernetesNodeHost) CheckIsKubernetesNode(verbose bool) (isKubernetesNode bool, err error)
func (*KubernetesNodeHost) IsKubernetesNode ¶
func (k *KubernetesNodeHost) IsKubernetesNode(verbose bool) (isKubernetesNode bool, err error)
type WatchEventOptions ¶ added in v0.333.0
type WatchEventOptions struct {
ClusterName string
// Namespace to watch events. If not set all namespaces are watched:
Namespace string
// InvolvedObject API version, e.g apiextensions.k8s.io/v1 :
InvolvedObjectAPIVersion string
// InvolvedObject InvolvedObjectKind:
InvolvedObjectKind string
// InvolvedObject InvolvedObjectName:
InvolvedObjectName string
}
func (*WatchEventOptions) String ¶ added in v0.333.0
func (w *WatchEventOptions) String() string
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.