Initial Version

Author: kcantrel

Infrastructure_as_Code/Ansible/Volume_Management/README.md

@@ -1,8 +1,8 @@
 # Ansible Volume Management samples
-This folder contains to Ansible playbooks that can be used to manage volumes within a FSx for ONTAP file system.
+This folder contains Ansible playbooks that can be used to manage volumes within a FSx for ONTAP file system.
 
 They have been configured to use the new `use_lambda` feature that allows it to leverage an Workload Factory Link
-to issue the API calls to the FSx for ONTAP file system which alleviate the requirement of the Ansible control
+to issue the API calls to the FSx for ONTAP file system which alleviates the requirement of the Ansible control
 node to have network connectivity to the FSx for ONTAP file system. For more information on how to set up a
 Workload Factory Link, please refer to the [NetApp Workload Factory documentation](https://docs.netapp.com/us-en/workload-fsx-ontap/links-overview.html).
 
@@ -22,23 +22,25 @@ The list of playbooks included in this folder is as follows:
 Each playbook requires various variables to be set in order to run.
 | Variable | Used By Playbook | Required | Default | Description |
 |:-------- |:----------------:|:--------:|:-------:|:-----------|
-| volume\_name| All | Yes | None | The name of the volume you want to act one.|
-| volume\_size| create\_volume | Yes | None | The size, in MiBs, of the volume to create.|
+| fsxn\_hostname| All | Yes | None | The hostname, or IP address, of the FSxN where the volume resides.|
 | vserver    | All | Yes | None | The name of the vserver where the volume resides.|
-| fsxn\_hostname| All | Yes | None | The hostname or IP address of the FSxN where the volume resides.|
-| lambda\_function\_name| All | No | None | The name of the Workload Factory Link to use when issuing API calls to the FSx for ONTAP file system.| 
-| aws\_region | All | No | None | The AWS region where the Link lambda function resides.|
-| secret\_name | Yes | All | None | The name of the AWS secret that contains the credentials to authenticate with the FSx for ONTAP file system.|
-| snapshot\_name | create\_snapshot | Yes | None | The name of the snapshot to create.|
+| secret\_name | All | Yes | None | The name of the AWS secret that contains the credentials to authenticate with the FSx for ONTAP file system.|
+| volume\_name| All | Yes | None | The name of the volume you want to act on.|
+| lambda\_function\_name| All | No | None | The name of the Workload Factory Link Lambda function to use when issuing API calls to the FSx for ONTAP file system.| 
+| aws\_region | All | No | None | The AWS region where the Lambda function resides.|
+| volume\_size| create\_volume | Yes | None | The size, in MiBs, of the volume to create.|
 | security\_style | create\_volume | No | UNIX | The security style to use when creating the volume. Valid options are UNIX or NTFS.|
 | aggr | create\_volume | No | aggr1 | The name of the aggregate to create the volume on.|
 | volume\_type | create\_volume | No | RW | The type of volume to create. Valid options are RW and DP.|
 | junction\_path | create\_volume | No | `/<volume_name>` | The junction path to use when creating the volume.|
+| snapshot\_name | create\_snapshot | Yes | None | The name of the snapshot to create.|
 
-A convenient way to set all the required variable is to put them into a file named `varabless.yaml`.
+A convenient way to set all the required variable is to put them into a file named `variables.yaml`.
 All the playbooks will attempt to load this file and use any variables defined in it. Otherwise,
-you can set them by using the `--extra-vars` flag when running the playbook.
+you can set them by using the `--extra-vars` flag when running the playbook. An example `variables.yaml`
+file is included in this folder.
 
+## Authentication
 So that you don't have to hardcode secrets into the playbook, or variable files, all the playbooks
 will leverage an AWS Secrets Manager secret to retrieve the credentials for FSx for ONTAP file system.
 
@@ -51,6 +53,66 @@ Each secret should have two `keys`:
 Since this script leverages the AWS Ansible collection you will need to provide authentication credentials for it.
 You can read more about how to do that [here](https://docs.ansible.com/ansible/latest/collections/amazon/aws/docsite/aws_ec2_guide.html#authentication).
 
+## Example Run:
+Here is an example of running the `create_volume.yaml` playbook to create a new
+volume named `vol1` with a size of 1024 MiBs on the `fsx` vserver:
+```bash
+$ ansible-playbook create_volume.yaml --extra-vars "volume_name=vol1 volume_size=1024 vserver=fsx"
+[WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not match 'all'
+
+PLAY [Playbook to create a volumes on an FSx for ONTAP file system.] *******************************************************
+
+TASK [Ensure required variables are set.] **********************************************************************************
+skipping: [localhost] => (item=volume_name)
+skipping: [localhost] => (item=volume_size)
+skipping: [localhost] => (item=vserver)
+skipping: [localhost] => (item=secret_name)
+skipping: [localhost]
+
+TASK [Set security_style to unix if not provide.] **************************************************************************
+ok: [localhost]
+
+TASK [Set aggr to 'aggr1' if not provided.] ********************************************************************************
+ok: [localhost]
+
+TASK [Set volume_type to "rw" if not provided.] ****************************************************************************
+ok: [localhost]
+
+TASK [Set use_lambda to true if lambda_function_name is provided.] *********************************************************
+ok: [localhost]
+
+TASK [Set aws_provide to "default" if not provided.] ***********************************************************************
+ok: [localhost]
+
+TASK [Set junction path to "/<volume_name>" if not provided.] **************************************************************
+ok: [localhost]
+
+TASK [Ensure that aws_region has been provided if use_lambda is true.] *****************************************************
+skipping: [localhost]
+
+TASK [Set aws_region to "" if not set at this point.] **********************************************************************
+skipping: [localhost]
+
+TASK [Set lambda_function_name to "" if not set at this point.] ************************************************************
+skipping: [localhost]
+
+TASK [Get username and password from AWS secret.] **************************************************************************
+ok: [localhost]
+
+TASK [Create the volume] ***************************************************************************************************
+changed: [localhost]
+
+PLAY RECAP *****************************************************************************************************************
+localhost                  : ok=8    changed=1    unreachable=0    failed=0    skipped=4    rescued=0    ignored=0
+```
+
+The above example had a `variables.yaml` file with the following contents:
+```yaml
+fsxn_hostname: "10.0.0.13"
+lambda_function_name: "lambda-8nlmlCR"
+aws_region: "us-west-2"
+secret_name: "fsxn/default"
+```
 ## Author Information
 
 This repository is maintained by the contributors listed on [GitHub](https://github.com/NetApp/FSx-ONTAP-samples-scripts/graphs/contributors).

Infrastructure_as_Code/Ansible/snapmirror_report/README.md

@@ -23,8 +23,8 @@ the number before it represents the number of seconds. For example, 'P1DT2H3M4S'
 - A file with a list of the FSx for ONTAP file systems and their corresponding secrets. The format of the file is described below.
 
 ## Installation
-There are three files used to create the report:
-- `generate_report.yaml`: The main Ansible playbook that generates the report.
+There are three components to this playbook:
+- `generate_report.yaml`: The main Ansible playbook that calls the other files.
 - `get_all_fsxn_regions.yaml`: A collection of tasks that retrieves all the regions, that are enabled for the account, where FSx for ONTAP is also available.
 - `processs_region.yaml`: A collection of tasks that will process all the FSxNs within a region.