Skip to content

Commit dc3c339

Browse files
committed
Update README
1 parent f5755b9 commit dc3c339

File tree

2 files changed

+45
-22
lines changed

2 files changed

+45
-22
lines changed

README.md

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# External PostgreSQL Server Operator for Kubernetes
22

3+
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/ext-postgres-operator)](https://artifacthub.io/packages/search?repo=ext-postgres-operator)
4+
[![Sponsor](https://img.shields.io/badge/Sponsor_on_GitHub-ff69b4?style=for-the-badge&logo=github)](https://github.com/sponsors/hitman99)
5+
36
Manage external PostgreSQL databases in Kubernetes with ease—supporting AWS RDS, Azure Database for PostgreSQL, GCP Cloud SQL, and more.
47

58
---
@@ -24,8 +27,6 @@ Manage external PostgreSQL databases in Kubernetes with ease—supporting AWS RD
2427

2528
Please consider supporting this project!
2629

27-
[![Sponsor](https://img.shields.io/badge/Sponsor_on_GitHub-ff69b4?style=for-the-badge&logo=github)](https://github.com/sponsors/hitman99)
28-
2930
**Current Sponsors:**
3031
_None yet. [Become a sponsor!](https://github.com/sponsors/hitman99)_
3132

@@ -76,8 +77,27 @@ Set environment variables in [`config/manager/operator.yaml`](config/manager/ope
7677
7778
## Installation
7879

79-
This operator requires a Kubernetes Secret to be created in the same namespace as operator itself.
80-
Secret should contain these keys: POSTGRES_HOST, POSTGRES_USER, POSTGRES_PASS, POSTGRES_URI_ARGS, POSTGRES_CLOUD_PROVIDER, POSTGRES_DEFAULT_DATABASE.
80+
### Install Using Helm (Recommended)
81+
82+
The Helm chart for this operator is located in the `charts/ext-postgres-operator` subdirectory. Follow these steps to install:
83+
84+
1. Add the Helm repository:
85+
```bash
86+
helm repo add ext-postgres-operator https://movetokube.github.io/postgres-operator/
87+
```
88+
89+
2. Install the operator:
90+
```bash
91+
helm install -n operators ext-postgres-operator ext-postgres-operator/ext-postgres-operator
92+
```
93+
94+
3. Customize the installation by modifying the values in [values.yaml](charts/ext-postgres-operator/values.yaml).
95+
96+
### Install Using Kustomize
97+
98+
This operator requires a Kubernetes Secret to be created in the same namespace as the operator itself.
99+
The Secret should contain these keys: `POSTGRES_HOST`, `POSTGRES_USER`, `POSTGRES_PASS`, `POSTGRES_URI_ARGS`, `POSTGRES_CLOUD_PROVIDER`, `POSTGRES_DEFAULT_DATABASE`.
100+
81101
Example:
82102

83103
```yaml
@@ -96,26 +116,29 @@ data:
96116
POSTGRES_DEFAULT_DATABASE: cG9zdGdyZXM=
97117
```
98118
99-
To install the operator using kustomize, follow the steps below.
119+
To install the operator using Kustomize, follow these steps:
100120
101-
1. Configure Postgres credentials for the operator in `config/secret.yaml`
102-
2. Create namespace if needed with\
103-
`kubectl apply -f config/namespace.yaml`
104-
3. Apply the secret with\
105-
`kubectl apply -f deploy/secret.yaml`
106-
4. Create the operator with either\
107-
`kubectl kustomize config/default/ | apply -f -`\
108-
or by using [kustomize](https://github.com/kubernetes-sigs/kustomize) directly\
109-
`kustomize build config/default/ | apply -f -`
121+
1. Configure Postgres credentials for the operator in `config/secret.yaml`.
110122

111-
Alternatively you can install operator using Helm Chart located in the
112-
`charts/ext-postgres-operator` subdirectory. Sample installation commands provided below:
123+
2. Create the namespace if needed:
124+
```bash
125+
kubectl apply -f config/namespace.yaml
126+
```
113127

114-
```
115-
helm repo add ext-postgres-operator https://movetokube.github.io/postgres-operator/
116-
helm install -n operators ext-postgres-operator ext-postgres-operator/ext-postgres-operator
117-
```
118-
See [values.yaml](charts/ext-postgres-operator/values.yaml) for the possible values to define.
128+
3. Apply the secret:
129+
```bash
130+
kubectl apply -f deploy/secret.yaml
131+
```
132+
133+
4. Deploy the operator:
134+
```bash
135+
kubectl kustomize config/default/ | kubectl apply -f -
136+
```
137+
138+
Alternatively, use [Kustomize](https://github.com/kubernetes-sigs/kustomize) directly:
139+
```bash
140+
kustomize build config/default/ | kubectl apply -f -
141+
```
119142

120143
## Custom Resources (CRs)
121144

config/manager/operator.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ spec:
1717
runAsNonRoot: true
1818
containers:
1919
- name: ext-postgres-operator
20-
image: movetokube/postgres-operator
20+
image: movetokube/postgres-operator:2.0.0
2121
command:
2222
- postgres-operator
2323
imagePullPolicy: Always

0 commit comments

Comments
 (0)