Skip to content
This repository was archived by the owner on Feb 28, 2024. It is now read-only.

Commit 473e42f

Browse files
committed
Update README.md
1 parent 33626d8 commit 473e42f

File tree

2 files changed

+35
-3
lines changed

2 files changed

+35
-3
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,38 @@
1010
</p>
1111

1212
# 🍼 init
13-
Init container for MariaDB that co-operates with [mariadb-operator](https://github.com/mariadb-operator/mariadb-operator).
13+
Init container for MariaDB that co-operates with [mariadb-operator](https://github.com/mariadb-operator/mariadb-operator). Configure Galera and guarantee ordered deployments for MariaDB.
14+
- Avoid hacking with bash `initContainers`, do it properly in Go
15+
- Get `MariaDB` resources from the Kubernetes API and configure Galera based on them
16+
- Guarantee MariaDB ordered deployment by checking its `Pod` Ready conditions in the Kubernetes API
17+
- Allow `spec.podManagementPolicy` = `Parallel` in the MariaDB `StatefulSet`
1418

15-
🚧🚧🚧
19+
### How to use it
20+
21+
Specify the init image in the `MariaDB` `spec.galera.initContainer` field.
22+
23+
```yaml
24+
apiVersion: mariadb.mmontes.io/v1alpha1
25+
kind: MariaDB
26+
metadata:
27+
name: mariadb-galera
28+
spec:
29+
...
30+
image:
31+
repository: mariadb
32+
tag: "10.11.3"
33+
pullPolicy: IfNotPresent
34+
port: 3306
35+
replicas: 3
36+
37+
galera:
38+
sst: mariabackup
39+
replicaThreads: 1
40+
41+
initContainer:
42+
image:
43+
repository: ghcr.io/mariadb-operator/init
44+
tag: "v0.0.1"
45+
pullPolicy: IfNotPresent
46+
...
47+
```

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ func main() {
6969
if err != nil {
7070
log.Fatalf("Error creating logger: %v", err)
7171
}
72-
logger.Info("Staring init")
72+
logger.Info("Statring init")
7373

7474
env, err := env()
7575
if err != nil {

0 commit comments

Comments
 (0)