This is an automated email from the ASF dual-hosted git repository.
tokers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-helm-chart.git
The following commit(s) were added to refs/heads/master by this push:
new 6640c30 feat(apisix-dashboard): add etcd prefix (#215)
6640c30 is described below
commit 6640c3048f981a248e5c543558d785c7a5ee2918
Author: Gallardot <[email protected]>
AuthorDate: Wed Jan 19 09:03:12 2022 +0800
feat(apisix-dashboard): add etcd prefix (#215)
---
charts/apisix-dashboard/README.md | 78 +++++++++++++++++++++---
charts/apisix-dashboard/templates/configmap.yaml | 1 +
charts/apisix-dashboard/values.yaml | 2 +
3 files changed, 74 insertions(+), 7 deletions(-)
diff --git a/charts/apisix-dashboard/README.md
b/charts/apisix-dashboard/README.md
index 1dedf99..7985901 100644
--- a/charts/apisix-dashboard/README.md
+++ b/charts/apisix-dashboard/README.md
@@ -48,10 +48,74 @@ helm upgrade [RELEASE_NAME] [CHART] --install
_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command
documentation._
-## Configuration
-
-See [Customizing the Chart Before
Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
To see all configurable options with detailed comments, visit the chart's
[values.yaml](./values.yaml), or run these configuration commands:
-
-```console
-helm show values apisix/apisix-dashboard
-```
+## Parameters
+
+The following tables lists the configurable parameters of the apisix-dashboard
chart and their default values per section/component:
+
+### Common parameters
+
+| Name | Description
| Value |
+| ------------------ |
---------------------------------------------------------------------------------------
| --------------- |
+| `nameOverride` | String to partially override apisix-dashboard.fullname
template (will maintain the release name) | `nil` |
+| `fullnameOverride` | String to fully override apisix-dashboard.fullname
template | `nil` |
+| `imagePullSecrets` | Docker registry secret names as an array | `[]` |
+| `image.repository` | Apache APISIX Dashboard image
repository |
`apache/apisix-dashboard` |
+| `image.tag` | Apache APISIX Dashboard image tag
(immutable tags are recommended) |
`2.10.1-alpine` |
+| `image.pullPolicy` | Apache APISIX Dashboard image pull
policy | `IfNotPresent`
|
+
+### Apache APISIX Dashboard configurable parameters
+
+| Name | Description
| Value |
+| ------------------------------------ |
-----------------------------------------------------------------------------------------
| --------------- |
+| `config.conf.listen.host` | The address on which the
`Manager API` should listen. The default value is 0.0.0.0, if want to specify,
please enable it. This value accepts IPv4, IPv6, and hostname.
| `0.0.0.0` |
+| `config.conf.listen.port` | The port on which the
`Manager API` should listen.
| `9000` |
+| `config.authentication.secert` | Secret for jwt token
generation | `secert` |
+| `config.authentication.expireTime` | JWT token expire time,
in second | `3600` |
+| `config.authentication.users` | Specifies username and
password for login `manager api`. | `[{username: admin, password: admin}]` |
+| `config.conf.etcd.endpoints` | Supports defining
multiple etcd host addresses for an etcd cluster
| `apisix-etcd:2379` |
+| `config.conf.etcd.prefix` | Apache APISIX config's
prefix in etcd, /apisix by default
| `/apisix` |
+| `config.conf.etcd.username` | Specifies etcd basic
auth username if enable etcd auth
| `~` |
+| `config.conf.etcd.password` | Specifies etcd basic
auth password if enable etcd auth
| `~` |
+| `config.conf.log.accessLog.filePath` | Access log path |
`/dev/stdout` |
+| `config.conf.log.errorLog.filePath` | Error log path |
`/dev/stderr` |
+| `config.conf.log.errorLog.level` | Error log level.
Supports levels, lower to higher: debug, info, warn, error, panic, fatal |
`warn` |
+
+
+
+### Deployment parameters
+
+| Name | Description
| Value |
+| ------------------------------------ |
-----------------------------------------------------------------------------------------
| --------------- |
+| `replicaCount` | Number of Apache APISIX Dashboard
nodes | `1`
|
+| `podAnnotations` | Apache APISIX Dashboard Pod
annotations |
`{}` |
+| `nodeSelector` | Node labels for pod assignment
| `{}` |
+| `tolerations` | Tolerations for pod assignment
| `[]` |
+| `resources.limits` | The resources limits for Apache
APISIX Dashboard containers |
`{}` |
+| `resources.requests` | The requested resources for Apache
APISIX Dashboardcontainers | `{}`
|
+| `podSecurityContext` | Set the securityContext for Apache
APISIX Dashboard pods | `{}`
|
+| `securityContext` | Set the securityContext for Apache
APISIX Dashboard container | `{}`
|
+| `autoscaling.enabled` | Enable autoscaling for Apache
APISIX Dashboard deployment |
`false` |
+| `autoscaling.minReplicas` | Minimum number of replicas to
scale back | `1` |
+| `autoscaling.maxReplicas` | Maximum number of replicas to
scale out | `100` |
+| `autoscaling.targetCPUUtilizationPercentage` | Target CPU
utilization percentage
| `80` |
+| `autoscaling.targetMemoryUtilizationPercentage` | Target Memory
utilization percentage |
`nil` |
+
+
+### Traffic Exposure parameters
+
+| Name | Description
| Value
|
+| ------------------------------- |
------------------------------------------------------------------------------------------------------
| ------------------------ |
+| `service.type` | Service type
| `ClusterIP`
|
+| `service.port` | Service HTTP port
| `80`
|
+| `ingress.enabled` | Set to true to enable ingress record
generation | `false`
|
+| `ingress.annotations` | Ingress annotations
| `{}`
|
+| `ingress.hosts` | The list of hostnames to be covered with this
ingress record. | `[]` |
+| `ingress.tls` | Create TLS Secret
| `false`
|
+
+### RBAC parameters
+
+| Name | Description
| Value
|
+| ---------------------------- |
---------------------------------------------------------------------------------------------------------------------
| ------ |
+| `serviceAccount.create` | Specifies whether a ServiceAccount should be
created |
`true` |
+| `serviceAccount.name` | The name of the ServiceAccount to use. If not
set and create is true, a name is generated using the fullname template | `nil`
|
+| `serviceAccount.annotations` | Annotations to add to the ServiceAccount
Metadata |
`{}` |
\ No newline at end of file
diff --git a/charts/apisix-dashboard/templates/configmap.yaml
b/charts/apisix-dashboard/templates/configmap.yaml
index 3836e8b..c40823f 100644
--- a/charts/apisix-dashboard/templates/configmap.yaml
+++ b/charts/apisix-dashboard/templates/configmap.yaml
@@ -30,6 +30,7 @@ data:
port: {{ .listen.port }}
{{- with .etcd }}
etcd:
+ prefix: {{ .prefix | quote }}
endpoints:
{{- range .endpoints }}
- {{ . }}
diff --git a/charts/apisix-dashboard/values.yaml
b/charts/apisix-dashboard/values.yaml
index e28b2c7..8505d34 100644
--- a/charts/apisix-dashboard/values.yaml
+++ b/charts/apisix-dashboard/values.yaml
@@ -61,6 +61,8 @@ config:
# Supports defining multiple etcd host addresses for an etcd cluster
endpoints:
- apisix-etcd:2379
+ # apisix configurations prefix
+ prefix: "/apisix"
# Etcd basic auth info
username: ~
password: ~
