Skip to content

Commit b499373

Browse files
authored
Update README.md
1 parent d84a0d9 commit b499373

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

Terraform/fsxn-replicate/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This repository contains a method to take an existing FSxN system and replicate
55

66
## Setup
77

8-
You will need to define some key characteristics of your destination FSxN cluster to be created, such as deployment type and througput, full list below. You also will need to define the source SVM and list of volumes to replicate, and replication parameters.
8+
You will need to define some key characteristics of the destination FSxN cluster that will be created, such as deployment type and througput, full list below. You also will need to define the source SVM and list of volumes to replicate, and replication parameters.
99

1010
These values can be found in the following variables files: Primary_FSxN_variables.tf and DR_FSxN_variables.tf
1111

@@ -14,7 +14,7 @@ You have an existing FSx ONTAP system that you want to replicate to a new FSxN s
1414

1515
SnapMirror replication requires **ICMP** and ports **11104** and **11105**.
1616

17-
## Primary Inputs
17+
## Inputs (Primary Cluster)
1818

1919
| Name | Description | Type | Default | Required |
2020
| --------------------- | ------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------ | :------: |
@@ -25,11 +25,28 @@ SnapMirror replication requires **ICMP** and ports **11104** and **11105**.
2525
| prime_cluster_vserver | Name of the ONTAP cluster vserver for intercluster LIFs in the primary cluster. Can be found by running `network interface show` on the primary cluster. It will have the format FsxId################# | `string` | Yes |
2626
| prime_aws_region | AWS region of the primary FSx ONTAP system | `string` | | Yes |
2727
| username_pass_secrets_id | Name of the secrets ID in AWS secrets. The AWS Secret should has format of a key `username` which should be fsxadmin and a key `password` and the password of the FSxN | `string` | | Yes |
28-
| validate_certs | Do we validate the cluster certs (true or false) | `string` | false | No |
28+
| validate_certs | When connecting to ONTAP do we validate the cluster certs (true or false). | `string` | false | No |
2929
| list_of_volumes_to_replicate | List of volume names to replicate to the destination FSx ONTAP system | `list(string)` | | Yes |
30+
## Inputs (DR Cluster)
3031

31-
32-
32+
| Name | Description | Type | Default | Required |
33+
| --------------------- | ------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------ | :------: |
34+
| dr_aws_region | AWS regionfor the Secondary(DR) ONTAP system. | `string` | | Yes |
35+
| dr_fsx_name | The name to assign to the destination FSxN file system that will be created. | `string` | | Yes |
36+
| dr_clus_name | This is the name of the cluster given for ONTAP TF connection profile. This is a user created value, that can be any string. It is referenced in many ONTAP TF resources | `string` | Yes |
37+
| dr_fsx_deploy_type | The file system deployment type. Supported values are 'MULTI_AZ_1', 'SINGLE_AZ_1', 'MULTI_AZ_2', and 'SINGLE_AZ_2'. MULTI_AZ_1 and SINGLE_AZ_1 are Gen 1. MULTI_AZ_2 and SINGLE_AZ_2 are Gen 2. | SINGLE_AZ_1 | Yes |
38+
| dr_fsx_subnets | The primary subnet ID, and secondary subnet ID if you are deploying in a Multi AZ environment, file system will be accessible from. For MULTI_AZ deployment types both subnets are required. For SINGLE_AZ deployment type, only the primary subnet is used. `map(any)` | | Yes |
39+
| dr_fsx_capacity_size_gb | The storage capacity in GiBs of the FSxN file system. Valid values between 1024 (1 TiB) and 1048576 (1 PiB). Gen 1 deployment types are limited to 192 TiB. Gen 2 Multi AZ is limited to 512 TiB. Gen 2 Single AZ is limited to 1 PiB. The sizing should take into account the size of the volumes you plan to replicate and the tiering policy of the volumes. | `number` | 1024 | Yes |
40+
| dr_fsx_tput_in_MBps | The throughput capacity (in MBps) for the file system. Valid values are 128, 256, 512, 1024, 2048, and 4096 for Gen 1, and 384, 768, 1536, 3072 and 6144 for Gen 2. | `string` | 128 | Yes |
41+
| dr_ha_pairs | The number of HA pairs in the file system. Valid values are from 1 through 12. Only single AZ Gen 2 deployment type supports more than 1 HA pair. | `number` | 1 | Yes |
42+
| dr_endpoint_ip_address_range | The IP address range that the FSxN file system will be accessible from. This is only used for Multi AZ deployment types and must be left a null for Single AZ deployment types. | `string` | null | No |
43+
| dr_route_table_ids | An array of routing table IDs that will be modified to allow access to the FSxN file system. This is only used for Multi AZ deployment types and must be left as null for Single AZ deployment types. | `list(string)` | [] | Only required for Multi-AZ |
44+
| dr_disk_iops_configuration | The SSD IOPS configuration for the file system. Valid modes are 'AUTOMATIC' (3 iops per GB provisioned) or 'USER_PROVISIONED'. NOTE: Due to a bug in the AWS FSx provider, if you want AUTOMATIC, then leave this variable empty. If you want USER_PROVISIONED, then add a 'mode=USER_PROVISIONED' (with USER_PROVISIONED enclosed in double quotes) and 'iops=number' where number is between 1 and 160000. | `map(any)` | {} | No |
45+
| dr_tags | Tags to be applied to the FSxN file system. The format is '{Name1 = value, Name2 = value}' where value should be enclosed in double quotes. | `map(any)` | {} | No |
46+
| dr_maintenance_start_time | The preferred start time to perform weekly maintenance, in UTC time zone. The format is 'D:HH:MM' format. D is the day of the week, where 1=Monday and 7=Sunday. | `string` | 7:00:00 | No |
47+
| dr_svm_name | The name of the Storage Virtual Machine that will house the replicated volumes. | `string` | | Yes |
48+
| dr_root_vol_sec_style | Specifies the root volume security style, Valid values are UNIX, NTFS, and MIXED (although MIXED is not recommended). All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. | `string` | UNIX | Yes |
49+
| dr_username_pass_secrets_id | Name of the secrets ID in AWS secrets. The AWS Secret should has format of a key `username` where the value should be fsxadmin and a key `password` with the value being the password to be assigned to the destination FSxN filesystem. | `string` | | Yes |
3350

3451

3552

0 commit comments

Comments
 (0)