Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: quickstart should mention install section #2446

Merged
merged 1 commit into from
Oct 26, 2023
Merged

doc: quickstart should mention install section #2446

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
## 1. Configuration file
## 1. Install Harvest

Harvest is distributed as a container, tarball, and RPM and Debs.
Pick the one that works best for you.
More details can be found in the [installation](install/overview.md) documentation.

## 2. Configuration file

Harvest's configuration information is defined in `harvest.yml`. There are a few ways to tell Harvest how to load this file:

Expand All @@ -14,7 +20,7 @@ Feel free to delete it if you want.
The next step is to add pollers for your ONTAP clusters in the [Pollers](configure-harvest-basic.md#pollers)
section of the Harvest configuration file, `harvest.yml`.

## 2. Start Harvest
## 3. Start Harvest

Start all Harvest pollers as daemons:

Expand All @@ -31,7 +37,7 @@ bin/harvest start jamaica jamaica
Replace `jamaica` and `grenada` with the poller names you defined in `harvest.yml`.
The logs of each poller can be found in `/var/log/harvest/`.

## 3. Import Grafana dashboards
## 4. Import Grafana dashboards

The Grafana dashboards are located in the `$HARVEST_HOME/grafana` directory.
You can manually import the dashboards or use the `bin/harvest grafana` command
Expand All @@ -40,7 +46,7 @@ You can manually import the dashboards or use the `bin/harvest grafana` command
Note: the current dashboards specify Prometheus as the datasource.
If you use the InfluxDB exporter, you will need to create your own dashboards.

## 4. Verify the metrics
## 5. Verify the metrics

If you use a Prometheus Exporter, open a browser and navigate to [http://0.0.0.0:12990/](http://0.0.0.0:12990/)
(replace `12990` with the port number of your poller).
Expand All @@ -55,7 +61,7 @@ More information on configuring the exporter can be found in the

If you can't access the URL, check the logs of your pollers. These are located in `/var/log/harvest/`.

## 5. (Optional) Setup Systemd service files
## 6. (Optional) Setup Systemd service files

If you're running Harvest on a system with Systemd, you may want
to [take advantage of systemd instantiated units](https://github.com/NetApp/harvest/tree/main/service/contrib)
Expand Down
Loading