Merge pull request #230 from NetApp/synchronize_docker_compose

Synchronize docker compose

Author: nichollri

Monitoring/monitor_fsxn_with_harvest_on_ec2/README-Manual.md

@@ -110,12 +110,25 @@ If your exiting ec2 instance already had an instance profile, then simply add th
 To install Docker use the following commands if you are running an Red Hat based Linux:
 ```sh
 sudo yum install docker
-sudo curl -L https://download.docker.com/linux/centos/7/x86_64/stable/Packages/docker-compose-plugin-2.6.0-3.el7.x86_64.rpm -o ./compose-plugin.rpm
-sudo yum install ./compose-plugin.rpm -y
 sudo systemctl start docker
+sudo systemctl enable docker
 ```
 If you aren't running a Red Hat based Linux, you can follow the instructions [here](https://docs.docker.com/engine/install/).
 
+Install Docker Compose:
+```text
+LATEST_COMPOSE_VERSION=$(curl -s https://api.github.com/repos/docker/compose/releases/latest | jq -r '.tag_name')
+ARCH=$(uname -m)
+if [ -z "$ARCH"  -o -z "$LATEST_COMPOSE_VERSION" ]; then
+  echo "Error: Unable to determine latest version or architecture."
+else
+  sudo curl -s -L "https://github.com/docker/compose/releases/download/$LATEST_COMPOSE_VERSION/docker-compose-linux-$ARCH" -o /usr/local/bin/docker-compose
+  sudo chmod +x /usr/local/bin/docker-compose
+  # Create a symlink in /usr/bin for more accessibility.
+  [ ! -L /usr/bin/docker-compose ] && sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
+fi
+```
+
 To confirm that docker has been installed correctly, run the following command:
 
 ```sh
@@ -145,6 +158,7 @@ Share images, automate workflows, and more with a free Docker ID:
 For more examples and ideas, visit:
  https://docs.docker.com/get-started/
 ```
+
 ### 5. Install Harvest on EC2
 
 Preform the following steps to install Harvest on your EC2 instance:
@@ -154,6 +168,8 @@ Preform the following steps to install Harvest on your EC2 instance:
 Modify the `harvest.yml` found in this repo with your clusters details. You should just have to change the `<FSxN_ip_X>` with the IP addresses of your FSxNs.
 Add as many pollers as you need to monitor all your FSxNs. There should be an AWS Secrets Manager secret for each FSxN.
 
+Note in the example below, it has places for two FSxN. If you only have one, remove the "fsx02" section.
+
 ```yaml
 Exporters:
     prometheus1:
@@ -312,7 +328,7 @@ sudo sed -i -e "\$a\- job_name: 'yace'" -e "\$a\  static_configs:" -e "\$a\    -
 ##### 6. Bring Everything Up
 
 ```sh
-sudo docker compose -f prom-stack.yml -f harvest-compose.yml up -d --remove-orphans
+sudo docker-compose -f prom-stack.yml -f harvest-compose.yml up -d --remove-orphans
 ```
 
 After bringing up the prom-stack.yml compose file, you can access Grafana at 
@@ -323,3 +339,25 @@ You will be prompted to create a new password the first time you log in. Grafana
 username: admin
 password: admin
 ```
