Merge branch 'main' into add_cf_to_auto_alarm

Author: kcantrel

.github/CODEOWNERS

@@ -0,0 +1,20 @@
+#
+# Set a "catch-all" owner. Should be set to the current active admin for the repo.
+* @kcantrel
+#
+# Set the owner for all the individual samples, if the owner is known and they want to continue to maintain the sample:
+/AI/GenAI-ChatBot-application-sample/ @cbenbass
+/CloudFormation/deploy-fsx-ontap/ @kcantrel
+/EKS/FSxN-as-PVC-for-EKS/ @mickeysh
+/Management-Utilities/auto_create_sm_relationships/ @kcantrel
+/Management-Utilities/auto_set_fsxn_auto_grow/ @kcantrel
+/Management-Utilities/fsx-ontap-aws-cli-scripts/ @kcantrel
+/Management-Utilities/fsxn-rotate-secret/ @kcantrel
+/Management-Utilities/warm_performance_tier/ @kcantrel
+/Monitoring/CloudWatch-FSx/ @LirazRom10
+/Monitoring/LUN-monitoring/ @LirazRom10
+/Monitoring/auto-add-cw-alarms/ @kcantrel
+/Monitoring/monitor-ontap-services/ @kcantrel
+/Terraform/deploy-fsx-ontap-sqlserver/ @varunrai
+/Terraform/deploy-fsx-ontap-fileshare-access/ @varunrai
+/Terraform/deploy-fsx-ontap/ @kcantrel

Management-Utilities/fsx-ontap-aws-cli-scripts/README.md

@@ -14,18 +14,18 @@ Before running the UNIX based scripts, make sure the following package is instal
 
 | Script                  | Description     |
 |:------------------------|:----------------|
-|create_fsxn_filesystem   | Creates a new FSx for NetApp ONTAP file-system |
-|create_fsxn_svm          | Creates a new Storage Virtual Server (svm) in a soecific FSx ONTAP filesystem |
+|create_fsxn_filesystem   | Creates a new FSx for NetApp ONTAP file system. |
+|create_fsxn_svm          | Creates a new Storage Virtual Server (SVM) in a specified FSx for ONTAP file system. |
 |create_fsxn_volume       | Creates a new volume under a specified SVM. |
-|list_fsx_filesystems     | List all the FSx for NetApp ONTAP filesystems that the user has access to. |
-|list_fsx_filesystems.ps1 | List all the FSx for NetApp ONTAP filesystems that the user has access to, written in PowerShell. |
+|list_fsx_filesystems     | List all the FSx for NetApp ONTAP file systems that the user has access to. |
+|list_fsx_filesystems.ps1 | List all the FSx for NetApp ONTAP file systems that the user has access to, written in PowerShell. |
 |list_fsxn_volumes        | List all the FSx for NetApp ONTAP volumes that the user has access to. |
 |list_fsxn_svms           | List all the storage virtual machines that the user access to. |
-|list_aws_subnets         | List all the aws subnets. |
-|list_aws_vpcs            | List all the aws vpcs. |
-|delete_fsxn_filesystem   | Deletes an FSx for NetApp ONTAP filesystem. |
-|delete_fsxn_svm          | Deletes an svm. |
-|delete_fsxn_volume       | Deletes a volume. |
+|list_aws_subnets         | List all the AWS subnets. |
+|list_aws_vpcs            | List all the AWS VPCs. |
+|delete_fsxn_filesystem   | Deletes a specified FSx for ONTAP file system. Including all the SVMs and volumes on it. |
+|delete_fsxn_svm          | Deletes a specified SVM. Including all the volumes assigned to it. |
+|delete_fsxn_volume       | Deletes a specified volume. |
 
 
 ## Author Information

Management-Utilities/fsx-ontap-aws-cli-scripts/create_fsxn_filesystem

