Skip to content

Commit bab3d1d

Browse files
author
Eric Stroczynski
authored
doc/{ansible,helm}/dev: 'up local' -> 'run --local' (#2455)
1 parent c6848c7 commit bab3d1d

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

doc/ansible/dev/developer_guide.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -187,13 +187,13 @@ annotations:
187187

188188
Once a developer is comfortable working with the above workflow, it will be
189189
beneficial to test the logic inside of an operator. To accomplish this, we can
190-
use `operator-sdk up local` from the top-level directory of our project. The
191-
`up local` command reads from `./watches.yaml` and uses `~/.kube/config` to
190+
use `operator-sdk run --local` from the top-level directory of our project. The
191+
`run --local` command reads from `./watches.yaml` and uses `~/.kube/config` to
192192
communicate with a Kubernetes cluster just as the `k8s` modules do. This
193193
section assumes the developer has read the [Ansible Operator user
194194
guide][ansible_operator_user_guide] and has the proper dependencies installed.
195195

196-
Since `up local` reads from `./watches.yaml`, there are a couple options
196+
Since `run --local` reads from `./watches.yaml`, there are a couple options
197197
available to the developer. If `role` is left alone (by default
198198
`/opt/ansible/roles/<name>`) the developer must copy the role over to
199199
`/opt/ansible/roles` from the operator directly. This is cumbersome because
@@ -218,9 +218,9 @@ $ kubectl create -f deploy/role.yaml
218218
$ kubectl create -f deploy/role_binding.yaml
219219
```
220220

221-
Run the `up local` command:
221+
Run the `run --local` command:
222222
```bash
223-
$ operator-sdk up local
223+
$ operator-sdk run --local
224224
INFO[0000] Go Version: go1.10.3
225225
INFO[0000] Go OS/Arch: linux/amd64
226226
INFO[0000] operator-sdk Version: 0.0.6+git
@@ -441,14 +441,14 @@ Please look over the following sections for help debugging an Ansible Operator:
441441
* [Additional Ansible debug](../user-guide.md#additional-ansible-debug)
442442
* [Testing Ansible Operators with Molecule](testing_guide.md#testing-ansible-operators-with-molecule)
443443

444-
### Using k8s_status Ansible module with `up local`
444+
### Using k8s_status Ansible module with `run --local`
445445
This section covers the required steps to using the `k8s_status` Ansible module
446-
with `operator-sdk up local`. If you are unfamiliar with managing status from
446+
with `operator-sdk run --local`. If you are unfamiliar with managing status from
447447
the Ansible Operator, see the [proposal for user-driven status
448448
management][manage_status_proposal].
449449

450450
If your operator takes advantage of the `k8s_status` Ansible module and you are
451-
interested in testing the operator with `operator-sdk up local`, then
451+
interested in testing the operator with `operator-sdk run --local`, then
452452
you will need to install the collection locally.
453453

454454
```sh

doc/helm/dev/developer_guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -320,8 +320,8 @@ being released by the operator.
320320

321321
Once a developer is comfortable working with the above workflow, it will be
322322
beneficial to test the logic inside of an operator. To accomplish this, we can
323-
use `operator-sdk up local` from the top-level directory of our project. The
324-
`up local` command reads from `./watches.yaml` and uses `~/.kube/config` to
323+
use `operator-sdk run --local` from the top-level directory of our project. The
324+
`run --local` command reads from `./watches.yaml` and uses `~/.kube/config` to
325325
communicate with a Kubernetes cluster just as the `helm` CLI commands did
326326
when we were testing our Helm chart locally. This section assumes the developer
327327
has read the [Helm Operator user guide][helm_operator_user_guide] and has the
@@ -334,12 +334,12 @@ inside of the `deploy` folder:
334334
kubectl create -f deploy/crds/foo.example.com_foos_crd.yaml
335335
```
336336

337-
**NOTE:** When running the Helm operator locally, the `up local` command will default to using the kubeconfig file specified by `$KUBECONFIG` with a fallback to `$HOME/.kube/config` if not set. In this case, the autogenerated RBAC definitions do not need to be applied to the cluster.
337+
**NOTE:** When running the Helm operator locally, the `run --local` command will default to using the kubeconfig file specified by `$KUBECONFIG` with a fallback to `$HOME/.kube/config` if not set. In this case, the autogenerated RBAC definitions do not need to be applied to the cluster.
338338

339-
Run the `up local` command:
339+
Run the `run --local` command:
340340

341341
```sh
342-
$ operator-sdk up local
342+
$ operator-sdk run --local
343343
INFO[0000] Running the operator locally.
344344
INFO[0000] Go Version: go1.10.3
345345
INFO[0000] Go OS/Arch: linux/amd64

0 commit comments

Comments
 (0)