Skip to content

Commit

Permalink
Fix role tasks described as playbooks in readme (redhat-cop#2158)
Browse files Browse the repository at this point in the history
* Fix example workload readme playbook/tasks

* OCP4 workload docs fixes

* Bulk fix playbook/tasks language in role readme files
  • Loading branch information
jkupferer authored Jul 11, 2020
1 parent 19764d0 commit f0be933
Show file tree
Hide file tree
Showing 99 changed files with 479 additions and 479 deletions.
10 changes: 5 additions & 5 deletions ansible/roles/host-virtualenv/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

== Role overview

* This role set up a Python virtual environment on a host. It consists of the following playbooks:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
* This role set up a Python virtual environment on a host. It consists of the following tasks files:
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment.
*** Debug task will print out: `pre_workload Tasks completed successfully.`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to configure authentication
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to configure authentication
*** Debug task will print out: `workload Tasks completed successfully.`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks completed successfully.`

** Playbook: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
** Tasks: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
delete the workload
*** This role removes authentication from OCP 4. This role does *not* recreate the kubeadmin user - the only way to use OpenShift after removing the workload is via the `system:admin` user from the bastion VM.
*** Debug task will print out: `remove_workload Tasks completed successfully.`
Expand Down
6 changes: 3 additions & 3 deletions ansible/roles/ocp-workload-3scale-demo/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
6 changes: 3 additions & 3 deletions ansible/roles/ocp-workload-appdev-homework/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
6 changes: 3 additions & 3 deletions ansible/roles/ocp-workload-codeready-workspaces/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
6 changes: 3 additions & 3 deletions ansible/roles/ocp-workload-developer-environment/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
6 changes: 3 additions & 3 deletions ansible/roles/ocp-workload-dm7-qlb-demo/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
10 changes: 5 additions & 5 deletions ansible/roles/ocp-workload-edge-deployments/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

== Role overview

* This is a working no-op role that can be used to develop new ocp-workload roles. It consists of the following playbooks:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
* This is a working no-op role that can be used to develop new ocp-workload roles. It consists of the following tasks files:
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Debug task will print out: `pre_workload Tasks completed successfully.`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role only prints the current username for which this role is provisioning.
*** Debug task will print out: `workload Tasks completed successfully.`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks completed successfully.`

** Playbook: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
** Tasks: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
delete the workload
*** This role doesn't do anything here
*** Debug task will print out: `remove_workload Tasks completed successfully.`
Expand Down
10 changes: 5 additions & 5 deletions ansible/roles/ocp-workload-example/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@

== Role overview

* This is a working no-op role that can be used to develop new ocp-workload roles. It consists of the following playbooks:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
* This is a working no-op role that can be used to develop new ocp-workload roles. It consists of the following tasks files:
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Debug task will print out: `pre_workload Tasks completed successfully.`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile, some Demo or OpenShift customization
*** This role only prints the current username for which this role is provisioning.
*** Debug task will print out: `workload Tasks completed successfully.`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks completed successfully.`

** Playbook: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
** Tasks: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
delete the workload
*** This role doesn't do anything here
*** Debug task will print out: `remove_workload Tasks completed successfully.`
Expand Down
6 changes: 3 additions & 3 deletions ansible/roles/ocp-workload-fsi-cc-dispute-demo/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
8 changes: 4 additions & 4 deletions ansible/roles/ocp-workload-integreatly-iot/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This role executes the following tasks:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Runs pre-requisitie steps before installing Integreatly
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Runs pre-requisitie steps before installing Integreatly
*** Clones the Integreatly https://github.com/integr8ly/installation[Github repository] into a specified installation directory
*** Debug task will print out: `Pre-Workload tasks completed successfully.`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy Integreatly
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy Integreatly
*** Executes the Integreatly installer which installs a set of Middleware products on the target Openshift workshop cluster
*** Debug task will print out: `Workload Tasks completed successfully.`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `Post-Workload Tasks completed successfully.`

** Playbook: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
** Tasks: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
uninstall Integreatly
*** Executes the Integreatly uninstall playbook
*** Removes locally cloned Integreatly Github repository
Expand Down
8 changes: 4 additions & 4 deletions ansible/roles/ocp-workload-integreatly/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This role executes the following tasks:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Runs pre-requisitie steps before installing Integreatly
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Runs pre-requisitie steps before installing Integreatly
*** Clones the Integreatly https://github.com/integr8ly/installation[Github repository] into a specified installation directory
*** Debug task will print out: `Pre-Workload tasks completed successfully.`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy Integreatly
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy Integreatly
*** Executes the Integreatly installer which installs a set of Middleware products on the target Openshift workshop cluster
*** Debug task will print out: `Workload Tasks completed successfully.`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `Post-Workload Tasks completed successfully.`

** Playbook: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
** Tasks: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to
uninstall Integreatly
*** Executes the Integreatly uninstall playbook
*** Removes locally cloned Integreatly Github repository
Expand Down
6 changes: 3 additions & 3 deletions ansible/roles/ocp-workload-iot-demo/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Adds a user to a list of groups defined in the
link:./defaults/main.yml[defaults file].
*** Sets a cluster resource quota for the user based on the variables in the
link:./defaults/main.yml[defaults file] .
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the actual
workload, i.e, 3scale, Mobile or some Demo
*** This role doesn't do anything here
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** This role doesn't do anything here
*** Debug task will print out: `post_workload Tasks Complete`
Expand Down
12 changes: 6 additions & 6 deletions ansible/roles/ocp-workload-odo-workshop/readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@
== Role overview

* This is a simple role that does the following:
** Playbook: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_workload.yml[pre_workload.yml] - Sets up an
environment for the workload deployment
*** Copies ~/.kube/config to a temp directory and sets the KUBECONFIG env variable.
*** Debug task will print out: `pre_workload Tasks Complete`

** Playbook: link:./tasks/workload.yml[workload.yml] - Used to deploy the
** Tasks: link:./tasks/workload.yml[workload.yml] - Used to deploy the
odo lab environment.
*** Creates a new project and a deployment for the learning portal.
*** Debug task will print out: `workload Tasks Complete`

** Playbook: link:./tasks/post_workload.yml[post_workload.yml] - Used to
** Tasks: link:./tasks/post_workload.yml[post_workload.yml] - Used to
configure the workload after deployment
*** Removes the temp .kube/config file.
*** Debug task will print out: `post_workload Tasks Complete`

** Playbook: link:./tasks/pre_remove_workload.yml[pre_remove_workload.yml] - Sets up an
** Tasks: link:./tasks/pre_remove_workload.yml[pre_remove_workload.yml] - Sets up an
environment for the workload removal
*** Copies ~/.kube/config to a temp directory and sets the KUBECONFIG env variable.
*** Debug task will print out: `pre_workload Removal Tasks Complete`

** Playbook: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to clean up the environment and delete all resources.
** Tasks: link:./tasks/remove_workload.yml[remove_workload.yml] - Used to clean up the environment and delete all resources.
*** Deletes resources and projects that were created.
*** Debug task will print out: `workload Removal Tasks Complete`

** Playbook: link:./tasks/post_remove_workload.yml[post_remove_workload.yml] - Used to
** Tasks: link:./tasks/post_remove_workload.yml[post_remove_workload.yml] - Used to
configure the workload after deployment
*** Removes the temp .kube/config file.
*** Debug task will print out: `post_workload Removal Tasks Complete`
Expand Down
Loading

0 comments on commit f0be933

Please sign in to comment.