Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com> Co-authored-by: Natalie Kwong <38087517+nataliekwong@users.noreply.github.com>
60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
# External Database
|
|
|
|
For production deployments, we recommend using a dedicated database instance for better reliability, and backups (such as AWS RDS or GCP Cloud SQL) instead of the default internal Postgres database (`airbyte/db`) that Airbyte spins up within the Kubernetes cluster.
|
|
|
|
The following instructions assume that you've already configured a Postgres instance:
|
|
|
|
## Secrets
|
|
|
|
```yaml
|
|
apiVersion: v1
|
|
kind: Secret
|
|
metadata:
|
|
name: airbyte-config-secrets
|
|
type: Opaque
|
|
stringData:
|
|
# Database Secrets
|
|
## database-host: ## e.g. database.internla
|
|
## database-port: ## e.g. 5432
|
|
## database-name: ## e.g. airbyte
|
|
## database-user: ## e.g. airbyte
|
|
database-password: ## e.g. password
|
|
```
|
|
|
|
## Values
|
|
|
|
Add external database details to your `values.yaml` file. This disables the default internal Postgres database (`airbyte/db`), and configures your external Postgres database. You can override all of the values below by setting them in the airbyte-config-secrets or set them directly in the `values.yaml` file. **The database password is a special case in that it must be set in the [airbyte-config-secrets](#secrets).**
|
|
|
|
```yaml
|
|
postgresql:
|
|
enabled: false
|
|
|
|
global:
|
|
database:
|
|
# -- Secret name where database credentials are stored
|
|
secretName: "" # e.g. "airbyte-config-secrets"
|
|
|
|
# -- The database host
|
|
host: ""
|
|
# -- The key within `secretName` where host is stored
|
|
#hostSecretKey: "" # e.g. "database-host"
|
|
|
|
# -- The database port
|
|
port: ""
|
|
# -- The key within `secretName` where port is stored
|
|
#portSecretKey: "" # e.g. "database-port"
|
|
|
|
# -- The database name
|
|
database: ""
|
|
# -- The key within `secretName` where the database name is stored
|
|
#databaseSecretKey: "" # e.g. "database-name"
|
|
|
|
# -- The database user
|
|
user: "" # -- The key within `secretName` where the user is stored
|
|
#userSecretKey: "" # e.g. "database-user"
|
|
|
|
# -- The key within `secretName` where password is stored
|
|
passwordSecretKey: "" # e.g."database-password"
|
|
```
|
|
|