Skip to content

Commit 4577988

Browse files
committed
docs: Add more attributes and documentation
1 parent 30f8316 commit 4577988

File tree

2 files changed

+70
-2
lines changed

2 files changed

+70
-2
lines changed

charts/bonfire/Chart.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
apiVersion: v2
22
name: bonfire
3-
description: A Helm chart for Deploying bonfire on Kubernetes
3+
description: A Helm chart for deploying bonfire on Kubernetes
4+
home: https://bonfirenetworks.org/
5+
sources: ["https://github.com/sciety/bonfire-helm-chart/tree/main/charts/bonfire"]
46
type: application
5-
version: 0.1.0
7+
version: 0.1.1
68
appVersion: "1.0.0-rc.3.6"

charts/bonfire/README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# bonfire
2+
3+
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0-rc.3.6](https://img.shields.io/badge/AppVersion-1.0.0--rc.3.6-informational?style=flat-square)
4+
5+
A Helm chart for deploying bonfire on Kubernetes
6+
7+
**Homepage:** <https://bonfirenetworks.org/>
8+
9+
## Source Code
10+
11+
* <https://github.com/sciety/bonfire-helm-chart/tree/main/charts/bonfire>
12+
13+
## Values
14+
15+
| Key | Type | Default | Description |
16+
|-----|------|---------|-------------|
17+
| affinity | object | `{}` | |
18+
| autoscaling.enabled | bool | `false` | |
19+
| autoscaling.maxReplicas | int | `100` | |
20+
| autoscaling.minReplicas | int | `1` | |
21+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
22+
| extraEnv | object | `{}` | |
23+
| extraEnvFrom | list | `[]` | |
24+
| fullnameOverride | string | `""` | |
25+
| image.arch | string | `"amd64"` | |
26+
| image.flavour | string | `"social"` | |
27+
| image.pullPolicy | string | `"IfNotPresent"` | |
28+
| image.repository | string | `"bonfirenetworks/bonfire"` | |
29+
| image.version | string | `nil` | |
30+
| imagePullSecrets | list | `[]` | |
31+
| ingress.annotations | object | `{}` | |
32+
| ingress.className | string | `""` | |
33+
| ingress.enabled | bool | `false` | |
34+
| ingress.hosts[0].host | string | `"bonfire-test.local"` | |
35+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
36+
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
37+
| ingress.tls | list | `[]` | |
38+
| livenessProbe.httpGet.path | string | `"/dashboard"` | |
39+
| livenessProbe.httpGet.port | string | `"http"` | |
40+
| nameOverride | string | `""` | |
41+
| nodeSelector | object | `{}` | |
42+
| podAnnotations | object | `{}` | |
43+
| podLabels | object | `{}` | |
44+
| podSecurityContext | object | `{}` | |
45+
| postgres.db | string | `"postgres"` | |
46+
| postgres.host | string | `nil` | |
47+
| postgres.password | string | `"postgres"` | |
48+
| postgres.user | string | `"postgres"` | |
49+
| readinessProbe.httpGet.path | string | `"/dashboard"` | |
50+
| readinessProbe.httpGet.port | string | `"http"` | |
51+
| replicaCount | int | `1` | |
52+
| resources | object | `{}` | |
53+
| secrets.existingAppSecret | string | `nil` | |
54+
| securityContext | object | `{}` | |
55+
| service.port | int | `4000` | |
56+
| service.type | string | `"ClusterIP"` | |
57+
| serviceAccount.annotations | object | `{}` | |
58+
| serviceAccount.automount | bool | `true` | |
59+
| serviceAccount.create | bool | `true` | |
60+
| serviceAccount.name | string | `""` | |
61+
| tolerations | list | `[]` | |
62+
| volumeMounts | list | `[]` | |
63+
| volumes | list | `[]` | |
64+
65+
----------------------------------------------
66+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

0 commit comments

Comments
 (0)