Skip to content

Commit 39e4af0

Browse files
committed
Made minor adjustments to the README.md file.
1 parent 977c9e8 commit 39e4af0

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Monitoring/auto-add-cw-alarms/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ of relying on those events, this script will scan all the file systems and volum
1515

1616
## Invocation
1717
The preferred way to run this script is as a Lambda function. That is because it is very inexpensive to run without having
18-
to maintain compute resources. You can use an `EventBridge Schedule` to run it on a regular basis to
19-
ensure that all the CloudWatch alarms are kept up to date. Since there are several steps involved in setting up a Lambda function
20-
a CloudFormation script is included in the repo, named `cloudlformation.yaml`, that will do the following steps for you:
18+
to maintain any compute resources. You can use an `EventBridge Schedule` to run it on a regular basis to
19+
ensure that all the CloudWatch alarms are kept up to date. Since there are several steps involved in setting up a Lambda function,
20+
a CloudFormation template is included in the repo, named `cloudlformation.yaml`, that will do the following steps for you:
2121
- Create a role that will allow the Lambda function to:
22-
- List AWS regions. This is so it can scan all regions for FSx for ONTAP file systems and volumes.
22+
- List AWS regions. This is so it can get a list of all the regions, so it can know which regions to scan for FSx for ONTAP file systems and volumes.
2323
- List the FSx for ONTAP file systems.
24-
- List the FSx volume.
24+
- List the FSx volumes.
2525
- List the CloudWatch alarms.
26-
- List tags for the resources. This is so you can customize the thresholds for the alarms.
26+
- List tags for the resources. This is so you can customize the thresholds for the alarms on a per instance basis. More on that below.
2727
- Create CloudWatch alarms.
2828
- Delete CloudWatch alarms that it has created (based on alarm names).
2929
- Create a Lambda function with the Python program.
30-
- Create a EventBridge schedule that will run the Lambda function on a user defined basis.
30+
- Create an EventBridge schedule that will run the Lambda function on a user defined basis.
3131
- Create a role that will allow the EventBridge schedule to trigger the Lambda function.
3232

3333
To use the CloudFormation template perform the following steps:
@@ -37,7 +37,7 @@ To use the CloudFormation template perform the following steps:
3737
3. Select `Choose an existing template` and `Upload a template file`.
3838
4. Click `Choose file` and select the `cloudformation.yaml` file you downloaded in step 1.
3939
5. Click `Next` and fill in the parameters presented on the next page. The parameters are:
40-
- `Stack name` - The name of the CloudFormation stack. Note this name is also used as a base name for some of the resources that are created, to make them unique, so you must keep this string under 25 characters so the resource names don't exceed their name length limit.
40+
- `Stack name` - The name of the CloudFormation stack. Note this name is also used as a base name for some of the resources that are created, to make them unique, so you must keep this string under 25 characters, so the resource names don't exceed their name length limit.
4141
- `SNStopic` - The SNS Topic name where CloudWatch will send alerts to. Note that since CloudWatch can't send messages to an SNS topic residing in a different region, it is assumed that the SNS topic, with the same name, will exist in all the regions where alarms are to be created.
4242
- `accountId` - The AWS account ID associated with the SNS topic. This is only used to compute the ARN to the SNS Topic set above.
4343
- `customerId` - This is optional. If provided the string entered is included in the description of every alarm created.
@@ -48,7 +48,7 @@ To use the CloudFormation template perform the following steps:
4848
- `alarmPrefixString` - This defines the string that will be prepended to every CloudWatch alarm name that the program creates. Having a known prefix is how it knows it is the one maintaining the alarm.
4949
- `regions` - This is a comma separated list of AWS region names (e.g. us-east-1) that the program will act on. If not specified, the program will scan on all regions that support an FSx for ONTAP file system. Note that no checking is performed to ensure that the regions you provide are valid.
5050
6. Click `Next`. There aren't any recommended changes to make to any of the proceeding pages, so just click `Next` again.
51-
7. On the final page, check the box that says `I acknowledge that AWS CloudFormation might create IAM resources with custom names.` and click `Submit`.
51+
7. On the final page, check the box that says `I acknowledge that AWS CloudFormation might create IAM resources with custom names.` and then click `Submit`.
5252

5353
If you prefer, you can run this Python program on any UNIX based computer that has Python installed. See the "Running on a computer" section below for more information.
5454

@@ -196,7 +196,7 @@ Note it assumes that the alarmPrefixString is set to "FSx-ONTAP-Auto".
196196
}
197197
```
198198

199-
Once you have deployed the Lambda function it is recommended to set up a scheduled to run it on a regular basis.
199+
Once you have deployed the Lambda function it is recommended to set up a schedule to run it on a regular basis.
200200
The easiest way to do that is:
201201
1. Click on the `Add trigger` button from the Lambda function page.
202202
2. Select `EventBridge (CloudWatch Events)` as the trigger type.

0 commit comments

Comments
 (0)