From 1e001aaeb54c3ba11bbdaac6dfe24e7e11880f45 Mon Sep 17 00:00:00 2001 From: aatarasoff Date: Thu, 7 Dec 2023 12:42:42 +0300 Subject: [PATCH] update docs --- README.md | 104 +++++++++++++++++++++++++++++------------------------- 1 file changed, 56 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 23f1907..e5f2dd6 100644 --- a/README.md +++ b/README.md @@ -29,54 +29,62 @@ helm install my-pbuf-registry pbuf/pbuf-registry ## Configuration The following table lists the configurable parameters of the `pbuf-registry` chart and their default values. -| Parameter | Description | Default | -|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| -| `replicaCount` | Number of replicas | `2` | -| `image.repository` | The image repository to pull from | `ghcr.io/pbufio/registry` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `image.tag` | Overrides the image tag whose default is the chart `appVersion`. | `""` | -| `imagePullSecrets` | Specify docker-registry secret names as an array | `[]` | -| `nameOverride` | Override the app name | `""` | -| `fullnameOverride` | Override the fullname of the chart | `""` | -| `serviceAccount.create` | Specifies whether a service account should be created | `true` | -| `serviceAccount.automount` | Automatically mount a ServiceAccount's API credentials? | `true` | -| `serviceAccount.annotations` | Annotations to add to the service account | `{}` | -| `serviceAccount.name` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | `""` | -| `podAnnotations` | Annotations to add to the pod | `{}` | -| `podLabels` | Labels to add to the pod | `{}` | -| `podSecurityContext` | Security context for the pod | `{}` | -| `securityContext` | Security context for the container | `{}` | -| `service.type` | Type of service to create | `ClusterIP` | -| `service.http.port` | Service HTTP port | `8080` | -| `service.http.auth.enabled` | Service HTTP authentication enabled | `false` | -| `service.http.auth.type` | Service HTTP authentication type ("", static-token) | `""` | -| `service.grpc.port` | Service GRPC port | `6777` | -| `service.grpc.tls.enabled` | Service GRPC TLS enabled | `false` | -| `service.grpc.auth.enabled` | Service GRPC authentication enabled | `false` | -| `service.grpc.auth.type` | Service GRPC authentication type ("", static-token) | `""` | -| `service.debug.port` | Service debug port | `8082` | -| `secrets.create` | Specifies whether to create a secret | `true` | -| `secrets.databaseDSN` | The DSN for the database | `""` | -| `secrets.staticToken` | Static Token for `static-token` auth type | `""` | -| `secrets.grpcTlsCert` | TLS certificate for GRPC transport | `""` | -| `secrets.grpcTlsKey` | TLS private key for GRPC transport | `""` | -| `secrets.eso.create` | Specifies whether to create resources for external secrets operator | `false` | -| `secrets.eso.secretStoreRefName` | The name reference to the secret store for ESO | `""` | -| `secrets.eso.remoteRefKey` | The key reference in the remote store for ESO | `""` | -| `secrets.eso.databaseDSNProperty` | The property name for the DSN in the ESO | `""` | -| `secrets.eso.serverStaticTokenProperty` | The property name for the static token | `""` | -| `secrets.eso.serverGrpcTlsCertFileProperty` | The property name for the TLS certificate | `""` | -| `secrets.eso.serverGrpcTlsKeyFileProperty` | The property name for the TLS private key | `""` | -| `ingress.enabled` | Enable ingress controller resource | `false` | -| `ingress.className` | Ingress class name | `""` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.hosts` | Ingress accepted hostnames | `[{"host": "chart-example.local", "paths": [{"path": "/", "pathType": "ImplementationSpecific"}]}]` | -| `ingress.tls` | Ingress TLS settings | `[]` | -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Tolerations for pod assignment | `[]` | -| `affinity` | Map of node/pod affinities | `{}` | -| `customSidecarContainers` | List of custom sidecar containers | `[]` | +| Parameter | Description | Default | +|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| `replicaCount` | Number of replicas | `2` | +| `image.repository` | The image repository to pull from | `ghcr.io/pbufio/registry` | +| `image.pullPolicy` | Image pull policy | `IfNotPresent` | +| `image.tag` | Overrides the image tag whose default is the chart `appVersion`. | `""` | +| `imagePullSecrets` | Specify docker-registry secret names as an array | `[]` | +| `nameOverride` | Override the app name | `""` | +| `fullnameOverride` | Override the fullname of the chart | `""` | +| `serviceAccount.create` | Specifies whether a service account should be created | `true` | +| `serviceAccount.automount` | Automatically mount a ServiceAccount's API credentials? | `true` | +| `serviceAccount.annotations` | Annotations to add to the service account | `{}` | +| `serviceAccount.name` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | `""` | +| `podAnnotations` | Annotations to add to the pod | `{}` | +| `podLabels` | Labels to add to the pod | `{}` | +| `podSecurityContext` | Security context for the pod | `{}` | +| `securityContext` | Security context for the container | `{}` | +| `service.type` | Type of service to create | `ClusterIP` | +| `service.http.port` | Service HTTP port | `8080` | +| `service.http.auth.enabled` | Service HTTP authentication enabled | `false` | +| `service.http.auth.type` | Service HTTP authentication type ("", static-token) | `""` | +| `service.grpc.port` | Service GRPC port | `6777` | +| `service.grpc.tls.enabled` | Service GRPC TLS enabled | `false` | +| `service.grpc.auth.enabled` | Service GRPC authentication enabled | `false` | +| `service.grpc.auth.type` | Service GRPC authentication type ("", static-token) | `""` | +| `service.debug.port` | Service debug port | `8082` | +| `secrets.create` | Specifies whether to create a secret | `true` | +| `secrets.databaseDSN` | The DSN for the database | `""` | +| `secrets.staticToken` | Static Token for `static-token` auth type | `""` | +| `secrets.grpcTlsCert` | TLS certificate for GRPC transport | `""` | +| `secrets.grpcTlsKey` | TLS private key for GRPC transport | `""` | +| `secrets.eso.create` | Specifies whether to create resources for external secrets operator | `false` | +| `secrets.eso.secretStoreRefName` | The name reference to the secret store for ESO | `""` | +| `secrets.eso.remoteRefKey` | The key reference in the remote store for ESO | `""` | +| `secrets.eso.databaseDSNProperty` | The property name for the DSN in the ESO | `""` | +| `secrets.eso.serverStaticTokenProperty` | The property name for the static token | `""` | +| `secrets.eso.serverGrpcTlsCertFileProperty` | The property name for the TLS certificate | `""` | +| `secrets.eso.serverGrpcTlsKeyFileProperty` | The property name for the TLS private key | `""` | +| `ingress.enabled` | Enable ingress controller resource | `false` | +| `ingress.className` | Ingress class name | `""` | +| `ingress.annotations` | Ingress annotations | `{}` | +| `ingress.hosts` | Ingress accepted hostnames | `[{"host": "chart-example.local", "paths": [{"path": "/", "pathType": "ImplementationSpecific"}]}]` | +| `ingress.tls` | Ingress TLS settings | `[]` | +| `resources` | CPU/Memory resource requests/limits | `{}` | +| `nodeSelector` | Node labels for pod assignment | `{}` | +| `tolerations` | Tolerations for pod assignment | `[]` | +| `affinity` | Map of node/pod affinities | `{}` | +| `customSidecarContainers` | List of custom sidecar containers | `[]` | +| `background.compaction.enabled` | Enable background compaction | `true` | +| `background.compaction.resources` | CPU/Memory resource requests/limits for background compaction | `{}` | +| `background.compaction.command` | Command to run for background compaction | `/app/pbuf-registry` | +| `background.compaction.args` | Arguments to pass to the background compaction command | `["compaction"]` | +| `background.protoparser.enabled` | Enable background proto parsing | `true` | +| `background.protoparser.resources` | CPU/Memory resource requests/limits for background proto parsing | `{}` | +| `background.protoparser.command` | Command to run for background proto parsing | `/app/pbuf-registry` | +| `background.protoparser.args` | Arguments to pass to the background proto parsing command | `["proto-parsing"]` | ## Uninstalling the Chart To uninstall/delete the my-pbuf-registry deployment: