Skip to content

Commit ce9d458

Browse files
committed
Update README for 2.0 release
1 parent 2302925 commit ce9d458

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

CONTRIBUTING

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CONTRIBUTING
2+
3+
You can contribute to this project by opening a PR to merge to `master`, or one of the `vX.X.X` branches.
4+
5+
## Branching
6+
7+
`master` branch contains the latest source code with all the features. `vX.X.X` contains code for the specific major versions.
8+
i.e. `v0.4.x` contains the latest code for 0.4 version of the operator. See compatibility matrix below.
9+
10+
## Tests
11+
12+
Please write tests and fix any broken tests before you open a PR. Tests should cover at least 80% of your code.
13+
14+
## e2e-tests
15+
16+
End-to-end tests are implemented using [kuttl](https://kuttl.dev/), a Kubernetes test framework. To execute these tests locally, first install kuttl on your system, then run the command `make e2e` from the project root directory.

README.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ None
2727
In order for this operator to work correctly with AWS RDS, you need to set `POSTGRES_CLOUD_PROVIDER` to `AWS` either in
2828
the ext-postgres-operator kubernetes secret or directly in the deployment manifest (`operator.yaml`).
2929

30-
### Azure Database for PostgreSQL (both Single Server and Flexible Server)
30+
### Azure Database for PostgreSQL - Flexible Server
31+
32+
> **Note:** Starting from version 2.x, Azure Database for PostgreSQL - Single server is no longer supported, as it has been deprecated by Microsoft. Only Azure Database for PostgreSQL - Flexible Server is supported.
3133
3234
In order for this operator to work correctly with Azure managed PostgreSQL database, two env variables needs to be provided for the operator:
3335

@@ -36,7 +38,7 @@ In order for this operator to work correctly with Azure managed PostgreSQL datab
3638

3739
### GCP
3840

39-
In order for this operator to work correctly with GCP, you need to set `POSTGRES_CLOUD_PROVIDER` to `GCP`
41+
In order for this operator to work correctly with GCP, you need to set `POSTGRES_CLOUD_PROVIDER` to `GCP`
4042

4143
To have operator work with GCP properly you have to:
4244
* use postgresql connection in secret
@@ -49,17 +51,17 @@ DropRole method will check for db owner and will skip master role dropping
4951
These environment variables are embedded in [deploy/operator.yaml](deploy/operator.yaml), `env` section.
5052

5153
* `WATCH_NAMESPACE` - which namespace to watch. Defaults to empty string for all namespaces
52-
* `OPERATOR_NAME` - name of the operator, defaults to `ext-postgres-operator`
54+
* `OPERATOR_NAME` - name of the operator, defaults to `ext-postgres-operator`
5355
* `POSTGRES_INSTANCE` - identity of operator, this matched with `postgres.db.movetokube.com/instance` in CRs. Default is empty
5456
* `KEEP_SECRET_NAME` - use secret name as provided by user (disabled by default)
5557

5658
`POSTGRES_INSTANCE` is only available since version 1.2.0
5759

58-
> While using `KEEP_SECRET_NAME` could be a convenient way to define secrets with predictable and explicit names,
59-
> the default logic reduces risk of operator from entering the endless reconcile loop as secret is very unlikely to exist.
60+
> While using `KEEP_SECRET_NAME` could be a convenient way to define secrets with predictable and explicit names,
61+
> the default logic reduces risk of operator from entering the endless reconcile loop as secret is very unlikely to exist.
6062
>
61-
> The administrator should ensure that the `SecretName` does not collide with other secrets in the same namespace.
62-
> If the secret already exists, the operator will never stop reconciling the CR until either offending secret is deleted
63+
> The administrator should ensure that the `SecretName` does not collide with other secrets in the same namespace.
64+
> If the secret already exists, the operator will never stop reconciling the CR until either offending secret is deleted
6365
> or CR is deleted or updated with another SecretName
6466
6567
## Installation
@@ -96,7 +98,7 @@ To install the operator using kustomize, follow the steps below.
9698
or by using [kustomize](https://github.com/kubernetes-sigs/kustomize) directly\
9799
`kustomize build deploy/ | apply -f -`
98100

99-
Alternatively you can install operator using Helm Chart located in the
101+
Alternatively you can install operator using Helm Chart located in the
100102
`charts/ext-postgres-operator` subdirectory. Sample installation commands provided below:
101103

102104
```
@@ -117,7 +119,7 @@ metadata:
117119
namespace: app
118120
annotations:
119121
# OPTIONAL
120-
# use this to target which instance of operator should process this CR. See General config
122+
# use this to target which instance of operator should process this CR. See General config
121123
postgres.db.movetokube.com/instance: POSTGRES_INSTANCE
122124
spec:
123125
database: test-db # Name of database created in PostgreSQL
@@ -189,7 +191,7 @@ For more information and an example, see [kubernetes-replicator#pull-based-repli
189191

190192
#### Template Use Case
191193

192-
Users can specify the structure and content of secrets based on their unique requirements using standard
194+
Users can specify the structure and content of secrets based on their unique requirements using standard
193195
[Go templates](https://pkg.go.dev/text/template#hdr-Actions). This flexibility allows for a more tailored approach to
194196
meeting the specific needs of different applications.
195197

@@ -202,23 +204,6 @@ Available context:
202204
| `.Database` | Referenced database name |
203205
| `.Password` | Generated role password |
204206

205-
### Contribution
206-
207-
You can contribute to this project by opening a PR to merge to `master`, or one of the `vX.X.X` branches.
208-
209-
#### Branching
210-
211-
`master` branch contains the latest source code with all the features. `vX.X.X` contains code for the specific major versions.
212-
i.e. `v0.4.x` contains the latest code for 0.4 version of the operator. See compatibility matrix below.
213-
214-
#### Tests
215-
216-
Please write tests and fix any broken tests before you open a PR. Tests should cover at least 80% of your code.
217-
218-
#### e2e-tests
219-
220-
End-to-end tests are implemented using [kuttl](https://kuttl.dev/), a Kubernetes test framework. To execute these tests locally, first install kuttl on your system, then run the command `make e2e` from the project root directory.
221-
222207
### Compatibility
223208

224209
Postgres operator uses Operator SDK, which uses kubernetes client. Kubernetes client compatibility with Kubernetes cluster
@@ -230,4 +215,5 @@ Postgres operator compatibility with Operator SDK version is in the table below
230215
|---------------------------|----------------------|----------------------|
231216
| `postgres-operator 0.4.x` | v0.17 | v1beta1 |
232217
| `postgres-operator 1.x.x` | v0.18 | v1 |
233-
| `HEAD` | v0.18 | v1 |
218+
| `postgres-operator 2.x.x` | v1.39 | v1 |
219+
| `HEAD` | v1.39 | v1 |

0 commit comments

Comments
 (0)