Skip to content

Commit b75d8dd

Browse files
varunraivarunrai
committed
doc update
1 parent 12f56a8 commit b75d8dd

File tree

1 file changed

+20
-19
lines changed
  • Terraform/deploy-fsx-ontap-fileshare-access

1 file changed

+20
-19
lines changed

‎Terraform/deploy-fsx-ontap-fileshare-access/README.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ This repository contains the deployment for Amazon FSx for NetApp ONTAP, Microso
2525
2626
#### Terraform Files
2727

28-
| File | File Path | Description |
29-
| ------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30-
| main.tf | deploy-fsx-ontap-sqlserver/main.tf | This is the primary terraform file that contains provider information and module configuration for SQL Server EC2 and Amazon FSx for NetApp ONTAP |
31-
| networking.tf | deploy-fsx-ontap-sqlserver/networking.tf | Creates the networking components - VPC, Public and Private Subnets, Internet Gateway, NAT Gateway, Route Table (private and public), Security Groups (default, EC2 to FSxN and others) |
32-
| ssm.tf | deploy-fsx-ontap-sqlserver/ssm.tf | Creates an SSM parameter to store the password for the file system |
33-
| variables.tf | deploy-fsx-ontap-sqlserver/variables.tf | Defines all the variables (and default values) used in main.tf, networking.tf, ssm.tf |
28+
| File | File Path | Description |
29+
| ------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30+
| main.tf | deploy-fsx-ontap-fileshare-access/main.tf | This is the primary terraform file that contains provider information and module configuration for Microsoft AD EC2 and Amazon FSx for NetApp ONTAP |
31+
| networking.tf | deploy-fsx-ontap-fileshare-access/networking.tf | Creates the networking components - VPC, Public and Private Subnets, Internet Gateway, NAT Gateway, Route Table (private and public), Security Groups (default, EC2 to FSxN and others) |
32+
| ssm.tf | deploy-fsx-ontap-fileshare-access/ssm.tf | Creates an SSM parameter to store the password for the file system |
33+
| variables.tf | deploy-fsx-ontap-fileshare-access/variables.tf | Defines all the variables (and default values) used in main.tf, networking.tf, ssm.tf |
3434

3535
#### Terraform Modules
3636

3737
| Module | File | File Path | Description |
3838
| ------ | ----------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
3939
| ec2ad | ec2-ami.tf | deploy-fsx-ontap-fileshare-access/modules/ec2/ec2-ami.tf | The file contains the AMI used for deploying the Microsoft AD |
40-
| ec2ad | ec2-ad.tf | deploy-fsx-ontap-fileshare-access/modules/ec2/ec2-sql.tf | The file defines the EC2 and script to configure the Microsoft AD |
40+
| ec2ad | ec2-ad.tf | deploy-fsx-ontap-fileshare-access/modules/ec2/ec2-ad.tf | The file defines the EC2 and script to configure the Microsoft AD |
4141
| ec2ad | variables.tf | deploy-fsx-ontap-fileshare-access/modules/ec2/variables.tf | Defines all the variables (and default values) used in main.tf and ec2-ad.tf |
4242
| ec2ad | outputs.tf | deploy-fsx-ontap-fileshare-access/modules/ec2/outputs.tf | Defines the output variables for Microsoft AD Server |
4343
| fsxn | fsx-fs.tf | deploy-fsx-ontap-fileshare-access/modules/fsxn/fsx-fs.tf | Defines the Amazon FSx for NetApp ONTAP file system and it's properties (SSD, Throughput, Deployment Mode etc.) |
@@ -64,7 +64,7 @@ This repository contains the deployment for Amazon FSx for NetApp ONTAP, Microso
6464
| environment | Name of the environment (demo, test, qa etc.) | `string` | `Demo` | No |
6565
| aws_location | AWS region | `string` | `ap-southeast-1` | Yes |
6666
| availability_zones | Availability Zones corresponding to the regions | `list(string)` | `"ap-southeast-1", "ap-southeast-2"` | Yes |
67-
| ec2_instance_type | SQL Server EC2 instance type | `string` | `t3.2xlarge` | Yes |
67+
| ec2_instance_type | AD EC2 instance type | `string` | `t3.2xlarge` | Yes |
6868
| ec2_instance_keypair | EC2 Key Pair to be assigned for the deployed EC2 instance | `string` | | Yes |
6969
| ec2_iam_role | IAM Role assigned to the EC2 (see section)[#create-an-iam-role-and-attach-the-policy-amazonssmreadonlyaccess] | `string` | | Yes |
7070
| fsxn_password | Password for the fsxadmin user assigned to the filesystem | `string` | | Yes |
@@ -75,15 +75,16 @@ This repository contains the deployment for Amazon FSx for NetApp ONTAP, Microso
7575

7676
### Outputs
7777

78-
| Name | Description |
79-
| ------------------------ | ------------------------------------ |
80-
| FSxN_management_ip | FSxN File System Management Endpoint |
81-
| FSxN_svm_iscsi_endpoints | FSxN SVM iSCSI IP addresses |
82-
| FSxN_sql_server_ip | SQL Server EC2 IP addresses |
83-
| FSxN_file_system_id | FSxN File System Id |
84-
| FSxN_svm_id | FSxN Storage Virtual Machine Id |
85-
| FSxN_sql_data_volume | FSxN SQL Data Volume Id and Name |
86-
| FSxN_sql_log_volume | FSxN SQL Log Volume Id and Name |
78+
| Name | Description |
79+
| ----------------------------- | -------------------------------------- |
80+
| FSxN_Management_IP | FSxN File System Management Endpoint |
81+
| MicrosoftAD_Server_Private_IP | Microsoft AD Private IP |
82+
| FSxN_File_System_ID | FSxN File System ID |
83+
| FSxN_SVM_ID | FSxN Storage Virtual Machine ID |
84+
| FSxN_SVM_SMB_Endpoint | FSxN SMB Endpoint Details (DNS and IP) |
85+
| FSxN_SVM_NFS_Endpoint | FSxN NFS Endpoint Details (DNS and IP) |
86+
| FSxN_Volume_1 | FSxN Volume 1 details |
87+
| FSxN_Volume_2 | FSxN Volume 2 details |
8788

8889
### What to expect
8990

@@ -210,8 +211,8 @@ To list configuration data, use the [`aws configire list`](https://docs.aws.amaz
210211
- Click the "Create role" button.
211212

212213
> [!NOTE]
213-
> The role is required to fetch the password for fsxadmin from SSM Secured Parameters. Terraform creates an SSM Paramter which is retrieved via the powershell script of EC2 instance. The role allows the retrieval of the parameter and execute the necessary operations on the filesystem.
214-
> Alternatively, the password can also be entered in the `user_data` section under `$ssmPass` variable found in the ec2-sql.tf file (not recommended).
214+
> The role is required to fetch the password for fsxadmin and AD Admin Password from SSM Secured Parameters. Terraform creates an SSM Paramter which is retrieved via the powershell script of EC2 instance. The role allows the retrieval of the parameter and execute the necessary operations on the filesystem.
215+
> Alternatively, the password can also be entered in the `user_data` section under `$ssmPass` variable found in the ec2-ad.tf file (not recommended).
215216

216217
#### Generate VPN Certificates
217218

0 commit comments

Comments
 (0)