@@ -20,17 +20,19 @@
 ################################################################################
 usage () {
 cat 1>&2 <<EOF
-Usage: $(basename $0) -name fileSystemName -subnetID1 subnetID1 -subnetID2 subnetID2 [-region region] [-type availability] [-size size] [-security-group-id securityGroupID] [-throughput throughput] [-endpointIPrange CIDR]
+Usage: $(basename $0) -name fileSystemName -subnetID1 subnetID1 -subnetID2 subnetID2 [-region region] [-type availability] [-size size] [-security-group-id securityGroupID] [-throughput throughput] [-numberPairs numberPairs] [-endpointIPrange CIDR] [-wait]
 where
   fileSystemName: Is the name you want to assign the file system.
   subnetID1: Is the subnet ID of the preferred subnet you want the file system to be accessible from.
   subnetID2: Is the subnet ID of the standby subnet you want the file system to be accessible from. Only allowed for multi availability zone deployments.
   security-group-id: Is the security ID that you want applied to the ENIs that are assigned to the file system.
   region: Is the AWS region where the FSxN file system will reside.
-  availability: Specifies whether the HA pair should be spread across 'single' or 'multiple' availability zones. Valid settings are 'Single' or 'Multi' (default).
-  size: Is size, in gigabytes, you want the file system to be. Minimum and the default is 1024.
-  throughput: Is the throughput capacity you the file system to have. Valid numbers are 128, 256, 512, 1024, 2048, and 4096. Default is 128.
+  availability: Specifies whether the HA pair should be spread across 'single' or 'multiple' availability zones. Valid settings are 'single' or 'multi' (default).
+  size: Is size, in gigabytes, you want the file system to be. Minimum is 1024 per number of HA pairs. Default is 1024.
+  throughput: Is the throughput capacity you the file system to have. Valid Gen1 numbers are 128, 256, 512, 1024, 2048, and 4096. Valid Gen2 numbers are 384, 768, 1536, 3072, and 6144. Default is 128.
+  numberPairs: Is the number of HA pairs you want the file system to have. Can only be greater than 1 with throupghput numbers of 1536, 3072, and 6144. Default is 1.
   CIDR: Is an address range that the system management, and data access, IPs will be allocated from. It is only allowed for multi availability zone deployments.
+  -wait: Forces the script to wait until the file system is created before returning.
 EOF
   exit 1
 }
@@ -40,21 +42,56 @@ EOF
 ################################################################################
 tmpout=/tmp/fsx_fs_create.$$
 trap 'rm -f $tmpout' exit
+#
+# Set the maximum number of times to check that the file system was created.
+# Multiple it by the SleepTime set below to the total amount of time allowed.
+MaxIterations=180
+#
+# Set the number of seconds to wait between checks that the file system
+# has been created.
+SleepTime=15
+#
+# Possible throughput values
+throughputValuesGen1=(128 256 512 1024 2048 4096)
+throughputValuesGen2=(384 768 1536 3072 6144)
+throughputValuesMultiHAPairs=(1536 3072 6144)
 
-if which jq aws > /dev/null 2>&1; then
-  :
-else
-  echo "Error, both the 'aws' and 'jq' commands are required to run this script." 1>&2
-  exit 1
-fi
+integerRegex='^[0-9]+$'
+
+################################################################################
+# This function is used to see if the first value passed is in one of the
+# other parameters passed.
+################################################################################
+is_in(){
+
+  local value=$1
+  shift
+  for i in "$@"; do
+    if [ $i == $value ]; then
+      return 0
+    fi
+  done
+  return 1
+}
+
+for cmd in jq aws; do
+  if which $cmd > /dev/null 2>&1; then
+    :
+  else
+    echo "Error, the '$cmd' is required to run this script." 1>&2
+    exit 1
+  fi
+done
 #
 # Set some defaults.
 size=1024
 throughput=128
 region=$(aws configure list | egrep '^.*egion ' | awk '{print $2}')
 securityGroupOption=""
 endpointips=""
-azType="MULTI_AZ_1"
+availType=multi
+numPairs=1
+waitForCompletion=false
 #
 # Process command line arguments.
 while [ ! -z "$1" ]; do
@@ -66,13 +103,10 @@ while [ ! -z "$1" ]; do
       shift
       ;;
     -size|--size) size="$2"
-      if ! [[ "$size" =~ '^[0-9]+$' ]]; then
+      if ! [[ "$size" =~ $integerRegEx ]]; then
           echo "-size must be an integer."
           usage
       fi
