Skip to content

Commit

Permalink
Merge pull request #13 from datamattsson/exporter-101
Browse files Browse the repository at this point in the history
v1.0.2
  • Loading branch information
datamattsson authored Sep 25, 2023
2 parents 5269009 + 1f9f956 commit a59f8f6
Show file tree
Hide file tree
Showing 7 changed files with 154 additions and 67 deletions.
123 changes: 72 additions & 51 deletions docs/css/hpedev.css
Original file line number Diff line number Diff line change
@@ -1,130 +1,151 @@
.wy-side-nav-search,
.wy-nav-top {
background: #477083;
.wy-side-nav-search, .wy-nav-top {
background: #477083;
}
.wy-nav-side {
background: #425563;
width: 300px;
background: #425563;
}

.wy-menu-vertical a:hover {
background-color: #00b388;
color: #fff;
background-color: #00b388;
color: #fff;
}

.wy-menu-vertical span {
font-weight: bold;
color: #ddd;
font-weight: bold;
font-size: 105%;
color: #ddd;
}

.wy-menu-vertical a {
line-height: 100%;
padding-left: 2.6em;
color: #b3b3b3;
}

.wy-menu-vertical header, .wy-menu-vertical p.caption {
height: 16px;
line-height: 16px;
}

/* blue */
.rst-content .note {
background: #dbf4ff;
background: #DBF4FF;
}
.rst-content .note .admonition-title {
background-color: #67b2d5;
background-color: #67B2D5;
}
.rst-content .seealso {
background: #dbf4ff;
background: #DBF4FF;
}
.rst-content .seealso .admonition-title {
background-color: #67b2d5;
background-color: #67B2D5;
}

/* green */
.rst-content .tip {
background: #dafffd;
background: #DAFFFD;
}
.rst-content .tip .admonition-title {
background-color: #00b6ae;
background-color: #00B6AE;
}
.rst-content .important {
background: #dafffd;
background: #DAFFFD;
}
.rst-content .important .admonition-title {
background-color: #00b6ae;
background-color: #00B6AE;
}
.rst-content .hint {
background: #dafffd;
background: #DAFFFD;
}
.rst-content .hint .admonition-title {
background-color: #00b6ae;
background-color: #00B6AE;
}

/* orange */
.rst-content .warning {
background: #ffe3d7;
background: #FFE3D7;
}
.rst-content .warning .admonition-title {
background-color: #ff9161;
background-color: #FF9161;
}
.rst-content .caution {
background: #ffe3d7;
background: #FFE3D7;
}
.rst-content .caution .admonition-title {
background-color: #ff9161;
background-color: #FF9161;
}

/* red */
.rst-content .danger {
background: #e9e2f0;
background: #E9E2F0;
}
.rst-content .danger .admonition-title {
background-color: #a250f0;
background-color: #A250F0;
}
.rst-content .error {
background: #e9e2f0;
background: #E9E2F0;
}
.rst-content .error .admonition-title {
background-color: #a250f0;
background-color: #A250F0;
}

/* tabbed code fences */
.md-fenced-code-tabs * {
box-sizing: border-box;
box-sizing: border-box;
}

.md-fenced-code-tabs {
box-sizing: border-box;
display: flex;
position: relative;
flex-wrap: wrap;
width: 100%;
background-color: #eee;
margin-bottom: 25px;
box-sizing: border-box;
display: flex;
position: relative;
flex-wrap: wrap;
width: 100%;
background-color: #eee;
margin-bottom: 25px;
}

.md-fenced-code-tabs input {
position: absolute;
opacity: 0;
position: absolute;
opacity: 0;
}

.md-fenced-code-tabs label {
width: auto;
padding: 0 4px;
margin: 0 8px;
cursor: pointer;
color: #2980b9;
margin-top: 10px;
width: auto;
padding: 0 4px;
margin: 0 8px;
cursor: pointer;
color: #2980b9;
margin-top: 10px;
}

.md-fenced-code-tabs input:checked + label {
color: #333;
font-weight: bold;
color: #333;
font-weight: bold;
}

.md-fenced-code-tabs .code-tabpanel {
display: none;
width: 100%;
margin-top: 10px;
order: 99;
display: none;
width: 100%;
margin-top: 10px;
order: 99;
}

.md-fenced-code-tabs input:checked + label + .code-tabpanel {
display: block;
display: block;
}

.md-fenced-code-tabs pre,
.md-fenced-code-tabs .codehilite {
width: 100%;
margin: 0px;
width: 100%;
margin: 0px;
}

.rst-versions {
width: 310px;
}

.rst-content .section ol li > ol, .rst-content .section ol li > ul, .rst-content .section ul li > ol, .rst-content .section ul li > ul, .rst-content .toctree-wrapper ol li > ol, .rst-content .toctree-wrapper ol li > ul, .rst-content .toctree-wrapper ul li > ol, .rst-content .toctree-wrapper ul li > ul, .rst-content section ol li > ol, .rst-content section ol li > ul, .rst-content section ul li > ol, .rst-content section ul li > ul, .rst-content .section ol li > *, .rst-content .section ul li > *, .rst-content .toctree-wrapper ol li > *, .rst-content .toctree-wrapper ul li > *, .rst-content section ol li > *, .rst-content section ul li > * {
margin-top: 0px;
margin-bottom: 0px;
}
14 changes: 7 additions & 7 deletions docs/deployment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ password: examplepassword

The `address` value is either a resolvable hostname or IP address of the management interface on the storage system. The `username` value identifies a storage system user with privileges described below.

| Storage System | User Type | Minimal Role |
| :------------------------------------------- | :---------- | :------------- |
| HPE Alletra 9000, Primera, 3PAR | System User | Browse |
| HPE Alletra 6000, Nimble Storage | System User | Guest |
| HPE Alletra 6000, Nimble Storage<sup>1</sup> | Tenant | N/A |
| Storage System | User Type | Minimal Role | Open Ports Requirements |
| :------------------------------------------------ | :---------- | :------------- | :---------------------- |
| HPE Alletra 9000, Primera, 3PAR | System User | Browse | 22, 443 |
| HPE Alletra 5000/6000, Nimble Storage | System User | Guest | 5392 |
| HPE Alletra 5000/6000, Nimble Storage<sup>1</sup> | Tenant | N/A | 443, 5392 |

<sup>1</sup> = NimbleOS 6.0 and above only.

Expand Down Expand Up @@ -58,7 +58,7 @@ CONFIG-PATH is the location of the storage system [configuration](#configuration

# Using a Container Image

A container image is hosted at `quay.io/hpestorage/array-exporter:v1.0.0`, with v1.0.0 replaced by the desired release version.
A container image is hosted at `quay.io/hpestorage/array-exporter:v1.0.2`, with v1.0.2 replaced by the desired release version.

When deploying the array exporter as a container, the configuration file must be mounted as a volume.

Expand All @@ -71,7 +71,7 @@ In this example, the configuration file at `/tmp/storage-system.yaml` is bound t
```markdown
docker run -it --name hpe-array-exporter -p 9090:8080 \
-v /tmp/storage-system.yaml:/etc/config/storage-system.yaml \
quay.io/hpestorage/array-exporter:v1.0.0 \
quay.io/hpestorage/array-exporter:v1.0.2 \
--log.path /var/log/hpe-array-exporter.log \
/etc/config/storage-system.yaml
```
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This documentation shows how to [deploy](deployment/index.md) the exporter, the
HPE Storage Array Exporter for Prometheus is compatible with these storage arrays:

* HPE Alletra 9000
* HPE Alletra 6000
* HPE Alletra 5000/6000
* HPE Nimble Storage
* HPE Primera
* HPE 3PAR
Expand Down
7 changes: 5 additions & 2 deletions docs/metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,12 @@ Each of these metrics includes the following labels.
| cpg | Name of the CPG containing the volume |
| volume | Volume name |

## HPE Alletra 6000 and Nimble
## HPE Alletra 5000/6000 and Nimble

The metrics provided for HPE Alletra 6000 and Nimble Storage systems are equivalent, with the metric names reflecting the storage system type.
The metrics provided for HPE Alletra 5000/6000 and Nimble Storage systems are equivalent, with the metric names reflecting the storage system type.

!!! note
HPE Alletra 5000 metrics will appear as "hpealletra6000".

### Storage Pool Space

Expand Down
62 changes: 62 additions & 0 deletions docs/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,68 @@ The exporter is delivered as:
- [Container images](https://quay.io/repository/hpestorage/array-exporter) hosted on Quay, deployable via standalone Docker or via Kubernetes (with object definitions in [YAML](https://github.com/hpe-storage/co-deployments/tree/master/yaml/array-exporter) available in GitHub).
- [Helm charts](https://artifacthub.io/packages/helm/hpe-storage/hpe-array-exporter/) hosted at Artifact Hub.

### HPE Storage Array Exporter for Prometheus 1.0.2

Release highlights:

- ARM64 images

<table>
<tr>
<th>Binaries and Release Notes</th>
<td>
<a href="https://github.com/hpe-storage/array-exporter/releases/tag/v1.0.2">1.0.2</a> on GitHub
</td>
</tr>
<tr>
<th>Helm Chart</th>
<td>
<a href="https://artifacthub.io/packages/helm/hpe-storage/hpe-array-exporter/1.0.2">1.0.2</a> on Artifact Hub
</td>
</tr>
<tr>
<th>Platforms</th>
<td>
Alletra OS 9000 9.3.0<br />
Alletra OS 5000/6000 6.0.0 or later<br />
Nimble OS 5.0.10.x or later<br />
Primera OS 4.0.x, 4.1.x, 4.2.x, 4.3.x<br />
3PAR OS 3.3.1, 3.3.2
</td>
</tr>
</table>

### HPE Storage Array Exporter for Prometheus 1.0.1

Release highlights:

- Security updates

<table>
<tr>
<th>Binaries and Release Notes</th>
<td>
<a href="https://github.com/hpe-storage/array-exporter/releases/tag/v1.0.1">1.0.1</a> on GitHub
</td>
</tr>
<tr>
<th>Helm Chart</th>
<td>
<a href="https://artifacthub.io/packages/helm/hpe-storage/hpe-array-exporter/1.0.1">1.0.1</a> on Artifact Hub
</td>
</tr>
<tr>
<th>Platforms</th>
<td>
Alletra OS 9000 9.3.0<br />
Alletra OS 5000/6000 6.0.0 or later<br />
Nimble OS 5.0.10.x or later<br />
Primera OS 4.0.x, 4.1.x, 4.2.x, 4.3.x<br />
3PAR OS 3.3.1, 3.3.2
</td>
</tr>
</table>

### HPE Storage Array Exporter for Prometheus 1.0.0

Release highlights:
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ theme:
custom_dir: hpe_theme/
repo_name: 'hpe-storage/array-exporter'
repo_url: 'https://github.com/hpe-storage/array-exporter'
copyright: "Copyright 2021 Hewlett Packard Enterprise Development LP"
copyright: "Copyright 2023 Hewlett Packard Enterprise Development LP"
extra_css:
- css/hpedev.css
use_directory_urls: false
Expand All @@ -33,7 +33,7 @@ nav:
- 'Grafana Dashboards': grafana/index.md
- COMMUNITY:
- 'HPE Developer Community': 'https://developer.hpe.com'
- 'Sign up to HPE DEV on Slack': 'https://slack.hpedev.io'
- 'Sign up to HPE Developer on Slack': 'https://slack.hpedev.io'
- 'Got feedback?': 'https://github.com/hpe-storage/array-exporter/issues/new?title=I have some feedback on the Array Exporter'
- LEGAL:
- 'End User License Agreement': 'legal/eula/index.md'
Expand Down
9 changes: 5 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
mkdocs==1.0.4
mkdocs-redirects
markdown-fenced-code-tabs
mkdocs-macros-plugin
mkdocs==1.3.1
mkdocs-redirects==1.2.1
markdown-fenced-code-tabs==1.0.5
mkdocs-include-markdown-plugin==4.0.4
mkdocs-macros-plugin==1.0.4

0 comments on commit a59f8f6

Please sign in to comment.