|
| 1 | +# Kubectyl Panel And Kuber Helm Chart |
| 2 | + |
| 3 | +## Configuration |
| 4 | + |
| 5 | +### Global Values |
| 6 | + |
| 7 | +| Key | Type | Default | Description | |
| 8 | +| :--: | :-----------------: | :-----: | ----------- | |
| 9 | +| `global.timezone` | `string` | `UTC` | Timezone for the panel. | |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +### Ingress |
| 14 | + |
| 15 | +| Key | Type | Default | Description | |
| 16 | +| :--: | :-----------------: | :-----: | ----------- | |
| 17 | +| `ingress.class` | `string` | `nginx` | The Ingress class for routing external traffic to services. | |
| 18 | +| `ingress.panel` | `string` | `panel.example.com` | The full FQDN that your panel will be accessible at. | |
| 19 | +| `ingress.kuber` | `string` | `kuber.example.com` | The full FQDN that the kuber daemon will be accessible at. | |
| 20 | +| `ingress.tls.create` | `bool` | `true` | Boolean to control if the chart should manage the creation of the Certificate resources. This is particularly useful if you have automation around Ingress resources that creates Certificates already. | |
| 21 | +| `ingress.tls.clusterIssuer` | `string` | `letsencrypt-prod` | Name of the ClusterIssuer that should be specified on the Ingress resources to create your certificate. Required for most configurations even if not managing the certificate in this chart. | |
| 22 | +| `ingress.annotations` | `map(string\|int\|bool)` | `{}` | Map of additional annotations to add to the Ingress resources. | |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +### Panel |
| 27 | + |
| 28 | +| Key | Type | Default | Description | |
| 29 | +| :--: | :-----------------: | :-----: | ----------- | |
| 30 | +| `panel.image` | `string` | `quay.io/kubectyl/panel:develop` | The image for the Panel application container. | |
| 31 | +| `panel.storageClass` | `string` | `""` | The storage class to use for panel's persistent volume. To use default K8s storage class set this value to "". **This is mutually exclusive with `existingVolumeClaim` and should not be used with it.** | |
| 32 | +| `panel.existingVolumeClaim` | `string` | `""` | Name of existing volume claim resource to use for the pod volumes. **This is mutually exclusive with `storageClass` and should not be used with it.** | |
| 33 | +| `panel.email` | `string` | `abc@example.com` | The email address for Letsencrypt. Used for panel only as a reference to enable cert-manager. | |
| 34 | +| `panel.serviceAnnotations` | `map(string\|int\|bool)` | `{}` | Map of additional annotations to add to the panel's Service resource. | |
| 35 | +| `panel.statefulSetAnnotations` | `map(string\|int\|bool)` | `{}` | Map of additional annotations to add to the panel's StatefulSet resource. | |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +### Kuber |
| 40 | + |
| 41 | +| Key | Type | Default | Description | |
| 42 | +| :--: | :-----------------: | :-----: | ----------- | |
| 43 | +| `kuber.image` | `string` | `quay.io/kubectyl/kuber:deveop` | The image for the Kuber application container. | |
| 44 | +| `kuber.replicaCount` | `int` | `0` | Set to 0. Will be automatically set to 1 by panel after installation. | |
| 45 | +| `kuber.serviceAnnotations` | `map(string\|int\|bool)` | `{}` | Map of additional annotations to add to kuber's Service resource. | |
| 46 | +| `kuber.deploymentAnnotations` | `map(string\|int\|bool)` | `{}` | Map of additional annotations to add to kuber's Deployment resource. | |
| 47 | + |
| 48 | +--- |
| 49 | + |
| 50 | +### MariaDB |
| 51 | + |
| 52 | +| Key | Type | Default | Description | |
| 53 | +| :--: | :-----------------: | :-----: | ----------- | |
| 54 | +| `mariadb.create` | `bool` | `true` | Boolean to control creation of mariadb chart resources. Useful if you plan on using an external mariadb instance. | |
| 55 | +| `mariadb.global.storageClass` | `string` | `""` | The storage class to use for mariadb's persistent volume. To use default K8s storage class set this value to "". | |
| 56 | +| `mariadb.externalHost` | `string` | `""` | Hostname of external mariadb instance if you intend to use one. If using built-in mariadb chart, leave this blank or don't include it at all. | |
| 57 | +| `mariadb.volumePermissions.enabled` | `bool` | `true` | Enable init container that changes the owner and group of the persistent volume(s) mountpoint to `runAsUser:fsGroup`. | |
| 58 | +| `mariadb.image.debug` | `bool` | `true` | Boolean to control if debug logs should be enabled. | |
| 59 | +| `mariadb.auth.database` | `string` | `panel` | Name of mariadb database to use for panel installation. | |
| 60 | +| `mariadb.auth.username` | `string` | `kubectyl` | User to authenticate to mariadb with. | |
| 61 | +| `mariadb.auth.password` | `string` | `SecretPassword` | Password for user `mariadb.auth.username`. | |
| 62 | +| `mariadb.auth.rootPassword` | `string` | `SuperSecretPassword` | If creating host with chart, password to use for `root` user upon creation. | |
| 63 | +| `mariadb.primary.persistence.size` | `(int)Gi` | `1Gi` | The size of the primary mariadb pod's persistent volume. | |
| 64 | +| `mariadb.secondary.replicaCount` | `int` | `0` | The number of mariadb replicas to create. | |
| 65 | + |
| 66 | +For more in-depth explanation of the configuration and additional options you can specify to the `mariadb` chart, please see [Bitnami's documentation](https://github.com/bitnami/charts/tree/main/bitnami/mariadb). |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +### Redis |
| 71 | + |
| 72 | +| Key | Type | Default | Description | |
| 73 | +| :--: | :-----------------: | :-----: | ----------- | |
| 74 | +| `redis.create` | `bool` | `true` | Boolean to control creation of redis chart resources. Useful if you plan on using an external redis instance. | |
| 75 | +| `redis.global.storageClass` | `string` | `""` | The storage class to use for the redis persistent volume. To use default K8s storage class set this value to "". | |
| 76 | +| `redis.externalHost` | `string` | `""` | Hostname of external redis instance if you intend to use one. If using built-in redis chart, leave this blank or don't include it at all. | |
| 77 | +| `redis.auth.enabled` | `bool` | `false` | Boolean to control whether we should try to authenticate when connecting to redis. | |
| 78 | +| `redis.auth.password` | `string` | `""` | Password to use for redis authentication. | |
| 79 | +| `redis.master.persistence.size` | `(int)Gi` | `1Gi` | The size of the master redis pod's persistent volume. | |
| 80 | +| `redis.secondary.replicaCount` | `int` | `0` | The number of redis replicas to create. | |
| 81 | +| `redis.sentinel.enabled` | `bool` | `false` | Boolean to enable redis sentinel for high availability. | |
| 82 | + |
| 83 | +For more in-depth explanation of the configuration and additional options you can specify to the `redis` chart, please see [Bitnami's documentation](https://github.com/bitnami/charts/tree/main/bitnami/redis). |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +### Service Account |
| 88 | + |
| 89 | +| Key | Type | Default | Description | |
| 90 | +| :--: | :-----------------: | :-----: | ----------- | |
| 91 | +| `serviceAccount.create` | `bool` | `true` | Boolean to enable the creation of a service account for our services. | |
| 92 | +| `serviceAccount.name` | `string` | `""` | Name of service account to create. If not set, a name is generated. | |
| 93 | + |
| 94 | + |
0 commit comments