+
+## Adding additional FSx for ONTAP file systems.
+If you need to add additional FSxN file systems to monitor after the initial installation,
+you can do so by following the steps mentioned at the bottom of the [CloudFormation deployment](README.md) version of this read me file.
+
+---
+
+## Author Information
+
+This repository is maintained by the contributors listed on [GitHub](https://github.com/NetApp/FSx-ONTAP-utils/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.
+
+© 2025 NetApp, Inc. All Rights Reserved.

Monitoring/monitor_fsxn_with_harvest_on_ec2/README.md

@@ -7,14 +7,26 @@ Go and uses the official AWS SDK. YACE supports auto-discovery of resources via
 filtering monitored resources via regex, and more. You can read more about YACE capabilities from its
 [Documentation](https://github.com/prometheus-community/yet-another-cloudwatch-exporter).
 
+Here are some screenshots of a couple of the dashboards that are included to visualize the metrics collected by Harvest and YACE.
+
+![Screenshot-01](images/grafana-dashboard-01.png)
+
+![Screenshot-02](images/grafana-dashboard-02.png)
+
 ## Prerequisites
 The only prerequisite is an FSx for ONTAP file system running in your AWS account.
 
-## Overview
+## Architectural Overview
+
+This solution uses several components to collect and display all the pertinent metrics from your FSx for ONTAP file system.
+Instead of trying to describe them in words, the following architectural diagram does a great job of showing the components and how they interact with each other:
+![Architectural Diagram](images/FSxN-MonitoringStack-EC2.png)
+
+## Deployment Overview
 
 There are two methods to deploy this solution, either via the AWS CloudFormation template or manually.
-The steps below are geared towrad the CloudFormation deployment method. If you want to deploy manually,
-please refer to these [instructions](README-Manual.md).
+The steps below are geared towards the CloudFormation deployment method. If you want to deploy manually,
+please refer to these [Manual Deployment Instructions](README-Manual.md).
 
 This deployment includes:
 - **Harvest**: Collects ONTAP metrics.[Documentation](https://github.com/NetApp/harvest).
@@ -163,4 +175,21 @@ To monitor additional FSxN resources, follow these steps:
       ```bash
       docker-compose -f prom-stack.yml -f harvest-compose.yml up -d --remove-orphans
       ```
+
 ---
+
+## 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.
+
+© 2025 NetApp, Inc. All Rights Reserved.

Monitoring/monitor_fsxn_with_harvest_on_ec2/images/FSxN-MonitoringStack-EC2.png

@@ -5,8 +5,20 @@ into an AWS EKS cluster to monitor multiple FSx for ONTAP file systems using the
 Grafana + Prometheus stack. It uses the AWS Secrets Manager to obtain
 credentials for each of the FSxN file systems so those credentials aren't insecurely stored.
 
+Here are some screenshots of a couple of the dashboards that are included to visualize the metrics collected by Harvest and YACE.
+
+![Screenshot-01](images/grafana-dashboard-01.png)
+
+![Screenshot-02](images/grafana-dashboard-02.png)
+
 ## Introduction
 
+### Architectural Overview
+
+This solution uses several components to collect and display all the pertinent metrics from your FSx for ONTAP file system.
+Instead of trying to describe them in words, the following architectural diagram does a great job of showing the components and how they interact with each other:
+![Architectural Diagram](images/FSxN-MonitoringStack-EKS.png)
+
 ### What to expect
 
 Harvest Helm chart installation will result the following:
@@ -20,7 +32,7 @@ The format of the secret string should to be a json structure with a `username`
 ```json
 {
   "username": "fsxadmin",
-  "password": "fsxadmin-password"
+  "password": "fsxadmin's_password"
 }
 ```
 A service account should be created during the installation of Harvest with the sufficient permissions to fetch the secrets.
@@ -347,7 +359,7 @@ Once you have access to Grafana, you can log in using the default credentials:
 
 ### Adding Grafana dashboards and visualize your FSxN metrics on Grafana
 Once you login, you'll want to import some dashboards to visualize the metrics collected by Harvest and YACE. You will find
-some example dashboards in the `dashboards` folder in this repository. You can import these dashboards into Grafana by following these steps:
+some example dashboards in the [dashboards](dashboards) folder in this repository. You can import these dashboards into Grafana by following these steps:
 1. Download the dashboards from the `dashboards` folder in this repository to your local PC.
 1. Log in to your Grafana instance.
 1. Click on the "+" icon on the left-hand side menu and select "Import Dashboard".
@@ -362,6 +374,8 @@ Only consider the dashboards in the `cmode` and `cmode-details` directories.
 :memo: **NOTE:** Since the special 'fsxadmin' account doesn't have access to all the metrics that a traditional ONTAP 'admin' account would have,
 some of the metrics and dashboards may not be fully applicable or available. The ones with 'fsx' tag are more relevant for FSxN.
 
+---
+
 ## Author Information
 
 This repository is maintained by the contributors listed on [GitHub](https://github.com/NetApp/FSx-ONTAP-samples-scripts/graphs/contributors).
@@ -376,4 +390,4 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 See the License for the specific language governing permissions and limitations under the License.
 
-© 2024 NetApp, Inc. All Rights Reserved.
+© 2025 NetApp, Inc. All Rights Reserved.