nativekubernetes

package

v0.448.0 Latest Latest Go to latest Published: Sep 5, 2025 License: Apache-2.0 Imports: 25 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/asciich/asciichgolangpublic

Links

Open Source Insights

README ¶

nativekubernetes package

Non object oriented implementation using the official client-go library to interact with kubernetes.

For the object oriented implmenetation see nativekubernetesoo.

Examples

Copy file to pod: Copy a local file to a pod/container.
Exec: Run command in already existing pod/container.
- Write to stdin of exec command
Get clientset: Get the k8s client-go clientset.
Run temporary pod and get stdout: How to run a single command in Kubernetes and get it's stdout.

Documentation ¶

Index ¶

Variables
func CopyFileToPod(ctx context.Context, config *rest.Config, localFile string, destPath string, ...) error
func CreatePod(ctx context.Context, config *rest.Config, ...) error
func DeletePod(ctx context.Context, clientset *kubernetes.Clientset, podName string, ...) error
func Exec(ctx context.Context, config *rest.Config, ...) (*commandoutput.CommandOutput, error)
func GetClientSet(ctx context.Context, clusterName string) (*kubernetes.Clientset, error)
func GetClientSetFromRestConfig(ctx context.Context, restConfig *rest.Config) (*kubernetes.Clientset, error)
func GetConfig(ctx context.Context, clusterName string) (*rest.Config, error)
func GetConfigFromKubeconfig(ctx context.Context, clusterName string) (*rest.Config, error)
func GetContainerAllLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, ...) ([]byte, error)
func GetContainerLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, ...) (stdout []byte, stderr []byte, err error)
func GetContainerStderrLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, ...) ([]byte, error)
func GetContainerStdoutLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, ...) ([]byte, error)
func GetInClusterConfig(ctx context.Context) (*rest.Config, error)
func PodExists(ctx context.Context, clientSet *kubernetes.Clientset, podName string, ...) (bool, error)
func RunCommandInTemporaryPod(ctx context.Context, config *rest.Config, ...) (*commandoutput.CommandOutput, error)
func WaitForPodDeleted(ctx context.Context, clientset *kubernetes.Clientset, namespaceName string, ...) error
func WaitForPodRunning(ctx context.Context, clientSet *kubernetes.Clientset, namespace string, ...) error
func WaitForPodSucceeded(ctx context.Context, clientSet *kubernetes.Clientset, namespace string, ...) error

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrOnlyCombinedStreamAvailable = errors.New("specify the stream is not supported. Only combinded stream is availalbe by the kubernetes API, feature flag seems deactivated")

Functions ¶

func CopyFileToPod ¶ added in v0.438.0

func CopyFileToPod(ctx context.Context, config *rest.Config, localFile string, destPath string, podName string, containerName string, namespaceName string) error

func CreatePod ¶ added in v0.436.0

func CreatePod(ctx context.Context, config *rest.Config, options *kubernetesparameteroptions.RunCommandOptions) error

func DeletePod ¶ added in v0.361.0

func DeletePod(ctx context.Context, clientset *kubernetes.Clientset, podName string, namespace string) error

func Exec ¶ added in v0.436.0

func Exec(ctx context.Context, config *rest.Config, options *kubernetesparameteroptions.RunCommandOptions) (*commandoutput.CommandOutput, error)

func GetClientSet ¶

func GetClientSet(ctx context.Context, clusterName string) (*kubernetes.Clientset, error)

Get the kubernetes.Clientset to communicate with the kubernetes cluster.

If in cluster authentication is available (e.g. running in a pod in the cluster) the returned clientset uses this method.

Otherwise a clientset based on ~/.kube/config is returned.

clusterName is optional. If not specified the default cluster is taken.

func GetClientSetFromRestConfig ¶ added in v0.438.0

func GetClientSetFromRestConfig(ctx context.Context, restConfig *rest.Config) (*kubernetes.Clientset, error)

func GetConfig ¶ added in v0.341.0

func GetConfig(ctx context.Context, clusterName string) (*rest.Config, error)

Get the rest.Config to communicate with the kubernetes cluster.

If in cluster authentication is available (e.g. running in a pod in the cluster) the returned config uses this method.

Otherwise a config based on ~/.kube/config is returned.

clusterName is optional. If not specified the default cluster is taken.

func GetConfigFromKubeconfig ¶ added in v0.341.0

func GetConfigFromKubeconfig(ctx context.Context, clusterName string) (*rest.Config, error)

func GetContainerAllLogs ¶ added in v0.361.0

func GetContainerAllLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, podName string, containerName string) ([]byte, error)

'All' combines stdout and stderr.

func GetContainerLogs ¶ added in v0.361.0

func GetContainerLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, podName string, containerName string) (stdout []byte, stderr []byte, err error)

func GetContainerStderrLogs ¶ added in v0.361.0

func GetContainerStderrLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, podName string, containerName string) ([]byte, error)

func GetContainerStdoutLogs ¶ added in v0.361.0

func GetContainerStdoutLogs(ctx context.Context, clientset *kubernetes.Clientset, namespace string, podName string, containerName string) ([]byte, error)

func GetInClusterConfig ¶ added in v0.341.0

func GetInClusterConfig(ctx context.Context) (*rest.Config, error)

func PodExists ¶ added in v0.436.0

func PodExists(ctx context.Context, clientSet *kubernetes.Clientset, podName string, namespace string) (bool, error)

func RunCommandInTemporaryPod ¶ added in v0.361.0

func RunCommandInTemporaryPod(ctx context.Context, config *rest.Config, options *kubernetesparameteroptions.RunCommandOptions) (*commandoutput.CommandOutput, error)

func WaitForPodDeleted ¶ added in v0.436.0

func WaitForPodDeleted(ctx context.Context, clientset *kubernetes.Clientset, namespaceName string, podName string, timeout time.Duration) error

func WaitForPodRunning ¶ added in v0.436.0

func WaitForPodRunning(ctx context.Context, clientSet *kubernetes.Clientset, namespace string, podName string, timeout time.Duration) error

func WaitForPodSucceeded ¶ added in v0.436.0

func WaitForPodSucceeded(ctx context.Context, clientSet *kubernetes.Clientset, namespace string, podName string, timeout time.Duration) error

Types ¶

This section is empty.

Source Files ¶

View all Source files

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