Skip to content
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ or via [email](support@paradedb.com).

## Development Workflow

The majority of the development for ParadeDB happens in the [paradedb/paradedb](https://github.com/paradedb/paradedb) monorepo. Pleaser refer to this repository for general development. To develop for this repository, please follow the instructions below.
The majority of the development for ParadeDB happens in the [paradedb/paradedb](https://github.com/paradedb/paradedb) monorepo. Please refer to this repository for general development. To develop for this repository, please follow the instructions below.

## Pull Request Workflow

Expand All @@ -31,9 +31,9 @@ flow for making a change:

## Documentation

ParadeDB's public-facing documentation can be found at [docs.paradedb.com(https://docs.paradedb.com).
ParadeDB's public-facing documentation can be found at [docs.paradedb.com](https://docs.paradedb.com).

## Licensing

By contributing to ParadeDB, you agree that your contributions will be licensed
under the [GNU Affero General Public License v3.0](LICENSE).
under the [Apache License 2.0](LICENSE).
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
[![Publish Helm Chart](https://github.com/paradedb/charts/actions/workflows/paradedb-publish-chart.yml/badge.svg)](https://github.com/paradedb/charts/actions/workflows/paradedb-publish-chart.yml)
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/paradedb)](https://artifacthub.io/packages/search?repo=paradedb)
[![Docker Pulls](https://img.shields.io/docker/pulls/paradedb/paradedb)](https://hub.docker.com/r/paradedb/paradedb)
[![License](https://img.shields.io/github/license/paradedb/paradedb?color=blue)](https://github.com/paradedb/paradedb?tab=AGPL-3.0-1-ov-file#readme)
[![License](https://img.shields.io/github/license/paradedb/charts?color=blue)](https://github.com/paradedb/charts/blob/main/LICENSE)
[![Slack URL](https://img.shields.io/badge/Join%20Slack-purple?logo=slack&link=https%3A%2F%2Fjoin.slack.com%2Ft%2Fparadedbcommunity%2Fshared_invite%2Fzt-32abtyjg4-yoYoi~RPh9MSW8tDbl0BQw)](https://join.slack.com/t/paradedbcommunity/shared_invite/zt-32abtyjg4-yoYoi~RPh9MSW8tDbl0BQw)
[![X URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Ftwitter.com%2Fparadedb&label=Follow%20%40paradedb)](https://x.com/paradedb)

Expand Down Expand Up @@ -50,7 +50,7 @@ First, install [Helm](https://helm.sh/docs/intro/install/). The following steps

#### Monitoring

The ParadeDB Helm chart supports monitoring via Prometheus and Grafana. To enable monitoring, you need to have the Prometheus CRDs installed before installing the CloudNativePG operator. The Promotheus CRDs can be found [here](https://prometheus-community.github.io/helm-charts).
The ParadeDB Helm chart supports monitoring via Prometheus and Grafana. To enable monitoring, you need to have the Prometheus CRDs installed before installing the CloudNativePG operator. The Prometheus CRDs can be found [here](https://prometheus-community.github.io/helm-charts).

#### Installing the CloudNativePG Operator

Expand Down Expand Up @@ -125,4 +125,4 @@ helm upgrade --atomic --install paradedb --namespace paradedb --create-namespace

## License

ParadeDB is licensed under the [GNU Affero General Public License v3.0](LICENSE) and as commercial software. For commercial licensing, please contact us at [sales@paradedb.com](mailto:sales@paradedb.com).
Apache-2.0 License - see [LICENSE](LICENSE) for details.
10 changes: 5 additions & 5 deletions charts/paradedb/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ First, install [Helm](https://helm.sh/docs/intro/install/). The following steps

#### Monitoring

The ParadeDB Helm chart supports monitoring via Prometheus and Grafana. To enable monitoring, you need to have the Prometheus CRDs installed before installing the CloudNativePG operator. The Promotheus CRDs can be found [here](https://prometheus-community.github.io/helm-charts).
The ParadeDB Helm chart supports monitoring via Prometheus and Grafana. To enable monitoring, you need to have the Prometheus CRDs installed before installing the CloudNativePG operator. The Prometheus CRDs can be found [here](https://prometheus-community.github.io/helm-charts).

#### Installing the CloudNativePG Operator

Expand Down Expand Up @@ -124,7 +124,7 @@ To create a ParadeDB cluster, you must specify either `paradedb` or `paradedb-en
The chart has three modes of operation. These are configured via the `mode` parameter:

* `standalone` - Creates new or updates an existing CNPG cluster. This is the default mode.
* `replica` - Creates a replica cluster from an existing CNPG cluster. **_Note_ that this mode is not yet supported.**
* `replica` - Creates a replica cluster from an existing CNPG cluster.
* `recovery` - Recovers a CNPG cluster from a backup, object store or via pg_basebackup.

### Backup Configuration
Expand All @@ -151,7 +151,7 @@ backups:
backupOwnerReference: self
```

Each backup adapter takes it's own set of parameters, listed in the [Configuration options](#Configuration-options) section
Each backup adapter takes its own set of parameters, listed in the [Configuration options](#Configuration-options) section
below. Refer to the table for the full list of parameters and place the configuration under the appropriate key: `backup.s3`,
`backup.azure`, or `backup.google`.

Expand Down Expand Up @@ -192,7 +192,7 @@ Additionally, we recommend enabling the `kube-state-metrics` CRD monitoring and
## Examples

There are several configuration examples in the [examples](examples) directory. Refer to them for a basic setup and
refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentation/current/) for more advanced configurations.
refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentation/current/) for more advanced configurations.

{{ template "chart.valuesSection" . }}
| poolers[].name | string | `` | Name of the pooler resource |
Expand All @@ -216,4 +216,4 @@ refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentat

## License

ParadeDB is licensed under the [GNU Affero General Public License v3.0](LICENSE) and as commercial software. For commercial licensing, please contact us at [sales@paradedb.com](mailto:sales@paradedb.com).
Apache-2.0 License - see [LICENSE](LICENSE) for details.
62 changes: 0 additions & 62 deletions charts/paradedb/docs/Console.md

This file was deleted.

18 changes: 9 additions & 9 deletions charts/paradedb/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Refer to the [CNPG documentation](https://cloudnative-pg.io/documentation/curren

## Installing the operator

To begin, make sure you install the CNPG operator in you cluster. It can be installed via a Helm chart as shown below or
ir can be installed via a Kubernetes manifest. For more information see the [CNPG documentation](https://cloudnative-pg.io/documentation/current/installation_upgrade/).
To begin, make sure you install the CNPG operator in your cluster. It can be installed via a Helm chart as shown below or
it can be installed via a Kubernetes manifest. For more information see the [CNPG documentation](https://cloudnative-pg.io/documentation/current/installation_upgrade/).

```console
helm repo add cnpg https://cloudnative-pg.github.io/charts
Expand Down Expand Up @@ -39,12 +39,12 @@ Depending on the type the chart will use a different Docker image and fill in so
The chart has three modes of operation. These are configured via the `mode` parameter. If this is your first cluster, you
are likely looking for the `standalone` option.
* `standalone` - Creates new or updates an existing CNPG cluster. This is the default mode.
* `replica` - Creates a replica cluster from an existing CNPG cluster. **_Note_ that this mode is not yet supported.**
* `replica` - Creates a replica cluster from an existing CNPG cluster.
* `recovery` - Recovers a CNPG cluster from a backup, object store or via pg_basebackup.

### Backup configuration

Most importantly you should configure your backup storage.
Most importantly you should configure your backup storage.

CNPG implements disaster recovery via [Barman](https://pgbarman.org/). The following section configures the barman object
store where backups will be stored. Barman performs backups of the cluster filesystem base backup and WALs. Both are
Expand All @@ -66,7 +66,7 @@ Additionally you can specify the following parameters:
backupOwnerReference: self
```

Each backup adapter takes it's own set of parameters, listed in the [Configuration options](../README.md#Configuration-options) section
Each backup adapter takes its own set of parameters, listed in the [Configuration options](../README.md#Configuration-options) section
below. Refer to the table for the full list of parameters and place the configuration under the appropriate key: `backup.s3`,
`backup.azure`, or `backup.google`.

Expand All @@ -76,12 +76,12 @@ There are several important cluster options. Here are the most important ones:

`cluster.instances` - The number of instances in the cluster. Defaults to `1`, but you should set this to `3` for production.
`cluster.imageName` - This allows you to override the Docker image used for the cluster. The chart will choose a default
for you based on the setting you chose for `type`. If you need to run a configuration that is not supported, you can
for you based on the setting you chose for `type`. If you need to run a configuration that is not supported, you can
create your own Docker image. You can use the [postgres-containers](https://github.com/cloudnative-pg/postgres-containers)
repository for a starting point.
You will likely need to set your own repository access credentials via: `cluster.imagePullPolicy` and `cluster.imagePullSecrets`.
`cluster.storage.size` - The size of the persistent volume claim for the cluster. Defaults to `8Gi`. Every instance will
have it's own persistent volume claim.
have its own persistent volume claim.
`cluster.storage.storageClass` - The storage class to use for the persistent volume claim.
`cluster.resources` - The resource limits and requests for the cluster. You are strongly advised to use the same values
for both limits and requests to ensure a [Guaranteed QoS](https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#guaranteed).
Expand All @@ -93,7 +93,7 @@ There are several important cluster options. Here are the most important ones:
cluster:
postgresql:
max_connections: "200"
shared_buffers: "2GB"
shared_buffers: "2GB"
```
`cluster.initSQL` - Allows you to run custom SQL queries during the cluster initialization. This is useful for creating
extensions, schemas and databases. Note that these are as a superuser.
Expand All @@ -103,4 +103,4 @@ For a full list - refer to the Helm chart [configuration options](../README.md#C
## Examples

There are several configuration examples in the [examples](../examples) directory. Refer to them for a basic setup and
refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentation/current/) for more advanced configurations.
refer to the [CloudNativePG Documentation](https://cloudnative-pg.io/documentation/current/) for more advanced configurations.
4 changes: 2 additions & 2 deletions charts/paradedb/docs/recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ When performing a recovery you are strongly advised to use the same configuratio

To begin, create a `values.yaml` that contains the following:

1. Set `mode: recovery` to indicate that you want to perform bootstrap the new cluster from an existing one.
1. Set `mode: recovery` to indicate that you want to bootstrap the new cluster from an existing one.
2. Set the `recovery.method` to the type of recovery you want to perform.
3. Set either the `recovery.backupName` or the Barman Object Store configuration - i.e. `recovery.provider` and appropriate S3, Azure or GCS configuration. In case of `pg_basebackup` complete the `recovery.pgBaseBackup` section.
3. Set either the `recovery.backupName` or the Barman Object Store configuration - i.e. `recovery.provider` and appropriate S3, Azure or GCS configuration. In case of `pg_basebackup` complete the `recovery.pgBaseBackup` section.
4. Optionally set the `recovery.pitrTarget.time` in RFC3339 format to perform a point-in-time recovery (not applicable for `pgBaseBackup`).
5. Retain the identical PostgreSQL version and configuration as the original cluster.
6. Make sure you don't use the same backup section name as the original cluster. We advise you change the `path` within the storage location if you want to reuse the same storage location/bucket.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The `CNPGClusterHighPhysicalReplicationLagWarning` alert is triggered when physi

## Impact

High physical replication lag can cause the cluster replicas to become out of sync. Queries to the `-r` and `-ro` endpoints may return stale data. In the event of a failover, the data that has not yet been replicated from the primary to the replicas may be lost during failover..
High physical replication lag can cause the cluster replicas to become out of sync. Queries to the `-r` and `-ro` endpoints may return stale data. In the event of a failover, the data that has not yet been replicated from the primary to the replicas may be lost during failover.

## Diagnosis

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ spec:
apply: 1s
assert: 10s
cleanup: 1m
exec: 2m
exec: 3m
steps:
- name: Install a cluster with a console enabled
try:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ spec:
- script:
content: |
helm uninstall --namespace $NAMESPACE database-parameters
helm uninstall --namespace $NAMESPACE extension-upgrade
helm uninstall --namespace $NAMESPACE extension-upgrade
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ spec:
env:
- name: MY_CUSTOM_FLAG
value: enabled
- name: MY_CUSTROM_ENV
- name: MY_CUSTOM_ENV
valueFrom:
configMapKeyRef:
name: my-custom-env
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ cluster:
env:
- name: MY_CUSTOM_FLAG
value: enabled
- name: MY_CUSTROM_ENV
- name: MY_CUSTOM_ENV
valueFrom:
configMapKeyRef:
name: my-custom-env
Expand Down
2 changes: 1 addition & 1 deletion charts/paradedb/test/replica/chainsaw-test.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
##
# This test create a source CNPG cluster with ParadeDB Enterprise (required for WALs) and with MinIO backups
# This test creates a source CNPG cluster with ParadeDB Enterprise (required for WALs) and with MinIO backups
# and then creates a replica cluster bootstrapped with pg_basebackup, object store, and a hybrid one, using both.
apiVersion: chainsaw.kyverno.io/v1alpha1
kind: Test
Expand Down
12 changes: 4 additions & 8 deletions charts/paradedb/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ recovery:
# -- Available recovery methods:
# * `backup` - Recovers a CNPG cluster from a CNPG backup (PITR supported) Needs to be on the same cluster in the same namespace.
# * `object_store` - Recovers a CNPG cluster from a barman object store (PITR supported).
# * `pg_basebackup` - Recovers a CNPG cluster viaa streaming replication protocol. Useful if you want to
# * `pg_basebackup` - Recovers a CNPG cluster via a streaming replication protocol. Useful if you want to
# migrate databases to CloudNativePG, even from outside Kubernetes.
# * `import` - Import one or more databases from an existing Postgres cluster.
method: backup
Expand All @@ -51,7 +51,7 @@ recovery:
# -- Name of the owner of the database in the instance to be used by applications. Defaults to the value of the `database` key.
owner: ""
# -- Overrides the provider specific default endpoint. Defaults to:
# S3: https://s3.<region>.amazonaws.com"
# S3: https://s3.<region>.amazonaws.com
# Leave empty if using the default S3 endpoint
endpointURL: ""
# -- Specifies a CA bundle to validate a privately signed certificate.
Expand Down Expand Up @@ -249,7 +249,7 @@ cluster:
env: []
# - name: MY_CUSTOM_FLAG
# value: "enabled"
# - name: MY_CUSTROM_ENV
# - name: MY_CUSTOM_ENV
# valueFrom:
# configMapKeyRef:
# name: my-custom-env
Expand Down Expand Up @@ -322,10 +322,6 @@ cluster:
# -- Exclude specified rules
excludeRules: []
# - CNPGClusterZoneSpreadWarning
# Additional instrumentation via custom metrics
instrumentation:
# -- Enable logical replication metrics
logicalReplication: true
# -- Whether the default queries should be injected.
# Set it to true if you don't want to inject default queries into the cluster.
disableDefaultQueries: false
Expand Down Expand Up @@ -415,7 +411,7 @@ backups:
enabled: false

# -- Overrides the provider specific default endpoint. Defaults to:
# S3: https://s3.<region>.amazonaws.com"
# S3: https://s3.<region>.amazonaws.com
endpointURL: "" # Leave empty if using the default S3 endpoint
# -- Specifies a CA bundle to validate a privately signed certificate.
endpointCA:
Expand Down