README
¶
goutils/v2/k8s
The k8s package is a collection of utility functions
designed to simplify common k8s tasks.
Table of contents
Functions
KubernetesClient.DeleteKubernetesJob(string)
DeleteKubernetesJob(string) error
DeleteKubernetesJob deletes a Kubernetes Job in the specified namespace.
ManifestConfig.ApplyOrDeleteManifest(context.Context)
ApplyOrDeleteManifest(context.Context) error
ApplyOrDeleteManifest applies or deletes a Kubernetes manifest based on the ManifestConfig settings.
Parameters:
ctx: Context for the operation.
Returns:
error: Error if any issue occurs while applying or deleting the manifest.
ManifestConfig.HandleRawManifest(context.Context, dynamic.Interface)
HandleRawManifest(context.Context, dynamic.Interface) error
HandleRawManifest applies or deletes raw Kubernetes manifests based on the operation specified in ManifestConfig.
Parameters:
ctx: The context for the operation. dynClient: The dynamic client to perform Kubernetes operations.
Returns:
error: Error if any issue occurs while handling the raw manifest.
ManifestOperation.String()
String() string
String returns the string representation of the ManifestType.
Returns:
string: The string representation of the ManifestType.
NewKubernetesClient(string, fileReaderFunc)
NewKubernetesClient(string, fileReaderFunc) *KubernetesClient, error
NewKubernetesClient creates a new KubernetesClient using the provided kubeconfig path and file reader function.
Parameters:
kubeconfig: Path to the kubeconfig file to configure access to the Kubernetes API. reader: A function to read the kubeconfig file from the specified path.
Returns:
*KubernetesClient: A new KubernetesClient instance configured with the specified kubeconfig. error: An error if any issue occurs while creating the Kubernetes client.
NewManifestConfig()
NewManifestConfig() *ManifestConfig
NewManifestConfig creates a new ManifestConfig with default settings.
Returns:
*ManifestConfig: A new ManifestConfig instance with ReadFile set to os.ReadFile.
StreamLogs(kubernetes.Interface, string)
StreamLogs(kubernetes.Interface, string) error
StreamLogs connects to a Kubernetes cluster and streams logs from a specified pod, or dynamically locates and streams logs from pods associated with a job or deployment.
Parameters:
clientset: The Kubernetes client interface for connecting to the cluster. namespace: The namespace in which the resources are located. resourceType: The type of resource ('pod', 'job', or 'deployment') from which logs are to be streamed. resourceName: The name of the resource.
Returns:
error: An error object if an issue occurs during the log streaming process. Nil if the operation is successful.
The function first determines the pod name directly if the resource type is 'pod'. For 'job' or 'deployment', it queries associated pods based on label selectors. Once the relevant pod is identified, it sets up a log streaming connection using the Kubernetes API. Logs are streamed directly to the standard output. Any issues during these steps, such as failure to find pods or streaming errors, result in returning an error.
Installation
To use the goutils/v2/k8s package, you first need to install it. Follow the steps below to install via go get.
go get github.com/l50/goutils/v2/k8s
Usage
After installation, you can import the package in your Go project using the following import statement:
import "github.com/l50/goutils/v2/k8s"
Tests
To ensure the package is working correctly, run the following
command to execute the tests for goutils/v2/k8s:
go test -v
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Directories