Made formatting changes

kcantrel · kcantrel · commit 7b8299139898 · 2024-06-25T11:27:49.000-05:00
diff --git a/Solutions/FSxN-as-PVC-for-EKS/README-san.md b/Solutions/FSxN-as-PVC-for-EKS/README-san.md
@@ -1,225 +1,3 @@
-# FSx for NetApp ONTAP as persistent storage
-
-## Table of Contents
-* [Introduction](#introduction)
-* [Installation Oveerview](#Installation-Overview)
-* [Detailed Instructions](#Detailed-instructions)
-  * [Clone the "NetApp/FSx-ONTAP-samples-scripts" repo from GitHub](#Clone-the-NetAppFSx-ONTAP-samples-scripts-repo-from-GitHub)
-  * [Make any desired changes to the variables.tf file](#Make-any-desired-changes-to-the-variables.tf-file)
-  * [Initialize the Terraform environment](#Initialize-the-Terraform-environment)
-  * [Deploy the resources](#Deploy-the-resources)
-  * [SSH to the jump server to complete the setup](#SSH-to-the-jump-server-to-complete-the-setup)
-  * [Configure the 'aws' CLI](#Configure-the-'aws'-CLI)
-  * [Allow access to the EKS cluster for your user id](#Allow-access-to-the-EKS-cluster-for-your-user-id)
-  * [Configure kubectl to use the EKS cluster](#Configure-kubectl-to-use-the-EKS-cluster)
-  * [Confirm Astra Trident is up and running](#Confirm-Astra-Trident-is-up-and-running)
-  * [Configure the Trident CSI backend to use FSx for NetApp ONTAP](#Configure-the-Trident-CSI-backend-to-use-FSx-for-NetApp-ONTAP)
-  * [Create a Kubernetes storage class](#Create-a-Kubernetes-storage-class)
-* [Create a stateful application](#Create-a-stateful-application)
-  * [Create a Persistent Volume Claim](#Create-a-Persistent-Volume-Claim)
-  * [Deploy a MySQL database using the storage created above](#Deploy-a-MySQL-database-using-the-storage-created-above)
-  * [Populate the MySQL database with data](#Populate-the-MySQL-database-with-data)
-* [Create a snapshot of the MySQL data](#Create-a-snapshot-of-the-MySQL-data)
-  * [Install the Kubernetes Snapshot CRDs and Snapshot Controller](#Install-the-Kubernetes-Snapshot-CRDs-and-Snapshot-Controller)
-  * [Create a snapshot class based on the CRD instsalled](#Create-a-snapshot-class-based-on-the-CRD-installed)
-  * [Create a snapshot of the MySQL data](#Create-a-snapshot-of-the-MySQL-data)
-* [Clone the MySQL data to a new storage persistent volume](#Clone-the-MySQL-data-to-a-new-storage-persistent-volume)
-  * [Create a new MySQL database using the cloned volume](#Create-a-new-MySQL-database-using-the-cloned-volume)
-  * [To confirm that the new database is up and running, log into it and check the data](#To-confirm-that-the-new-database-is-up-and-running,-log-into-it-and-check-the-data)
-* [Final steps](#Final-steps)
-* [Author Information](#author-information)
-* [License](#license)
-
-## Introduction
-
-In this sample you'll find the instructions, and the code, necessary to deploy an AWS EKS
-cluster with an Amazon FSx for NetApp ONTAP File System (FSxN) to provide persistent storage
-for it. It will leverage NetApp's Astra Trident to provide the interface between EKS to FSxN.
-
-## Prerequisites
-
-A Unix based system with the following installed:
-- HashiCorp's Terraform
-- AWS CLI, authenticated with an account that has privileges necessary to:
-	- Deploy an EKS cluster
-	- Deploy an FSx for Netapp ONTAP File System
-	- Create security groups
-  - Create policies and roles
-  - Create secrets in AWS SecretsManager
-  - Create a VPC and subnets
-  - Create a NAT Gateway
-  - Create a Internet Gateway
-  - Create an EC2 instance
-
-## Installation Overview
-The overall process is as follows:
-- Ensure the prerequisites have been installed and configured.
-- Clone this repo from GitHub.
-- Make changes to the variables.tf file.
-- Run 'terraform init' to initialize the terraform environment.
-- Run 'terraform apply -auto-approve' to:
-  - Create a new VPC with public and private subnets.
-  - Deploy a FSx for NetApp ONTAP File System.
-  - Create a secret in AWS SecretsManager to hold the FSxN password.
-  - Deploy an EKS cluster.
-  - Deploy an EC2 Linux based instance.
-  - Create policies, roles and security groups to protect the new environment.
-- SSH to the Linux based instance to complete the setup:
-  - Install the FSx for NetApp ONTAP Trident CSI driver.
-  - Configure the Trident CSI driver.
-  - Create a Kubernetes storage class.
-- Deploy a sample application to test the storage with.
-
-## Detailed Instructions
-### Clone the "NetApp/FSx-ONTAP-samples-scripts" repo from GitHub
-Run the following commands to clone the repo and change into the directory where the
-terraform files are located:
-```bash
-git clone https://github.com/NetApp/FSx-ONTAP-samples-scripts.git
-cd FSx-ONTAP-samples-scripts/Solutions/FSxN-as-PVC-for-EKS/terraform
-```
-### Make any desired changes to the variables.tf file.
-Variables that can be changed include:
-- aws_region - The AWS region where you want to deploy the resources.
-- aws_secrets_region - The region where the fsx_password_secret will be created.
-- fsx_name - The name you want applied to the FSx for NetApp ONTAP File System. Must not already exist.
-- fsx_password_secret_name - A base name of the AWS SecretsManager secret that will hold the FSxN password.
-A random string will be appended to this name to ensure uniqueness.
-- fsx_throughput_capacity - The throughput capacity of the FSx for NetApp ONTAP File System.
-Read the "description" of the variable to see valid values.
-- fsx_storage_capacity - The storage capacity of the FSx for NetApp ONTAP File System.
-Read the "description" of the variable to see the valid range.
-- key_pair_name - The name of the EC2 key pair to use to access the jump server.
-**Note:** You must set this variable, otherwise the deployment will fail.
-- secure_ips - The IP address ranges to allow SSH access to the jump server. The default is wide open.
-
-### Initialize the Terraform environment
-Run the following command to initialize the terraform environment.
-```bash
-terraform init
-```
-
-### Deploy the resources
-Run the following command to deploy all the resources:
-```bash
-terraform apply --auto-approve
-```
-There will be a lot of output, and it will take 20 to 40 minutes to complete. Once done,
-the following is an example of last part of the output of a successful deployment:
-```bash
-Outputs:
-
-eks-cluster-name = "fsx-eks-DB0H69vL"
-eks-jump-server = "Instance ID: i-0e99a61431a39d327, Public IP: 54.244.16.198"
-fsx-id = "fs-0887a493cXXXXXXXX"
-fsx-management-ip = "198.19.255.174"
-fsx-password-secret-arn = "arn:aws:secretsmanager:us-west-2:759995400000:secret:fsx-eks-secret-3b8bde97-Fst5rj"
-fsx-password-secret-name = "fsx-eks-secret-3b8bde97"
-fsx-svm-name = "ekssvm"
-region = "us-west-2"
-vpc-id = "vpc-03ed6b1867d76e1a9"
-```
-You will use the values in the commands below, so probably a good idea to copy the output somewhere
-so you can easily reference it later.
-
-Note that an FSxN File System was created, with a vserver (a.k.a. SVM). The default username
-for the FSxN File System is 'fsxadmin'. And the default username for the vserver is 'vsadmin'. The
-password for both of these users is the same and is what is stored in the AWS SecretsManager secret
-shown above. Note that since Terraform was used to create the secret, the password is stored in
-plain text and therefore it is **HIGHLY** recommended that you change the password to something else
-by first changing the passwords via the AWS Management Console and then updating the password in
-the AWS SecretsManager secret. You can update the 'username' key in the secret if you want, but
-it must be a vserver admin user, not a system level user. This secret is used by Astra
-Trident and it will always login via the vserver management LIF and therefore it must be a
-vserver admin user. If you want to create a separate secret for the 'fsxadmin' user, feel free
-to do so.
-
-### SSH to the jump server to complete the setup
-Use the following command to 'ssh' to the jump server:
-```bash
-ssh -i <path_to_key_pair> ubuntu@<jump_server_public_ip>
-```
-Where:
-- <path_to_key_pair> is the file path to where you have stored the key_pair that you
-referenced in the variables.tf file.
-- <jump_server_public_ip> is the IP address of the jump server that was displayed
-in the output from the `terraform apply` command.
-
-### Configure the 'aws' CLI
-There are various ways to configure the AWS cli. If you are unsure how to do it, please
-refer to this the AWS documentation for instructions:
-[Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html)
-
-### Allow access to the EKS cluster for your user id
-AWS's EKS clusters have a secondary form for permissions. As such, you have to add an "access-entry"
-to your EKS configuration and associate it with the Cluster Admin policy to be able to view and
-configure the EKS cluster. The first step to do this is to find out your IAM ARN.
-You can do that via this command:
-```bash
-user_ARN=$(aws sts get-caller-identity --query Arn --output text)
-echo $user_ARN
-```
-Note that if you are using an SSO to authenticate with AWS, then the actual username
-you need to add is slightly different than what is output from the above command.
-The following command will take the output from the above command and format it correctly:
-
-**ONLY RUN THIS COMMAND IF YOU ARE USING AN SSO TO AUTHENTICATE WITH AWS**
-```bash
-user_ARN=$(aws sts get-caller-identity | jq -r '.Arn' | awk -F: '{split($6, parts, "/"); printf "arn:aws:iam::%s:role/aws-reserved/sso.amazonaws.com/%s\n", $5, parts[2]}')
-echo $user_ARN
-```
-The above command will leverage a standard AWS role that is created when configuring AWS to use an SSO.
-
-As you can see above, a variable named "user_ARN" was create to hold the your user's ARN. To make
-the next few commands easy, also create variables that hold the AWS region and EKS cluster name.
-```bash
-aws_region=<AWS_REGION>
-cluster_name=<EKS_CLUSTER_NAME>
-```
-Of course, replace <AWS_REGION> with the region where the resources were deployed. And replace
-<EKS_CLUSTER_NAME> with the name of your EKS cluster. Both of these values can be found
-from the output of the `terraform plan` command.
-
-Once you have your variables set, add the EKS access-entry by running these commands:
-```bash
-aws eks create-access-entry --cluster-name $cluster_name --principal-arn $user_ARN --region $aws_region
-aws eks associate-access-policy --cluster-name $cluster_name --principal-arn $user_ARN --region $aws_region --policy-arn arn:aws:eks::aws:cluster-access-policy/AmazonEKSClusterAdminPolicy --access-scope type=cluster
-```
-
-### Configure kubectl to use the EKS cluster
-AWS makes it easy to configure 'kubectl' to use the EKS cluster. You can do that by running this command:
-```bash
-aws eks update-kubeconfig --name $cluster_name --region $aws_region
-```
-Of course the above assumes the cluster_name and aws_region variables are still set from
-running the commands above.
-
-To confirm you can communicate with the EKS cluster run the following command:
-```bash
-kubectl get nodes
-```
-You should get output like this:
-```bash
-NAME                                       STATUS   ROLES    AGE   VERSION
-ip-10-0-1-84.us-west-2.compute.internal    Ready    <none>   76m   v1.29.3-eks-ae9a62a
-ip-10-0-2-117.us-west-2.compute.internal   Ready    <none>   76m   v1.29.3-eks-ae9a62a
-```
-
-### Confirm Astra Trident is up and running
-Astra Trident should have been added to your EKS Cluster as part of the terraform deployment.
-Confirm that it is up and running by running this command:
-```bash
-kubectl get pods -n trident
-```
-The output should look something like this:
-```bash
-NAME                                  READY   STATUS    RESTARTS   AGE
-trident-controller-569f47fc59-hx2vn   6/6     Running   0          20h
-trident-node-linux-pgcw9              2/2     Running   0          20h
-trident-node-linux-zr8n7              2/2     Running   0          20h
-trident-operator-67d6fd899b-jrnt2     1/1     Running   0          20h
-```
-
 ### Configure the Trident CSI backend to use FSx for NetApp ONTAP
 For the example below we are going to set up an iSCSI LUN for a MySQL
 database. To help facilitate that, we are going to set up Astra Trident as a backend provider.
@@ -548,19 +326,3 @@ At this point you don't need the jump server created to configure the EKS enviro
 the FSxN File System, so feel free to `terminate` it (i.e. destroy it).
 
 Other than that, you are welcome to deploy other applications that need persistent storage.
-
-## Author Information
-
-This repository is maintained by the contributors listed on [GitHub](https://github.com/NetApp/FSx-ONTAP-samples-scripts/graphs/contributors).
-
-## License
-
-Licensed under the Apache License, Version 2.0 (the "License").
-
-You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an _"AS IS"_ basis, without WARRANTIES or conditions of any kind, either express or implied.
-
-See the License for the specific language governing permissions and limitations under the License.
-
-© 2024 NetApp, Inc. All Rights Reserved.
diff --git a/Solutions/FSxN-as-PVC-for-EKS/README.md b/Solutions/FSxN-as-PVC-for-EKS/README.md
@@ -228,7 +228,7 @@ Astra Trident has several different drivers to choose from. You can read more ab
 drivers it supports in the
 [Astra Trident documentation.](https://docs.netapp.com/us-en/trident/trident-use/trident-fsx.html#fsx-for-ontap-driver-details)
 
-If you want to use an iSCSI LUN instead of an NFS file system, please refer to [these instructions](README-san.md#configure-the-trident-csi-backend-to-use-fsx-for-netapp-ontap).
+If you want to use an iSCSI LUN instead of an NFS file system, please refer to [these instructions](README-san.md).
 
 In the commands below you're going to need the FSxN ID, the FSX SVM name, and the
 secret ARN. All of that information can be obtained from the output
