Merge pull request #13643 from adellape/osdk_ansible

Add Ansible-support to OSDK docs

Author: adellape

_topic_map.yml

@@ -56,6 +56,8 @@ Topics:
     File: olm-creating-apps-from-installed-operators
   - Name: Getting started with the Operator SDK
     File: osdk-getting-started
+  - Name: Creating Ansible-based Operators
+    File: osdk-ansible
   - Name: Creating Helm-based Operators
     File: osdk-helm
   - Name: Operator SDK CLI reference

applications_and_projects/operators/osdk-ansible.adoc

@@ -0,0 +1,52 @@
+:relfileprefix: ../
+[id='osdk-ansible']
+= Creating Ansible-based Operators
+include::modules/common-attributes.adoc[]
+:context: osdk-ansible
+
+toc::[]
+
+{nbsp} +
+This guide outlines Ansible support in the Operator SDK and walks Operator
+authors through examples building and running Ansible-based Operators with the
+`operator-sdk` CLI tool that use Ansible playbooks and modules.
+
+include::modules/osdk-ansible-support.adoc[leveloffset=+1]
+include::modules/osdk-ansible-custom-resource-files.adoc[leveloffset=+2]
+include::modules/osdk-ansible-watches-file.adoc[leveloffset=+2]
+include::modules/osdk-ansible-extra-variables.adoc[leveloffset=+2]
+include::modules/osdk-ansible-runner-directory.adoc[leveloffset=+2]
+
+include::modules/osdk-installing-cli.adoc[leveloffset=+1]
+include::modules/osdk-building-ansible-operator.adoc[leveloffset=+1]
+
+[id='osdk-ansible-k8s-module']
+== Managing application lifecycle using the k8s Ansible module
+
+To manage the lifecycle of your application on Kubernetes using Ansible, you
+can use the link:https://docs.ansible.com/ansible/2.7/modules/k8s_module.html[`k8s` Ansible module].
+This Ansible module allows a developer to either leverage their existing
+Kubernetes resource files (written in YAML) or express the lifecycle management
+in native Ansible.
+
+One of the biggest benefits of using Ansible in conjunction with existing
+Kubernetes resource files is the ability to use Jinja templating so that you can
+customize resources with the simplicity of a few variables in Ansible.
+
+This section goes into detail on usage of the `k8s` Ansible module. To get
+started, install the module on your local workstation and test it using a
+playbook before moving on to using it within an Operator.
+
+include::modules/osdk-ansible-k8s-module-installing.adoc[leveloffset=+2]
+include::modules/osdk-ansible-k8s-module-testing-locally.adoc[leveloffset=+2]
+include::modules/osdk-ansible-k8s-module-inside-operator.adoc[leveloffset=+2]
+
+include::modules/osdk-ansible-managing-cr-status.adoc[leveloffset=+1]
+
+[id='osdk-ansible-addtl-resources']
+== Additional resources
+
+- See
+xref:../applications_and_projects/operators/operators-appendices.adoc#olm-operator-project-scaffolding-layout_operator-appendices[Appendices]
+to learn about the project directory structures created by the Operator SDK.
+- link:https://blog.openshift.com/reaching-for-the-stars-with-ansible-operator/[Reaching for the Stars with Ansible Operator] - Red Hat OpenShift Blog

applications_and_projects/operators/osdk-getting-started.adoc

@@ -15,16 +15,19 @@ accomplished using two centerpieces of the Operator Framework: the Operator SDK
 Operator Lifecycle Manager (OLM).
 
 include::modules/osdk-operator-sdk.adoc[leveloffset=+1]
-include::modules/installing-operator-sdk-cli.adoc[leveloffset=+1]
+include::modules/osdk-installing-cli.adoc[leveloffset=+1]
 include::modules/building-memcached-operator-using-osdk.adoc[leveloffset=+1]
