-
Notifications
You must be signed in to change notification settings - Fork 52
feat: gcnv ontap mode support #4235
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d136106
feat: gcnv ontap mode support
rahulguptajss ba2ee85
feat: gcnv ontap mode support
rahulguptajss f587c46
feat: gcnv ontap mode support
rahulguptajss 71e17a4
feat: gcnv ontap mode support
rahulguptajss 9cf8c92
feat: gcnv ontap mode support
rahulguptajss File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| Harvest supports monitoring [Google Cloud NetApp Volumes (GCNV) in ONTAP mode](https://docs.cloud.google.com/netapp/volumes/docs/ontap/overview). | ||
|
|
||
| ## Poller Configuration | ||
|
|
||
| Add a poller to your `harvest.yml` with the full GCNV resource path as `addr` and set `gcnv_ontap_mode: true`. | ||
|
|
||
| ```yaml | ||
| Pollers: | ||
| my-gcnv-poller: | ||
| datacenter: gcp-us-central | ||
| addr: <host>/v1beta1/projects/<project_id>/locations/<location>/storagePools/<pool_name>/ontap | ||
| gcnv_ontap_mode: true | ||
| credentials_script: | ||
| path: /path/to/token-script.sh | ||
| schedule: 5m | ||
| timeout: 10s | ||
| collectors: | ||
| - Rest | ||
| - KeyPerf | ||
| - Ems | ||
| exporters: | ||
| - prometheus1 | ||
| ``` | ||
|
|
||
| `addr` must be the full GCNV resource path without a scheme — do not include `http://` or `https://`. | ||
|
|
||
| GCNV uses Bearer token authentication. Use [`credentials_script`](configure-harvest-basic.md#credentials-script) to supply a token at runtime. The script must print `authToken: <token>` to stdout. | ||
|
|
||
| Below is an example script using a GCP service account key file: | ||
|
|
||
| ```bash | ||
| #!/bin/bash | ||
| gcloud auth activate-service-account --key-file=/path/to/service-account.json 2>/dev/null | ||
| echo "authToken: $(gcloud auth print-access-token)" | ||
| ``` | ||
|
|
||
| For all poller parameters, see [Poller configuration](configure-harvest-basic.md#pollers). | ||
|
|
||
| ## Supported Harvest Metrics | ||
|
|
||
| Capacity and configuration metrics are available via the `Rest` collector in GCNV ONTAP mode. | ||
| However, some metrics may not be available due to permission limitations imposed by the GCNV ONTAP mode environment. | ||
| Only limited performance metrics are supported because GCNV ONTAP mode does not support the `ZapiPerf` or `RestPerf` collectors. | ||
| Instead, use the [KeyPerf](configure-keyperf.md) collector to gather latency, IOPS, and throughput performance metrics for a limited set of objects. | ||
|
|
||
| The following collectors are supported: | ||
|
|
||
| - `Rest` — capacity, configuration, and inventory metrics | ||
| - [`KeyPerf`](configure-keyperf.md) — latency, IOPS, and throughput performance metrics | ||
| - `Ems` — events and alerts | ||
|
|
||
| Performance metrics with the API name `KeyPerf` in the [ONTAP metrics documentation](ontap-metrics.md) are supported in GCNV ONTAP mode systems. | ||
| As a result, some panels in the dashboards may be missing information. | ||
|
|
||
| ## Supported Harvest Dashboards | ||
|
|
||
| The dashboards that work with GCNV ONTAP mode are tagged with `gcnv-ontap-mode` and listed below: | ||
|
|
||
| * ONTAP: LUN | ||
| * ONTAP: Security | ||
| * ONTAP: SVM | ||
| * ONTAP: Volume | ||
| * ONTAP: Volume by SVM | ||
| * ONTAP: Volume Deep Dive |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -418,7 +418,8 @@ | |
| "harvest", | ||
| "ontap", | ||
| "cdot", | ||
| "fsx" | ||
| "fsx", | ||
| "gcnv-ontap-mode" | ||
| ], | ||
| "templating": { | ||
| "list": [ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2626,7 +2626,8 @@ | |
| "harvest", | ||
| "ontap", | ||
| "cdot", | ||
| "fsx" | ||
| "fsx", | ||
| "gcnv-ontap-mode" | ||
| ], | ||
| "templating": { | ||
| "list": [ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5354,7 +5354,8 @@ | |
| "harvest", | ||
| "ontap", | ||
| "cdot", | ||
| "fsx" | ||
| "fsx", | ||
| "gcnv-ontap-mode" | ||
| ], | ||
| "templating": { | ||
| "list": [ | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.