Skip to content

Commit 225d4f8

Browse files
committed
osdocs-1055 ansible osdk docs
further changes corrections corrrections
1 parent 54b2596 commit 225d4f8

7 files changed

+23
-17
lines changed

modules/building-memcached-operator-using-osdk.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ using tools and libraries provided by the SDK.
2020
- Operator Lifecycle Manager (OLM) installed on a Kubernetes-based cluster (v1.8
2121
or above to support the `apps/v1beta2` API group), for example {product-title} {product-version}
2222
- Access to the cluster using an account with `cluster-admin` permissions
23-
- OpenShift CLI (`oc`) v4.1+ installed
23+
- OpenShift CLI (`oc`) v{product-version}+ installed
2424

2525
.Procedure
2626

modules/osdk-ansible-k8s-module-inside-operator.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,3 +173,9 @@ $ oc get deployment
173173
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
174174
foo-operator 1 1 1 1 1m
175175
----
176+
177+
. You can now view the Ansible logs for the `foo-operator`:
178+
+
179+
----
180+
$ oc logs deployment/foo-operator
181+
----

modules/osdk-ansible-k8s-module-installing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To install the `k8s` Ansible module on your local workstation:
99

1010
.Procedure
1111

12-
. Install Ansible 2.6+:
12+
. Install Ansible 2.9+:
1313
+
1414
----
1515
$ sudo yum install ansible

modules/osdk-ansible-k8s-module-testing-locally.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ local machine as opposed to running and rebuilding the Operator each time.
1313
. Initialize a new Ansible-based Operator project:
1414
+
1515
----
16-
$ operator-sdk new --type ansible --kind Foo --api-version foo.example.com/v1alpha1 foo-operator
16+
$ operator-sdk new --type ansible --kind foo --api-version foo.example.com/v1alpha1 foo-operator
1717
Create foo-operator/tmp/init/galaxy-init.sh
1818
Create foo-operator/tmp/build/Dockerfile
1919
Create foo-operator/tmp/build/test-framework/Dockerfile
2020
Create foo-operator/tmp/build/go-test.sh
21-
Rendering Ansible Galaxy role [foo-operator/roles/Foo]...
21+
Rendering Ansible Galaxy role [foo-operator/roles/foo]...
2222
Cleaning up foo-operator/tmp/init
2323
Create foo-operator/watches.yaml
2424
Create foo-operator/deploy/rbac.yaml
@@ -39,8 +39,8 @@ This example creates and deletes a namespace with the switch of a variable.
3939
+
4040
[source,yaml]
4141
----
42-
- name: set test namespace to {{ state }}
43-
k8s:
42+
- name: set test namespace to "{{ state }}"
43+
community.kubernetes.k8s:
4444
api_version: v1
4545
kind: Namespace
4646
state: "{{ state }}"
@@ -58,13 +58,13 @@ state: present
5858
----
5959

6060
. Create an Ansible playbook `playbook.yml` in the top-level directory, which
61-
includes the `Foo` role:
61+
includes the `foo` role:
6262
+
6363
[source,yaml]
6464
----
6565
- hosts: localhost
6666
roles:
67-
- Foo
67+
- foo
6868
----
6969

7070
. Run the playbook:
@@ -78,7 +78,7 @@ PLAY [localhost] ***************************************************************
7878
PROCEDURE [Gathering Facts] *********************************************************************
7979
ok: [localhost]
8080
81-
Task [Foo : set test namespace to present]
81+
Task [foo : set test namespace to present]
8282
changed: [localhost]
8383
8484
PLAY RECAP *********************************************************************************
@@ -107,7 +107,7 @@ PLAY [localhost] ***************************************************************
107107
PROCEDURE [Gathering Facts] *********************************************************************
108108
ok: [localhost]
109109
110-
Task [Foo : set test namespace to absent]
110+
Task [foo : set test namespace to absent]
111111
changed: [localhost]
112112
113113
PLAY RECAP *********************************************************************************

modules/osdk-building-ansible-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ the Operator SDK.
1414
- Operator SDK CLI installed on the development workstation
1515
- Access to a Kubernetes-based cluster v1.11.3+ (for example {product-title} {product-version})
1616
using an account with `cluster-admin` permissions
17-
- OpenShift CLI (`oc`) v4.1+ installed
18-
- link:https://docs.ansible.com/ansible/latest/index.html[`ansible`] v2.6.0+
17+
- OpenShift CLI (`oc`) v{product-version}+ installed
18+
- link:https://docs.ansible.com/ansible/latest/index.html[`ansible`] v2.9.0+
1919
- link:https://ansible-runner.readthedocs.io/en/latest/install.html[`ansible-runner`] v1.1.0+
2020
- link:https://github.com/ansible/ansible-runner-http[`ansible-runner-http`] v1.0.0+
2121

modules/osdk-building-helm-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ away from a Helm-based Operator.
2121
- Operator SDK CLI installed on the development workstation
2222
- Access to a Kubernetes-based cluster v1.11.3+ (for example {product-title} {product-version})
2323
using an account with `cluster-admin` permissions
24-
- OpenShift CLI (`oc`) v4.1+ installed
24+
- OpenShift CLI (`oc`) v{product-version}+ installed
2525

2626
.Procedure
2727

modules/osdk-installing-cli.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ endif::[]
3434
ifndef::openshift-origin[]
3535
- `docker` v17.03+, `podman` v1.2.0+, or `buildah` v1.7+
3636
endif::[]
37-
- OpenShift CLI (`oc`) 4.4+ installed
37+
- OpenShift CLI (`oc`) v{product-version}+ installed
3838
- Access to a cluster based on Kubernetes v1.12.0+
3939
- Access to a container registry
4040

@@ -43,7 +43,7 @@ endif::[]
4343
. Set the release version variable:
4444
+
4545
----
46-
RELEASE_VERSION=v0.15.0
46+
RELEASE_VERSION=v0.17.2
4747
----
4848

4949
. Download the release binary.
@@ -158,7 +158,7 @@ endif::[]
158158
ifndef::openshift-origin[]
159159
- `docker` v17.03+, `podman` v1.2.0+, or `buildah` v1.7+
160160
endif::[]
161-
- OpenShift CLI (`oc`) 4.4+ installed
161+
- OpenShift CLI (`oc`) v{product-version}+ installed
162162
- Access to a cluster based on Kubernetes v1.12.0+
163163
- Access to a container registry
164164

@@ -191,7 +191,7 @@ endif::[]
191191
ifndef::openshift-origin[]
192192
- `docker` v17.03+, `podman` v1.2.0+, or `buildah` v1.7+
193193
endif::[]
194-
- OpenShift CLI (`oc`) 4.4+ installed
194+
- OpenShift CLI (`oc`) v{product-version}+ installed
195195
- Access to a cluster based on Kubernetes v1.12.0+
196196
- Access to a container registry
197197

0 commit comments

Comments
 (0)