Skip to content

Commit 9c42b0b

Browse files
committed
docs: improve docs
1 parent 4607558 commit 9c42b0b

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,34 @@
33
This operator helps you to manage (self-)hosted databases in your Kubernetes clusters by defining them with [Custom-Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
44
It will automatically handle creation, updates & removal of your external databases.
55

6-
> __Example:__ You are deploying a guestbook web-application. For the app you need some kind of deployment, a service, an ingress route and a database.
7-
As you do already have an external database system hosted outside Kubernetes you only want an automatic generation of a new database in that system with a new user for your application.
6+
> **Example:** You are deploying a guestbook web-application. For the app you need some kind of deployment, a service, an ingress route and a database.
7+
> As you do already have an external database system hosted outside Kubernetes you only want an automatic generation of a new database in that system with a new user for your application.
88
99
This can be done with the following manifest:
1010

1111
```yaml
12-
apiVersion: rzab.de/v1
12+
apiVersion: anbraten.github.io/v1alpha1
1313
kind: Database
1414
metadata:
1515
name: guestbook-database
1616
spec:
17-
type: mysql
17+
type: mongo
1818
database: guestbook
1919
username: guestbook-admin
2020
password: iwonttellyou
2121
```
2222
23-
> Important note: :rotating_light: Database types can not be updated! Updating the user credentials normally results in recreation of the complete user which could delete your custom changes.
23+
> Important note: :rotating_light: Database settings (`type`, `database`, `username`, `password`) will possibly re-create the corresponding data and wont migrate the database or user.
2424

2525
## Supported database types
26-
- mysql
27-
- couchdb
28-
- mongo
29-
- postgres
26+
27+
- mongo :white_check_mark:
28+
- mysql :hammer:
29+
- couchdb :hammer:
30+
- postgres :clock1:
3031

3132
## Installation
33+
3234
### Requirements
3335

34-
##
36+
### Deployment

deploy/database-secrets.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ metadata:
55
namespace: external-database-operator-system
66
type: Opaque
77
stringData:
8-
mysqlHost: "my-dbs-system.tld"
9-
mysqlAdminUsername: "root"
8+
mysqlHost: ""
9+
mysqlAdminUsername: ""
1010
mysqlAdminPassword: ""
1111
couchdbUrl: ""
12-
couchdbAdminUsername: "root"
12+
couchdbAdminUsername: ""
1313
couchdbAdminPassword: ""
14-
mongoUrl: "mongodb://root:[email protected]:27017/?authSource=admin"
14+
mongoUrl: ""

deploy/external-database-controller.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ spec:
278278
- --leader-elect
279279
command:
280280
- /manager
281-
image: anbraten/external-database-operator:0.0.2
281+
image: anbraten/external-database-operator:0.0.8
282282
livenessProbe:
283283
httpGet:
284284
path: /healthz

0 commit comments

Comments
 (0)