From a284f91fbd0f9d97da1fa2141a424bac963481c8 Mon Sep 17 00:00:00 2001 From: yinheli Date: Sat, 3 Aug 2024 13:33:11 +0800 Subject: [PATCH] chore(typo): fix (#1375) --- README.md | 12 ++++++------ charts/clickhouse/README.md | 28 ++++++++++++++-------------- charts/sentry/CHANGELOG.md | 6 +++--- charts/sentry/README.md | 4 ++-- 4 files changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 456307871..6e93c809e 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ mode. This change requires action on your part to ensure a smooth upgrade. 7. **(Optional)** If you would like to switch to a non-dedicated cluster, set **'controller.controllerOnly=false'**. This will cause controller-only nodes to switch to controller+broker nodes. At this point, you could manually decommission broker-only nodes by reassigning its partitions to controller-eligible nodes. - + For more information about decommissioning a Kafka broker, check the official documentation. ## Upgrading from 20.x.x version of this Chart to 21.x.x @@ -131,7 +131,7 @@ kafka: ## Upgrading from 18.x.x version of this Chart to 19.x.x -Chart dependencies has been upgraded because of sentry requirements. +Chart dependencies has been upgraded because of sentry requirements. Changes: - The minimum required version of Postgresql is 14.5 (works with 15.x too) @@ -141,7 +141,7 @@ Bumped dependencies: ## Upgrading from 17.x.x version of this Chart to 18.x.x -If Kafka is complaining about unknown or missing topic, please connect to kafka-0 and run +If Kafka is complaining about unknown or missing topic, please connect to kafka-0 and run `/opt/bitnami/kafka/bin/kafka-topics.sh --create --topic ingest-replay-recordings --bootstrap-server localhost:9092` @@ -150,7 +150,7 @@ If Kafka is complaining about unknown or missing topic, please connect to kafka- Sentry version from 22.10.0 onwards should be using chart 17.x.x -- post process forwarder events and transactions topics are splitted in Sentry 22.10.0 +- post process forwarder events and transactions topics are split in Sentry 22.10.0 You can delete the deployment "sentry-post-process-forward" as it's no longer needed. @@ -167,7 +167,7 @@ See https://github.com/sentry-kubernetes/charts/tree/develop/sentry#sentry-secre ## Upgrading from 14.x.x version of this Chart to 15.x.x -Chart dependencies has been upgraded because of bitnami charts removal. +Chart dependencies has been upgraded because of bitnami charts removal. Changes: - `nginx.service.port: 80` > `nginx.service.ports.http: 80` - `kafka.service.port` > `kafka.service.ports.client` @@ -246,7 +246,7 @@ clickhouse.clickhouse.configmap.remote_servers.replica.backup ## Upgrading from 4.x.x version of this Chart to 5.0.0 -As Relay is now part of this chart your need to make sure you enable either Nginx or the Ingress. Please read the next paragraph for more informations. +As Relay is now part of this chart your need to make sure you enable either Nginx or the Ingress. Please read the next paragraph for more information. If you are using an ingress gateway (like istio), you have to change your inbound path from sentry-web to nginx. diff --git a/charts/clickhouse/README.md b/charts/clickhouse/README.md index 913b53eb0..9c608cb22 100755 --- a/charts/clickhouse/README.md +++ b/charts/clickhouse/README.md @@ -68,14 +68,14 @@ The following tables lists the configurable parameters of the Clickhouse chart a | `clickhouse.readinessProbe.successThreshold` | Minimum consecutive failures for the probe | `1` | |`clickhouse.resources` | The resource requests and limits for Clickhouse pods |`{}` | | `clickhouse.persistentVolumeClaim.enabled` | Enable persistence using a `PersistentVolumeClaim` | `false` | -| `clickhouse.persistentVolumeClaim.dataPersistentVolume.enabled` | Turn on and off dataPersistentVolume | `false` | -| `clickhouse.persistentVolumeClaim.dataPersistentVolume.accessModes` | Persistent Volume Access Modes | `[ReadWriteOnce]` | -| `clickhouse.persistentVolumeClaim.dataPersistentVolume.storageClassName` | Persistent Volume Storage Class | `` | -| `clickhouse.persistentVolumeClaim.dataPersistentVolume.storage` | Persistent Volume Size | `500Gi` | -| `clickhouse.persistentVolumeClaim.logsPersistentVolume.enabled` | Turn on and off dataPersistentVolume | `false` | -| `clickhouse.persistentVolumeClaim.logsPersistentVolume.accessModes` | Persistent Volume Access Modes | `[ReadWriteOnce]` | -| `clickhouse.persistentVolumeClaim.logsPersistentVolume.storageClassName` | Persistent Volume Storage Class | `` | -| `clickhouse.persistentVolumeClaim.logsPersistentVolume.storage` | Persistent Volume Size | `50Gi` | +| `clickhouse.persistentVolumeClaim.dataPersistentVolume.enabled` | Turn on and off dataPersistentVolume | `false` | +| `clickhouse.persistentVolumeClaim.dataPersistentVolume.accessModes` | Persistent Volume Access Modes | `[ReadWriteOnce]` | +| `clickhouse.persistentVolumeClaim.dataPersistentVolume.storageClassName` | Persistent Volume Storage Class | `` | +| `clickhouse.persistentVolumeClaim.dataPersistentVolume.storage` | Persistent Volume Size | `500Gi` | +| `clickhouse.persistentVolumeClaim.logsPersistentVolume.enabled` | Turn on and off dataPersistentVolume | `false` | +| `clickhouse.persistentVolumeClaim.logsPersistentVolume.accessModes` | Persistent Volume Access Modes | `[ReadWriteOnce]` | +| `clickhouse.persistentVolumeClaim.logsPersistentVolume.storageClassName` | Persistent Volume Storage Class | `` | +| `clickhouse.persistentVolumeClaim.logsPersistentVolume.storage` | Persistent Volume Size | `50Gi` | | `clickhouse.ingress.enabled` | Enable ingress | `false` | | `clickhouse.ingress.host` | Ingress host | `` | | `clickhouse.ingress.path` | Ingress path | `` | @@ -130,14 +130,14 @@ The following tables lists the configurable parameters of the Clickhouse chart a | `clickhouse.configmap.remote_servers.graphite.config[].events_cumulative` | Sending cumulative data from a :ref:system_tables-system.events table | `true` | | `clickhouse.configmap.remote_servers.graphite.config[].asynchronous_metrics` | Sending data from a :ref:system_tables-system.asynchronous_metrics table | `true` | | `clickhouse.configmap.profiles.enabled` | Enable a settings profiles | `false` | -| `clickhouse.configmap.profiles.profile[].name` | Tne name of a settings profile | `` | +| `clickhouse.configmap.profiles.profile[].name` | The name of a settings profile | `` | | `clickhouse.configmap.profiles.profile[].config` | The config of a settings profile | `{}` | | `clickhouse.configmap.users.enabled` | Enable a settings users | `false` | -| `clickhouse.configmap.users.user[].name` | Tne name of a settings user | `` | -| `clickhouse.configmap.users.user[].config` | Tne config of a settings user | `{}` | +| `clickhouse.configmap.users.user[].name` | The name of a settings user | `` | +| `clickhouse.configmap.users.user[].config` | The config of a settings user | `{}` | | `clickhouse.configmap.quotas.enabled` | Enable a settings quotas | `false` | -| `clickhouse.configmap.quotas.quota[].name` | Tne name of a settings quota | `` | -| `clickhouse.configmap.quotas.quota[].config[]` | Tne config of a settings quota | `[]` | +| `clickhouse.configmap.quotas.quota[].name` | The name of a settings quota | `` | +| `clickhouse.configmap.quotas.quota[].config[]` | The config of a settings quota | `[]` | | `tabix.enabled` | Enable tabix | `false` | | `tabix.replicas` | The instance number of Tabix | `1` | | `tabix.updateStrategy.type` | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate | `RollingUpdate` | @@ -145,7 +145,7 @@ The following tables lists the configurable parameters of the Clickhouse chart a | `tabix.updateStrategy.maxUnavailable` | The maximum number of pods that can be unavailable during the update | `1` | | `tabix.image` | Docker image name | `spoonest/clickhouse-tabix-web-client` | | `tabix.imageVersion` | Docker image version | `stable` | -| `tabix.imagePullPolicy` | Dcoker image pull policy | `IfNotPresent` | +| `tabix.imagePullPolicy` | Docker image pull policy | `IfNotPresent` | | `tabix.livenessProbe.enabled` | Turn on and off liveness probe | `true` | | `tabix.livenessProbe.initialDelaySeconds` | Delay before liveness probe is initiated | `30` | | `tabix.livenessProbe.periodSeconds` | How often to perform the probe | `30` | diff --git a/charts/sentry/CHANGELOG.md b/charts/sentry/CHANGELOG.md index ca190f9c1..7ffcbb148 100644 --- a/charts/sentry/CHANGELOG.md +++ b/charts/sentry/CHANGELOG.md @@ -252,7 +252,7 @@ * 9.0.0 ([d659dcb](https://github.com/sentry-kubernetes/charts/commit/d659dcbbea17eacf20653a6ca386ed233bd690f2)) * ability to use existingSecret for psql ([#148](https://github.com/sentry-kubernetes/charts/issues/148)) ([8c02d7a](https://github.com/sentry-kubernetes/charts/commit/8c02d7ae67c5fc0d161e739e9968b6d272acc259)) * add `existingSecret` param for Github ([#863](https://github.com/sentry-kubernetes/charts/issues/863)) ([8d43592](https://github.com/sentry-kubernetes/charts/commit/8d43592fe3f3a22e3189bd84995e5cecccd088be)) -* add podLables to Sentry hooks ([#659](https://github.com/sentry-kubernetes/charts/issues/659)) ([50b8f1e](https://github.com/sentry-kubernetes/charts/commit/50b8f1e8879e22dcf7d10035b64c8ffa2b7e41ae)) +* add podLabels to Sentry hooks ([#659](https://github.com/sentry-kubernetes/charts/issues/659)) ([50b8f1e](https://github.com/sentry-kubernetes/charts/commit/50b8f1e8879e22dcf7d10035b64c8ffa2b7e41ae)) * add pvc to clickhouse ([#50](https://github.com/sentry-kubernetes/charts/issues/50)) ([197930f](https://github.com/sentry-kubernetes/charts/commit/197930f1a29bbf038351fbc72d401297140fc857)) * add sentry cleanup cronjob ([#178](https://github.com/sentry-kubernetes/charts/issues/178)) ([ae42bc4](https://github.com/sentry-kubernetes/charts/commit/ae42bc4b4783f7515cf4e8620576568a6cb6ff5c)) * add service account names for cronjobs ([#681](https://github.com/sentry-kubernetes/charts/issues/681)) ([0bc212d](https://github.com/sentry-kubernetes/charts/commit/0bc212daf3a999019d035deaed979f157f69d8ad)) @@ -344,14 +344,14 @@ * django.security.csrf issue ([#155](https://github.com/sentry-kubernetes/charts/issues/155)) ([a680856](https://github.com/sentry-kubernetes/charts/commit/a680856c0208f4df626e05163f754442f59fca10)) * do not complete the user-create on error ([#58](https://github.com/sentry-kubernetes/charts/issues/58)) ([7b925fe](https://github.com/sentry-kubernetes/charts/commit/7b925feb8b0d28a2a47276ae666462d9107a4a9d)) * empty email values were crashing the pods ([#12](https://github.com/sentry-kubernetes/charts/issues/12)) ([5b6101f](https://github.com/sentry-kubernetes/charts/commit/5b6101fb0860ec0a8fff2dca86d1affc9b5d9656)) -* erroneous formating in relay configmap ([#203](https://github.com/sentry-kubernetes/charts/issues/203)) ([a42d41f](https://github.com/sentry-kubernetes/charts/commit/a42d41fe502c8a8e2394330cbf1c03eddc9d8d20)), closes [#202](https://github.com/sentry-kubernetes/charts/issues/202) +* erroneous formatting in relay configmap ([#203](https://github.com/sentry-kubernetes/charts/issues/203)) ([a42d41f](https://github.com/sentry-kubernetes/charts/commit/a42d41fe502c8a8e2394330cbf1c03eddc9d8d20)), closes [#202](https://github.com/sentry-kubernetes/charts/issues/202) * external db ([#34](https://github.com/sentry-kubernetes/charts/issues/34)) ([87bfc2c](https://github.com/sentry-kubernetes/charts/commit/87bfc2c7d2e2713ac0e5e39d6a7fca89ef32ba9a)) * external postgres host ([#41](https://github.com/sentry-kubernetes/charts/issues/41)) ([bc6f5ab](https://github.com/sentry-kubernetes/charts/commit/bc6f5ab62ec1fb43d6b63254f6e6493344365acd)) * Fix wrong service account for ingest-profiles deployment ([#966](https://github.com/sentry-kubernetes/charts/issues/966)) ([cead469](https://github.com/sentry-kubernetes/charts/commit/cead469eb418e8ae110f60c173ab0bb9f74e4cc3)) * force UTC on clickhouse ([545052d](https://github.com/sentry-kubernetes/charts/commit/545052d90bb26559293e185f3436a671fa4ec2d4)) * gcs filestore ([#18](https://github.com/sentry-kubernetes/charts/issues/18)) ([5249630](https://github.com/sentry-kubernetes/charts/commit/524963031fb29932992d166cb3ae06237c6cc19e)) * github secret extra quotation mark([#415](https://github.com/sentry-kubernetes/charts/issues/415)) ([44cea73](https://github.com/sentry-kubernetes/charts/commit/44cea735054165be3e613dc142e9eb6f4136b032)) -* Healthcheck for Relay backend was missing so when using .Values.ingress.regexPathStyle: gke will throw an error that templat is missing ([#612](https://github.com/sentry-kubernetes/charts/issues/612)) ([9da34de](https://github.com/sentry-kubernetes/charts/commit/9da34de847716a74fd7e6f347c5bc723f7f00bc5)) +* Healthcheck for Relay backend was missing so when using .Values.ingress.regexPathStyle: gke will throw an error that template is missing ([#612](https://github.com/sentry-kubernetes/charts/issues/612)) ([9da34de](https://github.com/sentry-kubernetes/charts/commit/9da34de847716a74fd7e6f347c5bc723f7f00bc5)) * hide content-disposition header on /static for Safari ([#1051](https://github.com/sentry-kubernetes/charts/issues/1051)) ([a688d20](https://github.com/sentry-kubernetes/charts/commit/a688d20687f4c24cf9dd9dd4d54dc108b6dba2c7)) * hpa names to make them unique ([#102](https://github.com/sentry-kubernetes/charts/issues/102)) ([ab9126a](https://github.com/sentry-kubernetes/charts/commit/ab9126a20e74b816e8473e08e4dcd6eacca4224b)) * image pull policy ([#184](https://github.com/sentry-kubernetes/charts/issues/184)) ([0175798](https://github.com/sentry-kubernetes/charts/commit/0175798cf9982daef6f28771ce2dc6f4c688ff8d)) diff --git a/charts/sentry/README.md b/charts/sentry/README.md index 3faf4ffea..666cd2536 100644 --- a/charts/sentry/README.md +++ b/charts/sentry/README.md @@ -71,7 +71,7 @@ Note: this table is incomplete, so have a look at the values.yaml in case you mi | `sentry.ingestConsumerEvents.enabled` | Enable Sentry ingest consumer events | `true` | | `sentry.ingestConsumerTransactions.enabled` | Enable Sentry ingest consumer transactions | `true` | | `sentry.ingestMonitors.enabled` | Enable Sentry ingest monitors | `true` | -| `sentry.ingestOccurrences.enabled` | Enable Sentry ingest occurences | `true` | +| `sentry.ingestOccurrences.enabled` | Enable Sentry ingest occurrences | `true` | | `sentry.ingestReplayRecordings.enabled` | Enable Sentry ingest replay recordings | `true` | | `sentry.metricsConsumer.enabled` | Enable Sentry metrics consumer | `true` | | `sentry.postProcessForwardErrors.enabled` | Enable Sentry post process forward errors | `true` | @@ -269,7 +269,7 @@ externalPostgresql: database: sentry ``` -> ⚠️ `.Values.externalPostgresql.existingSecretKey` is depricated, `.Values.externalPostgresql.existingSecretKeys.password` should be used instead. +> ⚠️ `.Values.externalPostgresql.existingSecretKey` is deprecated, `.Values.externalPostgresql.existingSecretKeys.password` should be used instead. # Usage