Documentation
¶
Overview ¶
Package workerk8s provides a simplified interface to interact with the Kubernetes API. It encapsulates the creation of a Kubernetes client and provides functionality to execute concurrent operations using worker goroutines.
The package is designed to be used in environments where Kubernetes is the orchestrator and the application is running as a pod within the Kubernetes cluster. It leverages the in-cluster configuration to create a client that can interact with the API server.
Functions ¶
- NewKubernetesClient: Establishes a new connection to the Kubernetes API server using in-cluster configuration and returns a Kubernetes clientset.
- Worker: A function that performs operations using the Kubernetes client. It sends the results of its operation to a channel for collection and further processing.
- RunWorkers: Starts a specified number of worker goroutines that call the Worker function and collects the results from all workers into a slice of strings.
Usage ¶
To use this package, first create a Kubernetes client by calling NewKubernetesClient. Then, use the client to run worker goroutines with RunWorkers, specifying the number of workers you want to start.
Example ¶
clientset, err := workerk8s.NewKubernetesClient()
if err != nil {
// Handle error
}
results := workerk8s.RunWorkers(clientset, 5)
for _, result := range results {
fmt.Println(result)
}
TODO ¶
- Implement error handling and retry logic within the Worker function to handle transient errors.
- Provide a context with a timeout or cancellation to control the lifetime of worker operations.
- Enhance the Worker function to perform a more specific task or to be more configurable.
- Consider adding a function to clean up resources or to gracefully shut down the workers.
- Expand the package to support other Kubernetes resources and operations.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewKubernetesClient ¶
func NewKubernetesClient() (*kubernetes.Clientset, error)
NewKubernetesClient creates and returns a new Kubernetes client.
func RunWorkers ¶
func RunWorkers(clientset *kubernetes.Clientset, numWorkers int) []string
RunWorkers starts a number of worker goroutines and collects their results.
func Worker ¶
func Worker(clientset *kubernetes.Clientset, results chan<- string)
Worker interacts with the Kubernetes API and sends results to a channel.
Types ¶
This section is empty.
Source Files