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

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mmontes11 committed Jun 28, 2023
1 parent b4326f7 commit af3512c
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
# agent
🤖 Sidecar agent for MariaDB that co-operates with [mariadb-operator](https://github.com/mariadb-operator/mariadb-operator). Remotely manage Galera via HTTP instead of configuration `*.cnf` files
<p align="center">
<img src="https://mariadb-operator.github.io/mariadb-operator/assets/mariadb-operator.png" alt="mariadb" width="250"/>
</p>

<p align="center">
<a href="https://github.com/mariadb-operator/agent/actions/workflows/ci.yml"><img src="https://github.com/mariadb-operator/agent/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
<a href="https://github.com/mariadb-operator/agent/actions/workflows/release.yml"><img src="https://github.com/mariadb-operator/agent/actions/workflows/release.yml/badge.svg" alt="Release"></a>
<a href="https://goreportcard.com/report/github.com/mariadb-operator/agent"><img src="https://goreportcard.com/badge/github.com/mariadb-operator/agent" alt="Go Report Card"></a>
<a href="https://pkg.go.dev/github.com/mariadb-operator/agent"><img src="https://pkg.go.dev/badge/github.com/mariadb-operator/agent.svg" alt="Go Reference"></a>
</p>


# 🤖 agent
Sidecar agent for MariaDB that co-operates with [mariadb-operator](https://github.com/mariadb-operator/mariadb-operator). Remotely manage Galera via HTTP instead of configuration `*.cnf` files.
- HTTP API to manage Galera and expose the MariaDB state to `mariadb-operator`
- Query and update Galera state without mounting`/var/lib/mysql/grastate.dat`
- Query and update Galera state without mounting `/var/lib/mysql/grastate.dat`
- Perform [Galera cluster recovery](https://galeracluster.com/library/documentation/crash-recovery.html) remotely
- Bootstrap new Galera cluster as a result of the cluster recovery
- Idiomatic Go HTTP client [pkg/client](./pkg/client/)
Expand All @@ -10,7 +22,7 @@

### How to use it

Refer to the agent image in the MariaDB CRD `spec.galera.agent` field.
Specify the agent image in the `MariaDB` `spec.galera.agent` field.

```yaml
apiVersion: mariadb.mmontes.io/v1alpha1
Expand Down Expand Up @@ -48,6 +60,6 @@ spec:

### HTTP API

You can consume the agent API using the [pkg/client](./pkg/client/). Alternatively, take a look at our Postman collection:
You can consume the agent API using the [pkg/client](./pkg/client/). Alternatively, take a look at our Postman collection.

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/9776-cbdc1706-5e01-423a-822a-ed46daff6abd?action=collection%2Ffork&collection-url=entityId%3D9776-cbdc1706-5e01-423a-822a-ed46daff6abd%26entityType%3Dcollection%26workspaceId%3Da184b7e4-b1f7-405e-b9ec-ec62ed36dd27#?env%5BKubernetes%5D=W3sia2V5IjoidXJsIiwidmFsdWUiOiJodHRwOi8vbWFyaWFkYi1nYWxlcmEtMC5tYXJpYWRiLWdhbGVyYS1pbnRlcm5hbC5kZWZhdWx0LnN2Yy5jbHVzdGVyLmxvY2FsOjU1NTUiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6Imh0dHA6Ly9tYXJpYWRiLWdhbGVyYS0wLm1hcmlhZGItZ2FsZXJhLWludGVybmFsLmRlZmF1bHQuc3ZjLmNsdXN0ZXIubG9jYWw6NTU1NSIsInNlc3Npb25JbmRleCI6MH1d)

0 comments on commit af3512c

Please sign in to comment.