[all] Update READMEs

This commit is contained in:
2021-12-06 17:50:14 +00:00
parent 52e72724a9
commit ec0eba80f2
6 changed files with 228 additions and 6 deletions

View File

@@ -22,10 +22,12 @@ You can then run `helm search nikdoof` to see the charts.
See [charts folder](./charts) for a complete list.
* [aaisp2mqtt](./charts/aaisp2mqtt) - A tool to pull information from [Andrews & Arnold](https://www.aa.net.uk/) CHAOSv2 API and output to MQTT
* [aaisp2mqtt](./charts/aaisp2mqtt) - A tool to pull information from [Andrews & Arnold](https://www.aa.net.uk/) CHAOSv2 API and output to MQTT.
* [idrac6](./charts/idrac6) - A VNC/Web UI container to wrap around the outdated Java/KVM solution in Dell iDRAC6, and make it HTML5.
* [vsphere-influxdb-go](./charts/vsphere-influxdb-go) - A vSphere statistics exporter that outputs to InfluxDB.
* [zigbee2mqttassistant](./charts/zigbee2mqttassistant) - A WebUI for Zigbee2MQTT
* [zigbee2mqttassistant](./charts/zigbee2mqttassistant) - A WebUI for Zigbee2MQTT.
* [hg612-exporter] - A Prometheus exporter for HG612 xDSL Modems.
* [aaisp-exporter] - A Prometheus exporter for [Andrews & Arnold](https://www.aa.net.uk/) CHAOSv2 API.
## License

View File

@@ -0,0 +1,44 @@
# aaisp2mqtt
![Version: 0.3.2](https://img.shields.io/badge/Version-0.3.2-informational?style=flat-square) ![AppVersion: 0.3.1](https://img.shields.io/badge/AppVersion-0.3.1-informational?style=flat-square)
Pulls data from the AAISP CHAOSv2 API into MQTT
**Homepage:** <https://github.com/nikdoof/aaisp2mqtt>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| nikdoof | andy@tensixtyone.com | |
## Source Code
* <https://hub.docker.com/r/nikdoof/aaisp2mqtt/>
* <https://github.com/natm/aaisp2mqtt>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| aaisp | object | `{}` | |
| affinity | object | `{}` | |
| cronjob.concurrencyPolicy | string | `"Allow"` | |
| cronjob.failedJobsHistoryLimit | int | `1` | |
| cronjob.schedule | string | `"*/10 * * * *"` | |
| cronjob.successfulJobsHistoryLimit | int | `3` | |
| fullnameOverride | string | `""` | |
| homeassistant.enabled | bool | `false` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"nikdoof/aaisp2mqtt"` | |
| image.tag | string | `"0.3.1"` | |
| mqtt.authenticated | bool | `false` | |
| mqtt.port | int | `1883` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| replicaCount | int | `1` | |
| resources | object | `{}` | |
| tolerations | list | `[]` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

View File

@@ -1,6 +1,6 @@
# hg612-exporter
![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square)
A prometheus exporter for the HG612 modem
@@ -78,7 +78,7 @@ N/A
| env | object | See below | environment variables. See more environment variables in the [hg612-exporter documentation](https://hg612-exporter.org/docs). |
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| image.repository | string | `"nikdoof/hg612-exporter"` | image repository |
| image.tag | string | `"latest"` | image tag |
| image.tag | string | `"0.0.1"` | image tag |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
| metrics.enabled | bool | See values.yaml | Enable and configure a Prometheus serviceMonitor for the chart under this key. |
| metrics.prometheusRule | object | See values.yaml | Enable and configure Prometheus Rules for the chart under this key. |
@@ -88,7 +88,7 @@ N/A
| metrics.serviceMonitor.scrapeTimeout | string | `"30s"` | |
| modem | object | See below | Modem configuration details |
| modem.host | string | `nil` | DNS name or IP of the HG612 modem. |
| modem.identifier | object | `{"":null}` | Identifier to use in Prometheus for this modem. |
| modem.identifier | string | `nil` | Identifier to use in Prometheus for this modem. |
| modem.interval | int | `10` | How often to collect statistics from the modem. |
| service | object | See values.yaml | Configures service settings for the chart. |

View File

@@ -77,7 +77,7 @@ N/A
|-----|------|---------|-------------|
| env | object | See below | environment variables. See more environment variables in the [idrac6 documentation](https://github.com/DomiStyle/docker-idrac6). |
| env.IDRAC_KEYCODE_HACK | string | `"false"` | Enable keycode hack |
| env.IDRAC_PORT | int | `443` | iDRAC hostname to connect to -- iDRAC Username to use -- iDRAC password to use -- iDRAC HTTP port |
| env.IDRAC_PORT | int | `443` | iDRAC hostname to connect to IDRAC_HOST: -- iDRAC Username to use IDRAC_USER: root -- iDRAC password to use IDRAC_PASSWORD: calvin -- iDRAC HTTP port |
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| image.repository | string | `"domistyle/idrac6"` | image repository |
| image.tag | string | `"v0.5"` | image tag |

View File

@@ -0,0 +1,129 @@
# vsphere-influxdb-go
![Version: 0.2.2](https://img.shields.io/badge/Version-0.2.2-informational?style=flat-square) ![AppVersion: 0.8.5](https://img.shields.io/badge/AppVersion-0.8.5-informational?style=flat-square)
Collect VMware vCenter and ESXi performance metrics and send them to InfluxDB
**Homepage:** <https://github.com/Oxalide/vsphere-influxdb-go>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| nikdoof | andy@tensixtyone.com | |
## Source Code
* <https://hub.docker.com/r/nikdoof/vsphere-influxdb-go/>
* <https://github.com/janeczku/calibre-web>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| config.Domain | string | `""` | |
| config.InfluxDB | list | `[]` | |
| config.Interval | int | `60` | |
| config.Metrics[0].Definition[0].Instances | string | `"*"` | |
| config.Metrics[0].Definition[0].Metric | string | `"cpu.usage.average"` | |
| config.Metrics[0].Definition[10].Instances | string | `"*"` | |
| config.Metrics[0].Definition[10].Metric | string | `"mem.consumed.maximum"` | |
| config.Metrics[0].Definition[11].Instances | string | `"*"` | |
| config.Metrics[0].Definition[11].Metric | string | `"mem.active.average"` | |
| config.Metrics[0].Definition[12].Instances | string | `"*"` | |
| config.Metrics[0].Definition[12].Metric | string | `"mem.active.maximum"` | |
| config.Metrics[0].Definition[13].Instances | string | `"*"` | |
| config.Metrics[0].Definition[13].Metric | string | `"mem.vmmemctl.average"` | |
| config.Metrics[0].Definition[14].Instances | string | `"*"` | |
| config.Metrics[0].Definition[14].Metric | string | `"mem.vmmemctl.maximum"` | |
| config.Metrics[0].Definition[15].Instances | string | `"*"` | |
| config.Metrics[0].Definition[15].Metric | string | `"mem.totalCapacity.average"` | |
| config.Metrics[0].Definition[16].Instances | string | `"*"` | |
| config.Metrics[0].Definition[16].Metric | string | `"net.packetsRx.summation"` | |
| config.Metrics[0].Definition[17].Instances | string | `"*"` | |
| config.Metrics[0].Definition[17].Metric | string | `"net.packetsTx.summation"` | |
| config.Metrics[0].Definition[18].Instances | string | `"*"` | |
| config.Metrics[0].Definition[18].Metric | string | `"net.throughput.usage.average"` | |
| config.Metrics[0].Definition[19].Instances | string | `"*"` | |
| config.Metrics[0].Definition[19].Metric | string | `"net.received.average"` | |
| config.Metrics[0].Definition[1].Instances | string | `"*"` | |
| config.Metrics[0].Definition[1].Metric | string | `"cpu.usage.maximum"` | |
| config.Metrics[0].Definition[20].Instances | string | `"*"` | |
| config.Metrics[0].Definition[20].Metric | string | `"net.transmitted.average"` | |
| config.Metrics[0].Definition[21].Instances | string | `"*"` | |
| config.Metrics[0].Definition[21].Metric | string | `"net.throughput.usage.nfs.average"` | |
| config.Metrics[0].Definition[22].Instances | string | `"*"` | |
| config.Metrics[0].Definition[22].Metric | string | `"datastore.numberReadAveraged.average"` | |
| config.Metrics[0].Definition[23].Instances | string | `"*"` | |
| config.Metrics[0].Definition[23].Metric | string | `"datastore.numberWriteAveraged.average"` | |
| config.Metrics[0].Definition[24].Instances | string | `"*"` | |
| config.Metrics[0].Definition[24].Metric | string | `"datastore.read.average"` | |
| config.Metrics[0].Definition[25].Instances | string | `"*"` | |
| config.Metrics[0].Definition[25].Metric | string | `"datastore.write.average"` | |
| config.Metrics[0].Definition[26].Instances | string | `"*"` | |
| config.Metrics[0].Definition[26].Metric | string | `"datastore.totalReadLatency.average"` | |
| config.Metrics[0].Definition[27].Instances | string | `"*"` | |
| config.Metrics[0].Definition[27].Metric | string | `"datastore.totalWriteLatency.average"` | |
| config.Metrics[0].Definition[28].Instances | string | `"*"` | |
| config.Metrics[0].Definition[28].Metric | string | `"mem.capacity.provisioned.average"` | |
| config.Metrics[0].Definition[29].Instances | string | `"*"` | |
| config.Metrics[0].Definition[29].Metric | string | `"cpu.corecount.provisioned.average"` | |
| config.Metrics[0].Definition[2].Instances | string | `"*"` | |
| config.Metrics[0].Definition[2].Metric | string | `"cpu.usagemhz.average"` | |
| config.Metrics[0].Definition[3].Instances | string | `"*"` | |
| config.Metrics[0].Definition[3].Metric | string | `"cpu.usagemhz.maximum"` | |
| config.Metrics[0].Definition[4].Instances | string | `"*"` | |
| config.Metrics[0].Definition[4].Metric | string | `"cpu.wait.summation"` | |
| config.Metrics[0].Definition[5].Instances | string | `"*"` | |
| config.Metrics[0].Definition[5].Metric | string | `"cpu.system.summation"` | |
| config.Metrics[0].Definition[6].Instances | string | `"*"` | |
| config.Metrics[0].Definition[6].Metric | string | `"cpu.ready.summation"` | |
| config.Metrics[0].Definition[7].Instances | string | `"*"` | |
| config.Metrics[0].Definition[7].Metric | string | `"mem.usage.average"` | |
| config.Metrics[0].Definition[8].Instances | string | `"*"` | |
| config.Metrics[0].Definition[8].Metric | string | `"mem.usage.maximum"` | |
| config.Metrics[0].Definition[9].Instances | string | `"*"` | |
| config.Metrics[0].Definition[9].Metric | string | `"mem.consumed.average"` | |
| config.Metrics[0].ObjectType[0] | string | `"VirtualMachine"` | |
| config.Metrics[0].ObjectType[1] | string | `"HostSystem"` | |
| config.Metrics[1].Definition[0].Instances | string | `"*"` | |
| config.Metrics[1].Definition[0].Metric | string | `"datastore.datastoreVMObservedLatency.latest"` | |
| config.Metrics[1].ObjectType[0] | string | `"VirtualMachine"` | |
| config.Metrics[2].Definition[0].Instances | string | `""` | |
| config.Metrics[2].Definition[0].Metric | string | `"disk.maxTotalLatency.latest"` | |
| config.Metrics[2].Definition[1].Instances | string | `"*"` | |
| config.Metrics[2].Definition[1].Metric | string | `"disk.numberReadAveraged.average"` | |
| config.Metrics[2].Definition[2].Instances | string | `"*"` | |
| config.Metrics[2].Definition[2].Metric | string | `"disk.numberWriteAveraged.average"` | |
| config.Metrics[2].Definition[3].Instances | string | `"*"` | |
| config.Metrics[2].Definition[3].Metric | string | `"net.throughput.contention.summation"` | |
| config.Metrics[2].ObjectType[0] | string | `"HostSystem"` | |
| config.Metrics[3].Definition[0].Instances | string | `"*"` | |
| config.Metrics[3].Definition[0].Metric | string | `"disk.capacity.latest"` | |
| config.Metrics[3].Definition[1].Instances | string | `"*"` | |
| config.Metrics[3].Definition[1].Metric | string | `"disk.used.latest"` | |
| config.Metrics[3].ObjectType[0] | string | `"Datastore"` | |
| config.RemoveHostDomainName | bool | `false` | |
| config.VCenters | list | `[]` | |
| cronjob.failedJobsHistoryLimit | int | `1` | |
| cronjob.schedule | string | `"* * * * *"` | |
| cronjob.successfulJobsHistoryLimit | int | `3` | |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"nikdoof/vsphere-influxdb-go"` | |
| image.tag | string | `"latest"` | |
| influxdb.authenticated | bool | `false` | |
| influxdb.database | string | `"vmware_performance"` | |
| influxdb.hostname | string | `"http://influxdb:8086"` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| replicaCount | int | `1` | |
| resources | object | `{}` | |
| tolerations | list | `[]` | |
| vsphere.hostname | string | `nil` | |
| vsphere.password | string | `nil` | |
| vsphere.username | string | `nil` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

View File

@@ -0,0 +1,47 @@
# zigbee2mqttassistant
![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![AppVersion: 0.3.178](https://img.shields.io/badge/AppVersion-0.3.178-informational?style=flat-square)
A web GUI for Zigbee2Mqtt
**Homepage:** <https://github.com/yllibed/Zigbee2MqttAssistant>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| nikdoof | andy@tensixtyone.com | |
## Source Code
* <https://hub.docker.com/r/carldebilly/zigbee2mqttassistant>
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| TZ | string | `"UTC"` | |
| affinity | object | `{}` | |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"carldebilly/zigbee2mqttassistant"` | |
| image.tag | string | `"0.3.178"` | |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"chart-example.local"` | |
| ingress.hosts[0].paths | list | `[]` | |
| ingress.tls | list | `[]` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `1` | |
| resources | object | `{}` | |
| securityContext | object | `{}` | |
| service.port | int | `8800` | |
| service.type | string | `"ClusterIP"` | |
| tolerations | list | `[]` | |
| z2ma | object | `{}` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)