charts/charts/network-ups-tools/README.md
2021-02-18 13:19:14 -05:00

121 lines
3.9 KiB
Markdown

# network-ups-tools
![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![AppVersion: v2.7.4-2061-g46c7da76](https://img.shields.io/badge/AppVersion-v2.7.4--2061--g46c7da76-informational?style=flat-square)
Network UPS Tools is a collection of programs which provide a common interface for monitoring and administering UPS, PDU and SCD hardware.
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
## Source Code
* <https://github.com/networkupstools/nut>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://k8s-at-home.com/charts/ | common | 3.0.1 |
## TL;DR
```console
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install network-ups-tools k8s-at-home/network-ups-tools
```
## Installing the Chart
To install the chart with the release name `network-ups-tools`
```console
helm install network-ups-tools k8s-at-home/network-ups-tools
```
## Uninstalling the Chart
To uninstall the `network-ups-tools` deployment
```console
helm uninstall network-ups-tools
```
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
## Configuration
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install network-ups-tools \
--set env.TZ="America/New York" \
k8s-at-home/network-ups-tools
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install network-ups-tools k8s-at-home/network-ups-tools -f values.yaml
```
## Custom configuration
N/A
## Values
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.files."nut.conf" | string | `"MODE=netserver\n"` | |
| config.files."ups.conf" | string | `"[dummy]\n driver = dummy-ups\n port = dummy-ups.dev\n desc = \"dummy-ups in dummy mode\"\n"` | |
| config.files."upsd.conf" | string | `"LISTEN 0.0.0.0\n"` | |
| config.mode | string | `"values"` | |
| env | object | `{}` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"k8sathome/network-ups-tools"` | |
| image.tag | string | `"v2.7.4-2061-g46c7da76"` | |
| ingress.enabled | bool | `false` | |
| service.port.name | string | `"server"` | |
| service.port.port | int | `3493` | |
| strategy.type | string | `"Recreate"` | |
## Changelog
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog).
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
### [1.0.0]
#### Added
- N/A
#### Changed
- N/A
#### Removed
- N/A
[1.0.0]: #1.0.0
## Support
- See the [Wiki](https://github.com/k8s-at-home/charts/wiki)
- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
- Ask a [question](https://github.com/k8s-at-home/charts/discussions)
- Join our [Discord](https://discord.gg/sTMX7Vh) community
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)