Address issue add Prerequisites section to README.md
@@ -30,6 +30,15 @@ The SDK provides the following workflow to develop a new operator:
At a high level an operator using the SDK processes events for watched resources in a user defined handler and takes actions to reconcile the state of the application.
+## Prerequisites
+
+- [dep][dep_tool] version v0.4.1+.
+- [git][git_tool]
+- [go][go_tool] version v1.10+.
+- [docker][docker_tool] version 17.03+.
+- [kubectl][kubectl_tool] version v1.9.0+.
+- Access to a kubernetes v.1.9.0+ cluster.
+
## Quick Start
First, checkout and install the operator-sdk CLI:
@@ -75,6 +84,8 @@ $ kubectl delete -f deploy/operator.yaml
$ kubectl delete -f deploy/rbac.yaml
```
+## User Guide
+
To learn more about the operator-sdk, see the [user guide][guide].
## Samples
@@ -102,3 +113,8 @@ Operator SDK is under Apache 2.0 license. See the [LICENSE][license_file] file f
[contrib]: ./CONTRIBUTING.MD
[bug_guide]:./doc/dev/reporting_bugs.md
[license_file]:./LICENSE
+[dep_tool]:https://golang.github.io/dep/docs/installation.html
+[git_tool]:https://git-scm.com/downloads
+[go_tool]:https://golang.org/dl/
+[docker_tool]:https://docs.docker.com/install/
+[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
