Skip to content

Commit 723b70c

Browse files
authored
Updated readme
1 parent c34f24b commit 723b70c

File tree

1 file changed

+36
-17
lines changed

1 file changed

+36
-17
lines changed

README.md

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1-
# Titanium
2-
Bulletproof mysql on kubernetes
1+
# MySQL Operator
2+
3+
MySQL Operator is a bulletproof MySQL on Kubernetes. It manages all the necessary resources for a MySQL CLuster deployment.
4+
5+
The MySQL Operator provides efortless backups, while the cluster being highly-available.
6+
7+
MySQL Operator was developed by the awesome engineering team at [Presslabs](https://www.presslabs.com/),
8+
a Managed WordPress Hosting provider.
9+
10+
For more open-source projects, check [Presslabs Code](https://www.presslabs.org/).
311

412
## Goals
13+
14+
The main goals of this operator are:
15+
516
1. Easily deploy mysql clusters in kubernetes (cluster-per-service model)
6-
2. Devops friendly (monitoring story solved)
7-
3. Out of the box backups (automated and on demand) and point-in-time recovery
17+
2. Friendly devops (monitoring story solved)
18+
3. Out-of-the-box backups (automated and on demand) and point-in-time recovery
819
4. Support for cloning in cluster and across clusters
920

1021
## Controller deploy
11-
To deploy this controller use the provided helm chart, by running:
22+
23+
To deploy this controller, use the provided helm chart, by running:
1224
```
1325
helm repo add presslabs https://presslabs.github.io/charts
1426
helm install presslabs/mysql-operator
@@ -18,10 +30,11 @@ This chart will deploy the controller and an orchestrator cluster.
1830

1931

2032
## Example of a cluster
21-
Before creating a cluster we need a secret that contains the `ROOT_PASSWORD` to
33+
34+
Before creating a cluster, we need a secret that contains the `ROOT_PASSWORD` to
2235
init mysql with (an example for this secret can be found
23-
[here](examples/example-backup-secret.yaml)). Now to create a cluster we need
24-
just a simple yaml file that defines it, let's call it
36+
[here](examples/example-backup-secret.yaml)). Now, to create a cluster we need
37+
just a simple yaml file that defines it let's call it
2538
`cluster.yaml` and can be as follows:
2639

2740
```yaml
@@ -34,8 +47,8 @@ spec:
3447
secretName: the-secret
3548
```
3649
37-
For a more in depth configuration checkout [examples](examples/). To deploy this
38-
cluster run:
50+
For a more in depth configuration, check [examples](examples/). To deploy this
51+
cluster, run:
3952
4053
```
4154
kubectl apply -f cluster.yaml
@@ -64,9 +77,10 @@ Status:
6477
```
6578

6679
## Example of a backup
67-
To make a backup it's easy, as defining a cluster you should define a backup,
68-
for a detailed example check [this](examples/example-backup.yaml) example. Let's
69-
define a new on:
80+
81+
Making a backup is easy — defining a cluster, you should define a backup;
82+
for a detailed example, check [this](examples/example-backup.yaml) example. Let's
83+
define a new one on:
7084

7185
```yaml
7286
apiVersion: mysql.presslabs.net/v1alpha1
@@ -77,19 +91,19 @@ spec:
7791
clusterName: foo
7892
```
7993
80-
To deploy the backup run:
94+
To deploy the backup, run:
8195
```
8296
kubeclt apply -f backup.yaml
8397
```
8498

85-
To lists all backups:
99+
To lists all backups, run:
86100
```
87101
$ kubectl get backup
88102
NAME AGE
89103
foo-backup 1m
90104
```
91105

92-
To check backup state and details use:
106+
To check backup state and details, use:
93107
```
94108
$ kubectl describe backup foo-backup
95109
...
@@ -114,5 +128,10 @@ Status:
114128
This project uses Percona Server for MySQL 5.7 because of backup improvements
115129
(eg. backup locks), monitoring improvements and some serviceability improvements
116130
(eg. utility user). The case against MariaDB is that WordPress requires MySQL,
117-
but MariaDB is not a drop-in replacement for it. Since MariaDB 10 it's fork
131+
but MariaDB is not a drop-in replacement for it, since MariaDB 10 is a fork,
118132
rather than following MySQL.
133+
134+
## License
135+
136+
This project is licensed under Apache 2.0 license. Read the [LICENSE](LICENSE) file in the
137+
top distribution directory, for the full license text.

0 commit comments

Comments
 (0)