11### KubeDash
22
3- ![ Version: 3.1 .0] ( https://img.shields.io/badge/Version-3.1 .0-informational?style=for-the-badge )
3+ ![ Version: 4.0 .0] ( https://img.shields.io/badge/Version-4.0 .0-informational?style=for-the-badge )
44![ Type: application] ( https://img.shields.io/badge/Type-application-informational?style=for-the-badge )
5- ![ AppVersion: 3.1 .0] ( https://img.shields.io/badge/AppVersion-3.1 .0-informational?style=for-the-badge )
5+ ![ AppVersion: 4.0 .0] ( https://img.shields.io/badge/AppVersion-4.0 .0-informational?style=for-the-badge )
66
77![ Alpine Linux 3.15.0] ( https://img.shields.io/badge/alpine_linux_3.15.0-0D597F?style=for-the-badge&logo=alpine-linux&logoColor=white )
88![ Helm] ( https://img.shields.io/badge/helm-0F1689?style=for-the-badge&logo=helm&logoColor=white )
@@ -29,13 +29,27 @@ The following tables lists configurable parameters of the KubeDash chart and the
2929| cluster.apiUrl | string | ` "https://kubernetes.mydomain.intra:6443" ` | k8s api url |
3030| cluster.name | string | ` "k8s-cluster" ` | k8s api url |
3131| containerSecurityContext | object | ` {"allowPrivilegeEscalation":false,"capabilities":{"drop":["all"]}} ` | list of the container's SecurityContexts |
32- | externalDatabase | object | ` {"database":"kubedash","enabled":false,"host":"","password":"kubedash-pass","port":5432,"secret":{"name":"kubedash-postgresql","useExistingSecret":false},"username":"kubedash-user"} ` | enable external postgresql support |
32+ | createClusterRole | bool | ` true ` | Enable ClusterRole creation. Disable if the role already exists. |
33+ | dbui | object | ` {"image":{"plugins":"tables-filter,adminer-auto-login","pullPolicy":"IfNotPresent","repository":"sosedoff/pgweb","tag":"latest"}} ` | deploy ui for db |
34+ | dbui.image.plugins | string | ` "tables-filter,adminer-auto-login" ` | adminer plugins |
35+ | dbui.image.pullPolicy | string | ` "IfNotPresent" ` | adminer image pull policy |
36+ | dbui.image.repository | string | ` "sosedoff/pgweb" ` | adminer image |
37+ | dbui.image.tag | string | ` "latest" ` | adminer image tag |
38+ | externalDatabase | object | ` {"database":"kubedash","enabled":false,"host":"","password":"kubedash","port":5432,"secret":{"name":"kubedash-postgresql","useExistingSecret":false},"username":"kubedash"} ` | enable external postgresql support |
39+ | externalDatabase.database | string | ` "kubedash" ` | External postgresql database |
40+ | externalDatabase.enabled | bool | ` false ` | Enable external postgresql |
41+ | externalDatabase.host | string | ` "" ` | External postgresql host |
42+ | externalDatabase.password | string | ` "kubedash" ` | External postgresql password |
43+ | externalDatabase.port | int | ` 5432 ` | External postgresql port |
3344| externalDatabase.secret.name | string | ` "kubedash-postgresql" ` | Name of the secret storing EXTERNAL_DATABASE_PASSWORD. |
3445| externalDatabase.secret.useExistingSecret | bool | ` false ` | Secret must provide the following variables: EXTERNAL_DATABASE_PASSWORD. |
46+ | externalDatabase.username | string | ` "kubedash" ` | External postgresql username |
3547| flaskConfig | string | ` "production" ` | flask environment: production or development |
3648| image.pullPolicy | string | ` "Always" ` | The docker image pull policy |
3749| image.repository | string | ` "devopstales/kubedash" ` | The docker image repository to use |
38- | image.tag | string | ` "2.0.0" ` | The docker image tag to use |
50+ | image.statsdExporter.repository | string | ` "prom/statsd-exporter" ` | The docker image repository to use |
51+ | image.statsdExporter.tag | string | ` "v0.22.4" ` | The docker image tag to use |
52+ | image.tag | string | ` "3.1.0" ` | The docker image tag to use |
3953| imagePullSecrets | list | ` [] ` | pullsecrets |
4054| ingress.annotations | object | ` {"nginx.ingress.kubernetes.io/proxy-body-size":"10m","nginx.ingress.kubernetes.io/proxy-read-timeout":"3600","nginx.ingress.kubernetes.io/proxy-send-timeout":"3600","nginx.ingress.kubernetes.io/server-snippets":"location / {\n proxy_set_header Upgrade $http_upgrade;\n proxy_http_version 1.1;\n proxy_set_header X-Forwarded-Host $http_host;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header X-Forwarded-For $remote_addr;\n proxy_set_header Host $host;\n proxy_set_header Connection \"upgrade\";\n proxy_cache_bypass $http_upgrade;\n}\n"} ` | Extra annotation to the Ingress object |
4155| ingress.className | string | ` "nginx" ` | Ingress class name |
@@ -48,6 +62,20 @@ The following tables lists configurable parameters of the KubeDash chart and the
4862| ingress.whitelist.enabled | bool | ` false ` | Enable ip blocking on ingress |
4963| ingress.whitelist.ips | list | ` [] ` | List of ips to allow communication |
5064| logLevel | string | ` "INFO" ` | Log level |
65+ | metrics.enabled | bool | ` true ` | Enable metrics |
66+ | metrics.grafana.annotations.grafana_folder | string | ` "KubeDash" ` | |
67+ | metrics.grafana.enabled | bool | ` true ` | Enable grafana dashboard deploy |
68+ | metrics.grafana.labels.grafana_dashboard | string | ` "1" ` | |
69+ | metrics.grafana.namespace | string | ` "monitoring-system" ` | Grafana dashboard namespace |
70+ | metrics.serviceMonitor.annotations | object | ` {} ` | Prometheus service monitor annotations |
71+ | metrics.serviceMonitor.enabled | bool | ` false ` | Enable prometheus service monitor |
72+ | metrics.serviceMonitor.honorLabels | object | ` {} ` | |
73+ | metrics.serviceMonitor.interval | string | ` "30s" ` | Prometheus service monitor interval |
74+ | metrics.serviceMonitor.jobLabel | object | ` {} ` | Prometheus service monitor job labels |
75+ | metrics.serviceMonitor.labels | object | ` {"release":"kube-prometheus-stack"} ` | Prometheus service monitor labels |
76+ | metrics.serviceMonitor.metricRelabelings | list | ` [] ` | |
77+ | metrics.serviceMonitor.relabelings | list | ` [] ` | |
78+ | metrics.serviceMonitor.scrapeTimeout | string | ` "10s" ` | Prometheus service monitor scrape timeout |
5179| metricsServer | object | ` {"args":["--kubelet-preferred-address-types=InternalIP","--kubelet-insecure-tls"],"enabled":false} ` | enable metrics-server |
5280| nodeSelector | object | ` {} ` | Set nodeSelector for the pod |
5381| oidc | object | ` {"enabled":false,"provider":{"oidcClientId":"","oidcScopes":"openid email","oidcSecret":"","oidcUrl":"https://sso.mydomain.intra/auth/realms/k8s"},"secret":{"name":"kubedash-oidc","useExistingSecret":false}} ` | oidc connection information |
@@ -58,18 +86,40 @@ The following tables lists configurable parameters of the KubeDash chart and the
5886| oidc.provider.oidcUrl | string | ` "https://sso.mydomain.intra/auth/realms/k8s" ` | oidc issuer url |
5987| oidc.secret.name | string | ` "kubedash-oidc" ` | Name of the secret storing OIDC_CLIENT_ID and OIDC_SECRET. |
6088| oidc.secret.useExistingSecret | bool | ` false ` | Secret must provide the following variables: OIDC_CLIENT_ID and OIDC_SECRET. |
61- | persistence | object | ` {"accessMode":"ReadWriteOnce","annotations":{},"enabled":true,"size":"1Gi"} ` | enable persistence |
89+ | persistence | object | ` {"accessMode":"ReadWriteOnce","annotations":{},"enabled":true,"size":"1Gi","storageClass":"-" } ` | enable persistence |
6290| persistence.accessMode | string | ` "ReadWriteOnce" ` | Volumes mode |
6391| persistence.annotations | object | ` {} ` | Volumes annotations |
6492| persistence.enabled | bool | ` true ` | Volumes for the pod |
6593| persistence.size | string | ` "1Gi" ` | Volumes size |
66- | plugins | object | ` {"certManager":{"enabled":false},"externalLoadbalancer":{"enabled":false},"helmDashboard":{"enabled":true},"registryUi":{"enabled":false}} ` | enable plugins |
67- | plugins.certManager.enabled | bool | ` false ` | Enable helm dashboard plugin |
68- | plugins.externalLoadbalancer.enabled | bool | ` false ` | Enable external loadbalancer plugin |
94+ | plugins | object | ` {"certManager":{"enabled":true},"externalLoadbalancer":{"enabled":true},"flux":{"enabled":true},"helmDashboard":{"enabled":true},"registryUi":{"enabled":true}} ` | enable plugins |
95+ | plugins.certManager.enabled | bool | ` true ` | Enable helm dashboard plugin |
96+ | plugins.externalLoadbalancer.enabled | bool | ` true ` | Enable external loadbalancer plugin |
97+ | plugins.flux.enabled | bool | ` true ` | Enable flux plugin |
6998| plugins.helmDashboard.enabled | bool | ` true ` | Enable helm dashboard plugin |
70- | plugins.registryUi.enabled | bool | ` false ` | Enable registry UI plugin |
99+ | plugins.registryUi.enabled | bool | ` true ` | Enable registry UI plugin |
71100| podSecurityContext | object | ` {"fsGroup":10001,"fsGroupChangePolicy":"OnRootMismatch","runAsNonRoot":true,"runAsUser":10001} ` | list of the pos's SecurityContexts |
72- | postgresqlHa | object | ` {"enabled":false,"metrics":{"enabled":true,"serviceMonitor":{"enabled":false}},"persistence":{"enabled":true},"pgpool":{"adminPassword":"change-me","replicaCount":2},"postgresql":{"database":"kubedash","password":"kubedash-pass","postgresPassword":"change-me","repmgrPassword":"change-me","username":"kubedash-user"},"rbac":{"create":true}} ` | deploy HA postgresql |
101+ | postgresql | object | ` {"auth":{"database":"kubedash","password":"kubedash","postgresPassword":"change-me","replicationPassword":"change-me","username":"kubedash"},"enabled":true,"metrics":{"enabled":true,"serviceMonitor":{"enabled":false,"honorLabels":{},"jobLabel":{},"labels":{"release":"kube-prometheus-stack"}}},"primary":{"persistence":{"size":"10Gi"}},"rbac":{"create":true},"readReplicas":{"replicaCount":0},"securityContext":{"enabled":false},"shmVolume":{"chmod":{"enabled":false}},"volumePermissions":{"enabled":false,"securityContext":{"runAsUser":"auto"}}} ` | deploy postgresql |
102+ | postgresql.auth.database | string | ` "kubedash" ` | Postgresql database |
103+ | postgresql.auth.password | string | ` "kubedash" ` | Postgresql password |
104+ | postgresql.auth.postgresPassword | string | ` "change-me" ` | Postgresql postgres user password |
105+ | postgresql.auth.replicationPassword | string | ` "change-me" ` | Postgresql replication password |
106+ | postgresql.auth.username | string | ` "kubedash" ` | Postgresql username |
107+ | postgresql.enabled | bool | ` true ` | Enable postgresql |
108+ | postgresql.metrics.enabled | bool | ` true ` | Enable postgresql metrics |
109+ | postgresql.metrics.serviceMonitor.enabled | bool | ` false ` | Enable prometheus service monitor |
110+ | postgresql.metrics.serviceMonitor.jobLabel | object | ` {} ` | Set serviceMonitor labels |
111+ | postgresql.metrics.serviceMonitor.labels | object | ` {"release":"kube-prometheus-stack"} ` | Prometheus service monitor labels |
112+ | postgresql.readReplicas.replicaCount | int | ` 0 ` | Number of read replicas to create |
113+ | postgresql.securityContext.enabled | bool | ` false ` | Enable postgresql security context |
114+ | postgresql.shmVolume.chmod | object | ` {"enabled":false} ` | Enable postgresql shared memory volume |
115+ | postgresql.volumePermissions.enabled | bool | ` false ` | Enable init container to set permissions on data volume |
116+ | redis | object | ` {"architecture":"standalone","enabled":true,"metrics":{"enabled":true,"serviceMonitor":{"additionalLabels":{"release":"kube-prometheus-stack"},"enabled":false}}} ` | enable redis for caching |
117+ | redis.architecture | string | ` "standalone" ` | Redis cluster architecture |
118+ | redis.enabled | bool | ` true ` | Enable redis |
119+ | redis.metrics.enabled | bool | ` true ` | Enable redis metrics |
120+ | redis.metrics.serviceMonitor.additionalLabels | object | ` {"release":"kube-prometheus-stack"} ` | Prometheus service monitor namespace namespace: "monitoring" |
121+ | redis.metrics.serviceMonitor.enabled | bool | ` false ` | Enable prometheus service monitor |
122+ | redisui | object | ` {"image":{"pullPolicy":"Always","repository":"patrikx3/p3x-redis-ui","tag":"latest"},"resources":{}} ` | redis ui |
73123| replicas | int | ` 1 ` | replica number - for multiple replicas you need to enable externalDatabase support |
74124| route.annotations | object | ` {} ` | Extra annotation to the OpenShift Route object |
75125| route.enabled | bool | ` false ` | Enable OpenShift Route object creation |
0 commit comments