-      if [ "$size" -le 1024 ]; then
-        usage
-      fi
       shift
       ;;
     -subnetid1|--subnetid1) subnetID1="$2"
@@ -85,31 +119,34 @@ while [ ! -z "$1" ]; do
       shift
       ;;
     -type|--type)
-      if [ "$(echo $2 | tr [A-Z] [a-z])" == "single" ]; then
-        azType="SINGLE_AZ_1"
-      elif [ "$(echo $2 | tr [A-Z] [a-z])" == "multi" ]; then
-        azType="MULTI_AZ_1"
-      else
-        echo "Error, known availability type '$2'."
+      availType=$2
+      if [ $availType != "single" -a $availType != "multi" ]; then
+        echo "-type must be 'single' or 'multi'." 1>&2
         usage
       fi
       shift
       ;;
     -throughput|--throughput) throughput="$2"
-      if ! [[ "$throughput" =~ '^[0-9]+$' ]]; then
+      if ! [[ "$throughput" =~ $integerRegEx ]]; then
           echo "-throughput must be an integer."
           usage
       fi
-      if [ "$througput" != "128" -a "$througput" != "256" -a "$throughput" != "512" -a "$throughput" != "1024" -a "$throughput" != "2048" -a "$throughput" != "4096" ]; then
-          echo "-throughput must be 128 or 256 or 512 or 1024 or 2048 or 4096."
-          usage
-      fi
       shift
       ;;
     -endpointiprange|--endpointiprange)
       endpointips='"EndpointIpAddressRange": "'$2'",'
       shift
       ;;
+    -numberpairs|--numberpairs) numPairs="$2"
+      if ! [[ "$numPairs" =~ $integerRegEx ]]; then
+          echo "-numPairs must be an integer."
+          usage
+      fi
+      shift
+      ;;
+    -wait|--wait)
+      waitForCompletion=true
+      ;;
     -h|-help|--help)
       usage
       ;;
@@ -119,16 +156,44 @@ while [ ! -z "$1" ]; do
   esac
   shift
 done
+
+if is_in "$throughput" "${throughputValuesGen1[@]}"; then
+  if [ $availType == "single" ]; then
+    azType="SINGLE_AZ_1"
+  elif [ $availType == "multi" ]; then
+    azType="MULTI_AZ_1"
+  else
+    echo "Error, unknown availability type '$availType'."
+    usage
+  fi
+elif is_in "$throughput" "${throughputValuesGen2[@]}"; then
+  if [ $availType == "single" ]; then
+    azType="SINGLE_AZ_2"
+  elif [ $availType == "multi" ]; then
+    azType="MULTI_AZ_2"
+  else
+    echo "Error, unknown availability type '$availType'."
+    usage
+  fi
+else
+  echo "Error, unsupported throughput value '$throughput'."
+  usage
+fi
 #
 # Ensure all the required parameters have been provided.
-if [ -z "$fileSystemName" -o -z "$subnetID1" -o "$azType" == "MULTI_AZ_1" -a -z "$subnetID2" ]; then
-  echo "Missing arguments." 1>&2
+if [ -z "$fileSystemName" ]; then
+  echo "Error, you must specify a file system name." 1>&2
+  usage
+fi
+
+if [ -z "$subnetID1" -o "$azType" == "MULTI_AZ_1" -a -z "$subnetID2" -o "$azType" == "MULTI_AZ_2" -a -z "$subnetID2" ]; then
+  echo "Error, you must specify only subnetID1 for a single availability zone deployments or both subnetID1 and subnetID2 for a multi availability zone deployments." 1>&2
   usage
-  exit 1
 fi
-if [ $azType == "SINGLE_AZ_1" ]; then
+
+if [[ $azType == *"SINGLE_AZ"* ]]; then
   if [ ! -z "$endpointips" ]; then
-    echo "Error, you can not specify Endpoint IP address range when deploying in a single availability zone." 1>&2
+    echo "Error, you cannot specify Endpoint IP address range when deploying in a single availability zone." 1>&2
     exit 1
   fi
 