-.Additional resources
+include::modules/managing-memcached-operator-using-olm.adoc[leveloffset=+1]
+
+[id='osdk-getting-started-addtl-resources']
+== Additional resources
+
 - See
 xref:../applications_and_projects/operators/operators-appendices.adoc#olm-operator-project-scaffolding-layout_operator-appendices[Appendices]
 to learn about the project directory structures created by the Operator SDK.
 
-include::modules/managing-memcached-operator-using-olm.adoc[leveloffset=+1]
-
 ifdef::openshift-origin[]
+[id='osdk-getting-started-getting-involved']
 == Getting involved
 
 This guide provides an effective demonstration of the value of the Operator

applications_and_projects/operators/osdk-helm.adoc

@@ -12,9 +12,12 @@ authors through an example of building and running an Nginx Operator with the
 `operator-sdk` CLI tool that uses an existing Helm chart.
 
 include::modules/osdk-helm-chart-support.adoc[leveloffset=+1]
+include::modules/osdk-installing-cli.adoc[leveloffset=+1]
+include::modules/osdk-building-helm-operator.adoc[leveloffset=+1]
 
-See the following sections for instructions on installing the Operator SDK to
-build and run your own Helm-based Operator.
+[id='osdk-helm-addtl-resources']
+== Additional resources
 
-include::modules/installing-operator-sdk-cli.adoc[leveloffset=+1]
-include::modules/building-operator-with-helm-using-osdk.adoc[leveloffset=+1]
+- See
+xref:../applications_and_projects/operators/operators-appendices.adoc#olm-operator-project-scaffolding-layout_operator-appendices[Appendices]
+to learn about the project directory structures created by the Operator SDK.

modules/crd-creating-custom-resources-from-file.adoc

@@ -36,7 +36,7 @@ spec: <5>
   image: my-awesome-cron-image
 ----
 +
-<1> Specify the group name and API version (name/version) from the custom resource definition.
+<1> Specify the group name and API version (name/version) from the Custom Resource Definition.
 <2> Specify the type in the CRD.
 <3> Specify a name for the object.
 <4> Specify the

modules/crd-custom-resource-definitions.adoc

@@ -37,7 +37,6 @@ available to all users.
 
 [NOTE]
 ====
-While only cluster administrators can create CRDs, developers can create the
-custom resource from an existing CRD if they have read and write permission to
-it.
+While only cluster administrators can create CRDs, developers can create the CR
+from an existing CRD if they have read and write permission to it.
 ====

modules/node-management.adoc

@@ -43,7 +43,7 @@ configuration for nodes.
 The `bootkube` process calls the `machine-config-server` component when the 
 {product-title} installer bootstraps the initial master node. After installation,
 the `machine-config-server` runs in the cluster.  It reads the `machine-config`
-custom resource definitions (CRDs) and serves the required Ignition configurations
+Custom Resource Definitions (CRDs) and serves the required Ignition configurations
 to new nodes when they join the cluster.
 ////
 

modules/nodes-pods-disabling-features-list.adoc

@@ -42,7 +42,7 @@ see the link:https://github.com/kubernetes/community/blob/master/contributors/de
 See Extending the Kubernetes API with Custom Resources.
 
 | *CustomResourceValidation*
-| Enables schema-based validation on resources created from a custom resource definition.
+| Enables schema-based validation on resources created from a Custom Resource Definition.
 For more information, see Extending the Kubernetes API with Custom Resources.
 
 | *Debugcontainers*

modules/nodes-pods-secrets-creating-opaque.adoc

@@ -26,7 +26,7 @@ data:
 ----
 <1> Specifies an opaque secret.
 
-. Use the following command command to create a secret object:
+. Use the following command to create a secret object:
 +
 [source,bash]
 ----

modules/olm-operator-project-staffolding-layout.adoc

@@ -22,7 +22,7 @@ command contain the following directories and files:
 
 |`cmd/`
 |Contains `manager/main.go` file, which is the main program of the Operator. This
-instantiates a new manager which registers all custom resource definitions under
+instantiates a new manager which registers all Custom Resource Definitions under
 `pkg/apis/` and starts all controllers under `pkg/controllers/`.
 
 |`pkg/apis/`