summaryrefslogtreecommitdiff
path: root/vendor/k8s.io/utils/README.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2018-03-26 18:26:55 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-03-27 18:09:12 +0000
commitaf64e10400f8533a0c48ecdf5ab9b7fbf329e14e (patch)
tree59160e3841b440dd35189c724bbb4375a7be173b /vendor/k8s.io/utils/README.md
parent26d7e3c7b85e28c4e42998c90fdcc14079f13eef (diff)
downloadpodman-af64e10400f8533a0c48ecdf5ab9b7fbf329e14e.tar.gz
podman-af64e10400f8533a0c48ecdf5ab9b7fbf329e14e.tar.bz2
podman-af64e10400f8533a0c48ecdf5ab9b7fbf329e14e.zip
Vendor in lots of kubernetes stuff to shrink image size
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #554 Approved by: mheon
Diffstat (limited to 'vendor/k8s.io/utils/README.md')
-rw-r--r--vendor/k8s.io/utils/README.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/vendor/k8s.io/utils/README.md b/vendor/k8s.io/utils/README.md
new file mode 100644
index 000000000..3765eed26
--- /dev/null
+++ b/vendor/k8s.io/utils/README.md
@@ -0,0 +1,57 @@
+# Utils
+
+[![Build Status]](https://travis-ci.org/kubernetes/utils) [![GoDoc](https://godoc.org/k8s.io/utils?status.svg)](https://godoc.org/k8s.io/utils)
+
+A set of Go libraries that provide low-level,
+kubernetes-independent packages supplementing the [Go
+standard libs].
+
+## Purpose
+
+As Kubernetes grows and spins functionality out of its
+[core] and into cooperating repositories like
+[apiserver], [kubectl], [kubeadm], etc., the need
+arises for leaf repositories to house shared code and
+avoid cycles in repository relationships.
+
+This repository is intended to hold shared utilities
+with no Kubernetes dependence that may be of interest
+to any Go project. See these [instructions for moving]
+an existing package to this repository.
+
+
+## Criteria for adding code here
+
+- Used by multiple Kubernetes repositories.
+
+- Full unit test coverage.
+
+- Go tools compliant (`go get`, `go test`, etc.).
+
+- Complex enough to be worth vendoring, rather than copying.
+
+- Stable, or backward compatible, API.
+
+- _No dependence on any Kubernetes repository_.
+
+## Libraries
+
+- [Exec](/exec) provides an interface for `os/exec`. It makes it easier
+ to mock and replace in tests, especially with
+ the [FakeExec](exec/testing/fake_exec.go) struct.
+
+- [Temp](/temp) provides an interface to create temporary directories. It also
+ provides a [FakeDir](temp/temptest) implementation to replace in tests.
+
+- [Clock](/clock) provides an interface for time-based operations. It allows
+ mocking time for testing.
+
+[Build Status]: https://travis-ci.org/kubernetes/utils.svg?branch=master
+[Go standard libs]: https://golang.org/pkg/#stdlib
+[api]: https://github.com/kubernetes/api
+[apiserver]: https://github.com/kubernetes/apiserver
+[core]: https://github.com/kubernetes/kubernetes
+[ingress]: https://github.com/kubernetes/ingress
+[kubeadm]: https://github.com/kubernetes/kubeadm
+[kubectl]: https://github.com/kubernetes/kubectl
+[instructions for moving]: ./HOWTOMOVE.md