Skip to content
This repository was archived by the owner on Feb 23, 2023. It is now read-only.

Commit bc254e3

Browse files
authored
Update README.md
Add a missing commit to the README file that details how to start everything.
1 parent 7bd097a commit bc254e3

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ customizable and extensible based on your individual needs.
1010

1111
## Quickstart Guide
1212

13-
You'll need to have Docker (1.13.0+) and Docker-Compose installed in order to get started. [Installation](https://docs.docker.com/install/)
14-
13+
You'll need to have Docker 17.05.0-ce+ and Docker-Compose installed in order to get started
14+
[Installation](https://docs.docker.com/install/). You'll also need GNU Make installed (`yum/apt install make`).
1515
The storage-systems to be monitored must be defined in the 'collector/config.json' file. There is an example file located at
1616
collector/config.sample.json for your reference. You may also choose to add the systems to Web Services manually, as detailed
1717
below.
1818

19-
Once Docker is installed and the storage-systems are configured, run the start.sh script. Within a few minutes, all
19+
Once Docker is installed and the storage-systems are configured, run `make run`. Within a few minutes, all
2020
dependencies should be retrieved, installed, and started.
2121

2222
When you run this script, it will prompt you for a confirmation on whether or not you wish to continue and allow the script to
@@ -27,7 +27,7 @@ Grafana login page and the E-Series Landing Page. Use the default login credenti
2727

2828

2929
## Overview
30-
In a nutshell, the Web Services Proxy will periodically poll your storage-system[s] for performance data, which we will collect
30+
The Web Services Proxy will periodically poll your storage-system[s] for performance data, which we will collect
3131
at a regular and consistent interval using a simple Python script. This script will push the data into a Graphite database,
3232
which is a database for storing metrics data. Grafana, a data visualization engine for time-series data, is then utilized
3333
along with several customized dashboards to present the data graphically. All of these components are integrated together by
@@ -66,7 +66,7 @@ it is entirely possible (and encouraged), for you to [create your own](http://do
6666
Grafana. The pre-built dashboards are available in: ** *<install_dir>/ansible/dashboards/* **
6767

6868
### NetApp SANtricity Web Services Proxy
69-
The Web Services Proxy, provides a RESTful interface for managing/monitoring E-Series storage systems. Our newest hardware
69+
The Web Services Proxy provides a RESTful interface for managing/monitoring E-Series storage systems. Our newest hardware
7070
models provide a RESTful API out-of-the-box, but the Web Services Proxy will support the newest systems as well as the legacy
7171
storage systems that do not. It is highly scalable and can support upwards of 500 E-Series systems while using < 2 GB of
7272
memory.
@@ -86,8 +86,11 @@ netapp_web_services:
8686
The Web Services Proxy installation includes a GUI component that can be utilized to manage the newest E-Series systems (systems running
8787
firmware levels 11.40 and above), which may or may not work for your environment.
8888

89-
By default we will utilize default credentials for accessing the Web Services Proxy (*admin/admin*). These credentials may be updated, but
90-
you will need to update the credentials file for the collector script when doing so (** *&lt;install_dir&gt;/collector/config.json* **). These credentials can optionally be passed as arguments to the collector script (*-u USERNAME -p PASSWORD*) which will cause the *config.json* credentials to be ignored. Environment variables for this purpose are exposed in the docker-compose.yml file's stats_collector section.
89+
By default we will utilize default credentials for accessing the Web Services Proxy (*admin/admin*). These credentials should be updated, but
90+
you will also need to update the credentials file for the collector script when doing so
91+
(** *&lt;install_dir&gt;/collector/config.json* **). These credentials can optionally be passed as arguments to the collector
92+
script (*-u USERNAME -p PASSWORD*) which will cause the *config.json* credentials to be ignored. Environment variables for this
93+
purpose are exposed in the docker-compose.yml file's stats_collector section.
9194

9295
## Supporting Tools
9396
Installing each of these components and configuring them properly on an arbitrary OS version can be difficult. Rather than
@@ -159,7 +162,8 @@ This file is responsible for defining retention rates for metric storage. The re
159162
Note that changes made to retention rates will invalidate data collected before the changes were made.
160163

161164
### Starting It Up
162-
It's pretty simple: run the start.sh script. This will begin the process of building, setting up, and running everything. When you want to stop it, run the stop.sh script. If you're trying to monitor the status of any of these tools, you can do so using standard Docker commands. To remove any current container instances, run the clean.sh script after stopping.
165+
Starting the application is simple: run`make run` from the shell.
166+
This will begin the process of building, setting up, and running everything. When you want to stop it, run the stop.sh script. If you're trying to monitor the status of any of these tools, you can do so using standard Docker commands. To remove any current container instances, run the clean.sh script after stopping.
163167

164168
When you run this script, it will prompt you for a confirmation on whether or not you wish to continue and allow the script to
165169
download the default container images. If you wish to update to a newer image tag, you can cancel out and do so now.
@@ -184,7 +188,9 @@ Documentation for additional configuration and navigation can be found [here](ht
184188

185189
### I don't have access to Docker
186190

187-
At this time (and unlikely to change), Docker is a hard requirement for using this project.
191+
At this time (and unlikely to change), Docker is a hard requirement for using this project. While you can certainly utilize the
192+
scripts and configuration provided here, 90% of the benefit of this project is in the automation through Docker. Without it,
193+
setup and configuration would take hours or days for a new deployment.
188194

189195
### I don't have network access on this machine
190196

@@ -230,7 +236,11 @@ While we do encourage variations, improvements, and additions, these are definit
230236
enter an issue and/or ask for help, we can't guarantee that we can, or will try to fix your deployment and may ask
231237
you to revert to a known good configuration.
232238

233-
### I get prompted each time I run the startup script!
239+
### I get prompted for confirmation each time I run `make run`!
234240

235-
You may add the --quiet or -q option to keep from being prompted each time you run the script. This will automatically choose
241+
You may add 'QUIET=true' to the .env file to keep from being prompted each time you run the script. This will automatically choose
236242
'yes' when prompted.
243+
244+
### Do I have to re-run `make run` after I reboot my server?
245+
246+
No, you don't have to re-run it after a reboot. The images are configured to automatically restart (unless you stop them).

0 commit comments

Comments
 (0)