Skip to content

Commit 5fd6da7

Browse files
committed
Update README.md
1 parent 16ddad5 commit 5fd6da7

File tree

1 file changed

+21
-22
lines changed
  • Monitoring/monitor_fsxn_with_harvest_on_eks

1 file changed

+21
-22
lines changed

Monitoring/monitor_fsxn_with_harvest_on_eks/README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,27 @@ Harvest Helm chart installation will result the following:
1414
* Each FSxN cluster will represent as Kubernetes pod on the cluster.
1515
* Collecting metrics about your FSxNs and adding existing Grafana dashboards for better visualization.
1616

17+
### Integration with AWS Secrets Manager
18+
This Harvest installation supports integration with AWS Secrets Manager. To use it store your FSxN credentials into a
19+
Secrets Manager secret. Harvest will invoke the script specified in the credentials_script path section which is already
20+
mapped in Harvest container. The credentails_script will fetch the secret and set the credentials based on its content.
21+
It expects the secret string to be a json structure with a `username` and `password` keys. For example:
22+
```json
23+
{
24+
"username": "fsxadmin",
25+
"password": "fsxadmin-password"
26+
}
27+
```
28+
A ServiceAccount should be created during the installation with the sufficient permissions to fetch the secrets.
29+
1730
### Prerequisites
1831
* `Helm` - for resources installation.
1932
* An FSx for ONTAP file system deployed in the same VPC as the EKS cluster.
2033
* Existing `Secrets Manager`secret in the same region as the FSxN file system.
2134

22-
### Deployment
35+
## Deployment
2336

24-
## Deployment of Prometheus and Grafana
37+
### Deployment of Prometheus and Grafana
2538
If you don't already have Prometheus and Grafana running in your EKS cluster, you can deploy both of them
2639
from the Prometheus community repository by using the following commands:
2740

@@ -72,24 +85,10 @@ kube-prometheus-stack-prometheus-node-exporter-ffckd 1/1 Running 0
7285
prometheus-kube-prometheus-stack-prometheus-0 2/2 Running 0 50s
7386
```
7487

75-
### Integration with AWS Secrets Manager
76-
77-
This Harvest installation supports integration with AWS Secrets Manager. To use it store your FSxN credentials into a
78-
Secrets Manager secret. Harvest will invoke the script specified in the credentials_script path section which is already
79-
mapped in Harvest container. The credentails_script will fetch the secret and set the credentials based on its content.
80-
It expects the secret string to be a json structure with a `username` and `password` keys. For example:
81-
```json
82-
{
83-
"username": "fsxadmin",
84-
"password": "fsxadmin-password"
85-
}
86-
```
87-
A ServiceAccount should be created during the installation with the sufficient permissions to fetch the secrets.
88-
89-
### Monitoring multiples FSxN
88+
### Specify which FSxNs to monitor
9089

91-
The Helm chart supports monitoring multiple FSxNs. You can add multiples FSxNs by configure it on `values.yaml`.
92-
For example:
90+
The Helm chart supports monitoring multiple FSxNs. You can add multiples FSxNs by editing the `values.yaml` file
91+
and updating the `clusters` section. For example:
9392
```
9493
fsxs:
9594
clusters:
@@ -108,7 +107,7 @@ Of course replace the strings within the <> with your own values.
108107

109108
**NOTE:** Each FSxN cluster should have unique port number for promPort.
110109

111-
### Installation
110+
### Deployment of the Harvest Helm chart
112111
Download the Harvest helm chart from this GitHub repository found in the 'harvest' directory. The custom Helm chart includes:
113112
* `deplyment.yaml` - Harvest deployment using Harvest latest version image
114113
* `harvest-config.yaml` - Harvest backend configuration
@@ -159,7 +158,7 @@ Note that this creates a variable named `POLICY_ARN` that you will use in the ne
159158

160159
**Create ServiceAccount**:
161160

162-
**note**: If you don't already have a namespace where you want to deploy Harvest, you can create one using the following command:
161+
**Note**: If you don't already have a namespace where you want to deploy Harvest, you can create one using the following command:
163162
```
164163
kubectl create ns <NAMESPACE>
165164
```
@@ -271,7 +270,7 @@ Also apply the region name to FSxN's region in yace-override-values.yaml:
271270

272271
Run the following command to install the yace-exporter helm chart:
273272
```text
274-
helm install nerdswords/yet-another-cloudwatch-exporter -f yace-override-values.yaml
273+
helm install yace-cw-exporter --namespace <NAMESPACE> nerdswords/yet-another-cloudwatch-exporter -f yace-override-values.yaml
275274
```
276275

277276
### Adding Grafana dashboards and visualize your FSxN metrics on Grafana

0 commit comments

Comments
 (0)