@@ -138,24 +203,82 @@ if [ $azType == "SINGLE_AZ_1" ]; then
   fi
 fi
 
-aws fsx create-file-system --output=json --file-system-type ONTAP --storage-capacity $size --subnet-ids $subnetID1 $subnetID2 --storage-type SSD --tags "Key=Name,Value=$fileSystemName" $securityGroupOption --ontap-configuration '{
+if [ $numPairs -gt 1 ]; then
+  if ! is_in "$throughput" "${throughputValuesMultiHAPairs[@]}"; then
+    echo "Error, you can only specify more than one HA pair with throughput values of 1536, 3072, and 6144." 1>&2
+    usage
+  fi
+
+  if [ $azType != "SINGLE_AZ_2" ]; then
+    echo "Error, you can only specify more than one HA pair with a single availability zone deployment." 1>&2
+    usage
+  fi
+fi
+
+minSize=$((1024*numPairs))
+if [ $size -lt $minSize ]; then
+  echo "Error, the size must be at least $minSize for $numPairs HA pairs. In other words 1024 per HA pair." 1>&2
+  usage
+fi
+
+echo aws fsx create-file-system --output=json --file-system-type ONTAP --storage-capacity $size --subnet-ids $subnetID1 $subnetID2 --storage-type SSD --tags "Key=Name,Value=$fileSystemName" $securityGroupOption --ontap-configuration '{
   "PreferredSubnetId": "'$subnetID1'",
   '$endpointips'
   "DeploymentType": "'$azType'",
-  "ThroughputCapacity": '$throughput'}' --region=$region > $tmpout 2>&1
-
+  "HAPairs": '$numPairs',
+  "ThroughputCapacityPerHAPair": '$throughput'}' --region=$region 
+#  "ThroughputCapacityPerHAPair": '$throughput'}' --region=$region > $tmpout 2>&1
+exit
 if [ $? != "0" ]; then
   echo "Failed to create FSxN file system." 1>&2
   cat $tmpout 1>&2
   exit 1
 else
   status=$(jq -r .FileSystem.Lifecycle $tmpout 2> /dev/null)
   if [ "$status" == "CREATING" -o "$status" == "PENDING" ]; then
-    echo "File system '$fileSystemName' ($(jq -r .FileSystem.FileSystemId $tmpout)) is being created."
-    exit 0
+    fsid=$(jq -r .FileSystem.FileSystemId $tmpout)
+    printf "File system '$fileSystemName' ($fsid) is being created."
+    if [ $waitForCompletion == "true" ]; then
+      i=0
+      while [ $i -lt $MaxIterations ]; do
+        aws fsx describe-file-systems --file-system-ids $fsid --output=json --region=$region > $tmpout 2>&1
+        if [ $? -eq 0 ]; then
+          status=$(jq -r '.FileSystems[0].Lifecycle' $tmpout 2> /dev/null)
+          if [ "$status" == "AVAILABLE" ]; then
+            printf "\nFile system '$fileSystemName' ($fsid) has been created.\n"
+            break
+          fi
+          if [ "$status" != "CREATING" -a "$status" != "PENDING" ]; then
+            printf "\nError, failed to create the file system. Status = $status\n" 1>&2
+            reason="$(jq -r '.FileSystems[0].LifecycleTransitionReason.Message' $tmpout 2> /dev/null)"
+            if [ ! -z "$reason" ]; then
+              echo "Reason: $reason" 1>&2
+            else
+              cat $tmpout 1>&2
+            fi
+            exit 1
+          fi
+          printf "."
+        else
+          printf "\nError, failed to get the file system status.\n" 1>&2
+          cat $tmpout 1>&2
+          exit 1
+        fi
+        sleep $SleepTime
+        let i+=1
+      done
+      if [ $i -ge $MaxIterations ]; then
+        printf "\nFailed to create file system('$fsid'). Taking too long.\n" 1>&2
+        exit 1
+      fi
+      exit 0
+    else
+      echo
+    fi
   else
     echo "Unknown status '$status'. Complete output returned from the AWS api:" 1>&2
     cat $tmpout 1>&2
     exit 1
   fi
 fi
+exit 0