summaryrefslogtreecommitdiff
path: root/vendor/k8s.io/utils/README.md
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@gmail.com>2017-12-08 15:11:14 -0500
committerAtomic Bot <atomic-devel@projectatomic.io>2017-12-14 23:59:21 +0000
commit840eb04e03e9292c54621c7ff75cbf95e690d86f (patch)
tree60216367054d06720a38ba96b1e1b1827e7e23a2 /vendor/k8s.io/utils/README.md
parent316341a81dec52c5fd84c6e8c194639240c57273 (diff)
downloadpodman-840eb04e03e9292c54621c7ff75cbf95e690d86f.tar.gz
podman-840eb04e03e9292c54621c7ff75cbf95e690d86f.tar.bz2
podman-840eb04e03e9292c54621c7ff75cbf95e690d86f.zip
Add iptables integration to network code
Signed-off-by: Matthew Heon <matthew.heon@gmail.com> Closes: #109 Approved by: mheon
Diffstat (limited to 'vendor/k8s.io/utils/README.md')
-rw-r--r--vendor/k8s.io/utils/README.md51
1 files changed, 51 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..2504649ef
--- /dev/null
+++ b/vendor/k8s.io/utils/README.md
@@ -0,0 +1,51 @@
+# Utils
+
+[![Build Status]](https://travis-ci.org/kubernetes/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.
+
+[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