Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update README and Schema #37

Merged
merged 5 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .github/workflows/tests-cluster-chainsaw.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions charts/paradedb/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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>).
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion charts/paradedb/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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>).
Expand Down
4 changes: 2 additions & 2 deletions charts/paradedb/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -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 }}

██████ ██ ██ ████ ██ ██ ██ ███████ ████████
Expand Down
4 changes: 2 additions & 2 deletions charts/paradedb/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -588,10 +588,10 @@
"version": {
"type": "object",
"properties": {
"postgresql": {
"paradedb": {
"type": "string"
},
"paradedb": {
"postgresql": {
"type": "string"
}
}
Expand Down
2 changes: 2 additions & 0 deletions charts/paradedb/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading