Files
helm-charts/charts/idrac6/README.md

133 lines
4.4 KiB
Markdown

# idrac6
![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![AppVersion: 0.5.0](https://img.shields.io/badge/AppVersion-0.5.0-informational?style=flat-square)
iDRAC 6 web interface and VNC proxy
**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/DomiStyle/docker-idrac6>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.k8s-at-home.com | common | 4.2.0 |
## TL;DR
```console
helm repo add nikdoof-helm-charts https://nikdoof.github.io/helm-charts/
helm repo update
helm install idrac6 nikdoof-helm-charts/idrac6
```
## Installing the Chart
To install the chart with the release name `idrac6`
```console
helm install idrac6 nikdoof-helm-charts/idrac6
```
## Uninstalling the Chart
To uninstall the `idrac6` deployment
```console
helm uninstall idrac6
```
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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install idrac6 \
--set env.IDRAC_HOST="idrac"\
nikdoof-helm-charts/idrac6
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install idrac6 nikdoof-helm-charts/idrac6 -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/library-charts/tree/main/charts/stable/common)
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| 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_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 |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
| persistence.app | object | See values.yaml | allows caching of the required JARs in persistent storage, and allows for quicker connections. |
| persistence.screenshots | object | See values.yaml | Screenshots took from the iDRAC client. |
| persistence.vmedia | object | See values.yaml | Virtual media that can be connected to the iDRAC. |
| service | object | See values.yaml | Configures service settings for the chart. |
## 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/library-charts/tree/main/charts/stable/common#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.1]
#### Added
- N/A
#### Changed
- Remove default Env values to allow for better overriding with secrets.
#### Removed
- N/A
### [1.0.0]
#### Added
- N/A
#### Changed
- Switched to the [k8s-at-home](https://docs.k8s-at-home.com/) common chart as a base.
#### Removed
- N/A
[1.0.0]: #100
## Support
- Open an [issue](https://github.com/nikdoof/helm-charts/issues/new/choose)
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)