Skip to content

update readme with contribution notes #64

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

Merged
merged 1 commit into from
Jul 5, 2021
Merged
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
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,26 @@ This creates a user role `username-<hash>` and grants role `test-db-group`, `tes
`PostgresUser` needs to reference a `Postgres` in the same namespace.

Two `Postgres` referencing the same database can exist in more than one namespace. The last CR referencing a database will drop the group role and transfer database ownership to the role used by the operator.


### Contribution
You can contribute to this project by opening a PR to merge to `master`, or one of the `vX.X.X` branches.
#### Branching
`master` branch contains the latest source code with all the features. `vX.X.X` contains code for the specific major versions.
i.e. `v0.4.x` contains the latest code for 0.4 version of the operator. See compatibility matrix below.

#### Tests
Please write tests and fix any broken tests before you open a PR. Tests should cover at least 80% of your code.

### Compatibility
Postgres operator uses Operator SDK, which uses kubernetes client. Kubernetes client compatibility with Kubernetes cluster
can be found [here](https://github.com/kubernetes/client-go/blob/master/README.md#compatibility-matrix)

Postgres operator compatibility with Operator SDK version is in the table below

| | Operator SDK 0.17.x | Operator SDK 1.9.0 |
|-------------------------------|---------------------|--------------------|
| `postgres-operator 0.4.x` | ✓ | - |
| `postgres-operator 1.0.x` | - | ✓ |
| `HEAD` | ✓ | - |