Merge pull request #601 from IBM/dev

Dev ==> Master

Author: rajan-mis

README.md

@@ -105,7 +105,7 @@ The following IBM Spectrum Scale versions are tested:
 Specific OS requirements:
 
 - For CES (SMB/NFS) on SLES15, Python 3 is required.
-- For CES (OBJECT) RhedHat 8.x is required. 
+- For CES (OBJECT) RhedHat 8.x is required.
 
 
 Prerequisites
@@ -150,29 +150,47 @@ Users need to have a basic understanding of the [Ansible concepts](https://docs.
 Installation Instructions
 -------------------------
 
-- **Clone `ibm-spectrum-scale-install-infra` repository to your [Ansible control node](https://docs.ansible.com/ansible/latest/user_guide/basic_concepts.html#control-node)**
+- **Create project directory on [Ansible control node](https://docs.ansible.com/ansible/latest/user_guide/basic_concepts.html#control-node)**
+
+  The preferred way of accessing the roles provided by this project is by placing them inside the `collections/ansible_collections/ibm/spectrum_scale` directory of your project, adjacent to your [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks.html). Simply clone the repository to the correct path:
 
   ```shell
-  $ git clone https://github.com/IBM/ibm-spectrum-scale-install-infra.git
+  $ mkdir my_project
+  $ cd my_project
+  $ git clone https://github.com/IBM/ibm-spectrum-scale-install-infra.git collections/ansible_collections/ibm/spectrum_scale
   ```
 
-- **Change working directory**
-
-  There are different methods for accessing the roles provided by this project. You can either change your working directory to the cloned repository and create your own files inside this directory (optionally copying examples from the [samples/](samples/) subdirectory):
+  Be sure to clone the project under the correct subdirectory:
 
   ```shell
-  $ cd ibm-spectrum-scale-install-infra/
+  my_project/
+  ├── collections/
+  │   └── ansible_collections/
+  │       └── ibm/
+  │           └── spectrum_scale/
+  │               └── ...
+  ├── hosts
+  └── playbook.yml
   ```
 
-  Alternatively, you can define an [Ansible environment variable](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#envvar-ANSIBLE_ROLES_PATH) to make the roles accessible in any external project directory:
+  - **Alternatives - now deprecated!**
 
-  ```shell
-  $ export ANSIBLE_ROLES_PATH=$(pwd)/ibm-spectrum-scale-install-infra/roles/
-  ```
+    Alternatively, you can clone the project repository and create your [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks.html) inside the repository's directory structure:
+
+      ```shell
+      $ git clone https://github.com/IBM/ibm-spectrum-scale-install-infra.git
+      $ cd ibm-spectrum-scale-install-infra
+      ```
+
+    Yet another alternative, you can also define an [Ansible environment variable](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#envvar-ANSIBLE_ROLES_PATH) to make the roles accessible in any external project directory:
+
+      ```shell
+      $ export ANSIBLE_ROLES_PATH=$(pwd)/ibm-spectrum-scale-install-infra/roles/
+      ```
 
 - **Create Ansible inventory**
 
-  Define Spectrum Scale nodes in the [Ansible inventory](https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html) (e.g. `./hosts`) in the following format:
+  Define Spectrum Scale nodes in the [Ansible inventory](https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html) (e.g. `hosts`) in the following format:
 
   ```yaml
   # hosts:
@@ -190,12 +208,14 @@ Installation Instructions
 
 - **Create Ansible playbook**
 
-  The basic [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks.html) (e.g. `./playbook.yml`) looks as follows:
+  The basic [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks.html) (e.g. `playbook.yml`) looks as follows:
 
   ```yaml
   # playbook.yml:
   ---
   - hosts: cluster01
+    collections:
+      - ibm.spectrum_scale
     vars:
       - scale_install_localpkg_path: /path/to/Spectrum_Scale_Standard-5.0.4.0-x86_64-Linux-install
     roles:

galaxy.yml

@@ -0,0 +1,67 @@
+### REQUIRED
+
+# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
+# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with
+# underscores or numbers and cannot contain consecutive underscores
+namespace: ibm
+
+# The name of the collection. Has the same character restrictions as 'namespace'
+name: spectrum_scale
+
+# The version of the collection. Must be compatible with semantic versioning
+version: 3.0.0
+
+# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
+readme: README.md
+
+# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
+# @nicks:irc/im.site#channel'
+authors:
+- Achim Christ <[email protected]>
+- Dherendra Singh <[email protected]>
+- Muthu Muthiah <[email protected]>
+- Ole Kristian Myklebust <[email protected]>
+- Rajan Mishra <[email protected]>
+
+
+
+### OPTIONAL but strongly recommended
+
+# A short summary description of the collection
+description: Ansible Collections for IBM Spectrum Scale
+
+# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
+# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
+license:
+- Apache-2.0
+
+# The path to the license file for the collection. This path is relative to the root of the collection. This key is
+# mutually exclusive with 'license'
+#license_file: LICENSE
+
+# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
+# requirements as 'namespace' and 'name'
+tags:
+- storage
+- ibm
+- spectrum
+- scale
+- gpfs
+
+# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
+# collection label 'namespace.name'. The value is a version range
+# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
+# range specifiers can be set and are separated by ','
+dependencies: {}
+
+# The URL of the originating SCM repository
+repository: https://github.com/IBM/ibm-spectrum-scale-install-infra
+
+# The URL to any online docs
+documentation: https://github.com/IBM/ibm-spectrum-scale-install-infra
+
+# The URL to the homepage of the collection/project
+homepage:
+
+# The URL to the collection issue tracker
+issues: https://github.com/IBM/ibm-spectrum-scale-install-infra/issues

plugins/README.md

@@ -0,0 +1,31 @@
+# Collections Plugins Directory
+
+This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that
+is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that
+would contain module utils and modules respectively.
+
+Here is an example directory of the majority of plugins currently supported by Ansible:
+
+```
+└── plugins
+    ├── action
+    ├── become
+    ├── cache
+    ├── callback
+    ├── cliconf
+    ├── connection
+    ├── filter
+    ├── httpapi
+    ├── inventory
+    ├── lookup
+    ├── module_utils
+    ├── modules
+    ├── netconf
+    ├── shell
+    ├── strategy
+    ├── terminal
+    ├── test
+    └── vars
+```
+
+A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible/2.9/plugins/plugins.html).