From b29e968cb3ead9a208debc3b27088e3f29b6cdca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philippe=20No=C3=ABl?= <21990816+philippemnoel@users.noreply.github.com> Date: Wed, 25 Sep 2024 08:39:19 -0400 Subject: [PATCH] chore: Update README and Schema (#37) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Noël <21990816+philippemnoel@users.noreply.github.com> --- .github/workflows/tests-cluster-chainsaw.yaml | 10 +++++++++- README.md | 2 +- charts/paradedb/README.md | 6 +++--- charts/paradedb/README.md.gotmpl | 2 +- charts/paradedb/templates/NOTES.txt | 4 ++-- charts/paradedb/values.schema.json | 4 ++-- charts/paradedb/values.yaml | 2 ++ 7 files changed, 20 insertions(+), 10 deletions(-) diff --git a/.github/workflows/tests-cluster-chainsaw.yaml b/.github/workflows/tests-cluster-chainsaw.yaml index 297d7e0d5..3bb1198a0 100644 --- a/.github/workflows/tests-cluster-chainsaw.yaml +++ b/.github/workflows/tests-cluster-chainsaw.yaml @@ -7,13 +7,21 @@ on: jobs: test-cluster-chainsaw: - runs-on: ubuntu-22.04 + runs-on: depot-ubuntu-latest-8 steps: - name: Checkout uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 with: fetch-depth: 0 + # Added by ParadeDB: Authenticate to Docker Hub to avoid rate limits + - name: Login to Docker Hub + uses: docker/login-action@v3 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }} + + # Added by ParadeDB: Always pull the latest version of paradedb/paradedb - name: Set ParadeDB Version to Latest working-directory: charts/paradedb/ env: diff --git a/README.md b/README.md index d116adc70..b885da8f3 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ helm upgrade --install paradedb \ --namespace paradedb-database \ --create-namespace \ --values values.yaml \ -paradedb/cluster +paradedb/paradedb ``` Refer to the [CloudNativePG Cluster Chart documentation](charts/paradedb/README.md) for advanced configuration options. diff --git a/charts/paradedb/README.md b/charts/paradedb/README.md index 64d064c4c..e553893a6 100644 --- a/charts/paradedb/README.md +++ b/charts/paradedb/README.md @@ -1,4 +1,4 @@ -# CloudNativePG Cluster +# ParadeDB CloudNativePG Cluster This README documents the Helm chart for deploying and managing [ParadeDB](https://github.com/paradedb/paradedb) on Kubernetes via [CloudNativePG](https://cloudnative-pg.io/), including advanced settings. @@ -40,7 +40,7 @@ helm upgrade --install paradedb \ --namespace paradedb-database \ --create-namespace \ --values values.yaml \ -paradedb/cluster +paradedb/paradedb ``` A more detailed guide can be found in the [Getting Started docs](<./docs/Getting Started.md>). @@ -230,7 +230,7 @@ refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentat | recovery.secret.create | bool | `true` | Whether to create a secret for the backup credentials | | recovery.secret.name | string | `""` | Name of the backup credentials secret | | type | string | `"paradedb"` | Type of the CNPG database. Available types: * `paradedb` | -| version.paradedb | string | `"0.10.0"` | The ParadeDB version, set in the publish CI workflow from the latest paradedb/paradedb GitHub tag | +| version.paradedb | string | `"0.10.0"` | ParadeDB defaults to v0.10.0 for testing and local development | | version.postgresql | string | `"16"` | PostgreSQL major version to use | ## Maintainers diff --git a/charts/paradedb/README.md.gotmpl b/charts/paradedb/README.md.gotmpl index e79c99379..2c403782a 100644 --- a/charts/paradedb/README.md.gotmpl +++ b/charts/paradedb/README.md.gotmpl @@ -44,7 +44,7 @@ helm upgrade --install paradedb \ --namespace paradedb-database \ --create-namespace \ --values values.yaml \ -paradedb/cluster +paradedb/paradedb ``` A more detailed guide can be found in the [Getting Started docs](<./docs/Getting Started.md>). diff --git a/charts/paradedb/templates/NOTES.txt b/charts/paradedb/templates/NOTES.txt index 6a28fa592..e11cfeae8 100644 --- a/charts/paradedb/templates/NOTES.txt +++ b/charts/paradedb/templates/NOTES.txt @@ -1,7 +1,7 @@ {{ if .Release.IsInstall }} -The {{ include "cluster.color-info" (include "cluster.fullname" .) }} has been installed successfully. +The {{ include "cluster.color-info" (include "cluster.fullname" .) }} cluster has been installed successfully. {{ else if .Release.IsUpgrade }} -The {{ include "cluster.color-info" (include "cluster.fullname" .) }} has been upgraded successfully. +The {{ include "cluster.color-info" (include "cluster.fullname" .) }} cluster has been upgraded successfully. {{ end }} ██████ ██ ██ ████ ██ ██ ██ ███████ ████████ diff --git a/charts/paradedb/values.schema.json b/charts/paradedb/values.schema.json index 9c4c75c79..7a19fc41b 100644 --- a/charts/paradedb/values.schema.json +++ b/charts/paradedb/values.schema.json @@ -588,10 +588,10 @@ "version": { "type": "object", "properties": { - "postgresql": { + "paradedb": { "type": "string" }, - "paradedb": { + "postgresql": { "type": "string" } } diff --git a/charts/paradedb/values.yaml b/charts/paradedb/values.yaml index e154903c4..aa5877925 100644 --- a/charts/paradedb/values.yaml +++ b/charts/paradedb/values.yaml @@ -242,8 +242,10 @@ cluster: # -- PostgreSQL Host Based Authentication rules (lines to be appended to the pg_hba.conf file) pg_hba: [] # - host all all 10.244.0.0/16 md5 + # -- PostgreSQL User Name Maps rules (lines to be appended to the pg_ident.conf file) pg_ident: [] # - mymap /^(.*)@mydomain\.com$ \1 + # -- Lists of shared preload libraries to add to the default ones shared_preload_libraries: [] # - pgaudit