Skip to content

Commit

Permalink
Include ansible-runner information
Browse files Browse the repository at this point in the history
  • Loading branch information
dymurray committed Oct 4, 2018
1 parent 8a7ef6f commit a15bf75
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/ansible/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This guide walks through an example of building a simple memcached-operator powe
- [docker][docker_tool] version 17.03+.
- [kubectl][kubectl_tool] version v1.9.0+.
- [ansible][ansible_tool] version v2.6.0+
- [ansible-runner][ansible_runner_tool] version v1.1.0+
- [ansible-runner-http][ansible_runner_http_plugin] version v1.0.0+
- [dep][dep_tool] version v0.5.0+. (Optional if you aren't installing from source)
- [go][go_tool] version v1.10+. (Optional if you aren't installing from source)
- Access to a kubernetes v.1.9.0+ cluster.
Expand Down Expand Up @@ -188,6 +190,9 @@ memcached-operator 1 1 1 1 1m

This method is preferred during the development cycle to speed up deployment and testing.

**Note**: Ensure that [Ansible Runner][ansible_runner_tool] and [Ansible Runner HTTP Plugin][ansible_runner_http_plugin] is installed or else you will see unexpected errors from Ansible Runner when a Custom Resource is created.

It is also important that the `role` path referenced in `watches.yaml` exists on your machine. Since we are normally used to using a container where the Role is put on disk for us, we need to manually copy our role to a path expected by Ansible.
Run the operator locally with the default kubernetes config file present at `$HOME/.kube/config`:

```sh
Expand Down Expand Up @@ -283,3 +288,5 @@ $ kubectl delete -f deploy/operator.yaml
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
[minikube_tool]:https://github.com/kubernetes/minikube#installation
[ansible_tool]:https://docs.ansible.com/ansible/latest/index.html
[ansible_runner_tool]:https://ansible-runner.readthedocs.io/en/latest/install.html
[ansible_runner_http_plugin]:https://github.com/ansible/ansible-runner-http

0 comments on commit a15bf75

Please sign in to comment.