From d3ff785e081537b4c9271a8e77795cbee73e371a Mon Sep 17 00:00:00 2001 From: Brian Goff Date: Fri, 5 Jul 2019 14:42:56 -0700 Subject: [PATCH] Add godoc to the repo root. (#702) --- doc.go | 24 ++++++++++++++++++++++++ errdefs/doc.go | 4 ++++ 2 files changed, 28 insertions(+) create mode 100644 doc.go create mode 100644 errdefs/doc.go diff --git a/doc.go b/doc.go new file mode 100644 index 000000000..ab91877f2 --- /dev/null +++ b/doc.go @@ -0,0 +1,24 @@ +/* +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 propgagation 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. +*/ +package virtualkubelet diff --git a/errdefs/doc.go b/errdefs/doc.go new file mode 100644 index 000000000..e078f9096 --- /dev/null +++ b/errdefs/doc.go @@ -0,0 +1,4 @@ +// Package errdefs defines the error types that are understood by other packages +// in this project. Consumers of this project should look here to know how to +// produce and consume erors for this project. +package errdefs