virtual-kubelet: github.com/virtual-kubelet/virtual-kubelet Index | Files | Directories

package virtualkubelet

import "github.com/virtual-kubelet/virtual-kubelet"

Package virtualkubelet is currently just for providing docs for godoc.

Virtual Kubelet is a project which aims to provide a library that can be consumed by other projects to build a Kubernetes node agent that performs the same basic role as the Kubelet, but fully customize the behavior.

*Note*: Virtual Kubelet is not the Kubelet.

All of the business logic for virtual-kubelet is in the `node` package. The node package has controllers for managing the node in Kubernetes and running scheduled pods against a backend service. The backend service along with the code wrapping what is provided in the node package is what consumers of this project would implement. In the interest of not duplicating examples, please see that package on how to get started using virtual kubelet.

Virtual Kubelet supports propagation of logging and traces through a context. See the "log" and "trace" packages for how to use this.

Errors produced by and consumed from the node package are expected to conform to error types defined in the "errdefs" package in order to be able to understand the kind of failure that occurred and react accordingly.

Index

Package Files

doc.go

Directories

PathSynopsis
cmd/virtual-kubelet
cmd/virtual-kubelet/internal/commands/providers
cmd/virtual-kubelet/internal/commands/root
cmd/virtual-kubelet/internal/commands/version
cmd/virtual-kubelet/internal/provider
cmd/virtual-kubelet/internal/provider/mock
errdefsPackage errdefs defines the error types that are understood by other packages in this project.
internal/lockdeps
internal/managerPackage manager provides access to kubernetes resources for providers.
internal/test/suite
internal/test/util
logPackage log defines the interfaces used for logging in virtual-kubelet.
log/logrusPackage logrus implements a github.com/virtual-kubelet/virtual-kubelet/log.Logger using Logrus as a backend You can use this by creating a logrus logger and calling `FromLogrus(entry)`.
nodePackage node implements the components for operating a node in Kubernetes.
node/apiPackage api implements HTTP handlers for handling requests that the kubelet would normally implement, such as pod logs, exec, etc.
tracePackage trace abstracts virtual-kubelet's tracing capabilities into a set of interfaces.
trace/opencensusPackage opencensus implements a github.com/virtual-kubelet/virtual-kubelet/trace.Tracer using opencensus as a backend.

Updated 2019-10-19. Refresh now. Tools for package owners.