Skip to content

Commit

Permalink
Merge pull request #57 from turkenh/update-readme
Browse files Browse the repository at this point in the history
Formatting and minor wording changes in Readme
  • Loading branch information
turkenh authored Nov 26, 2021
2 parents 735c608 + 4241040 commit 0594d35
Showing 1 changed file with 15 additions and 18 deletions.
33 changes: 15 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,27 @@ It currently supports **MySQL**, **PostgreSQL** and **MSSQL**.

1. Create a connection secret:

To create resources in this repository, you will first need a k8s secret
with the connection details to an existing SQL server.
To create provider-sql managed resources, you will first need a K8s secret
with the connection details to an existing SQL server.

This could either be [created automatically] by provisioning an SQL server with
a Crossplane provider (e.g. a [CloudSQLInstance] with provider-gcp) or you can
create for an existing server as follows:
This secret could either be [created automatically] by provisioning an SQL server
with a Crossplane provider (e.g. a [CloudSQLInstance] with provider-gcp) or you can
create for an existing server as follows:

```
kubectl create secret generic db-conn \
--from-literal=username=admin \
--from-literal=password=t0ps3cr3t \
--from-literal=endpoint=my.sql-server.com \
--from-literal=port=3306
```
```
kubectl create secret generic db-conn \
--from-literal=username=admin \
--from-literal=password='t0ps3cr3t' \
--from-literal=endpoint=my.sql-server.com \
--from-literal=port=3306
```

2. Create managed resource for your SQL server flavor:

- [**MySQL**]: `Database`, `Grant`, `User`
- [**PostgreSQL**]: `Database`, `Grant`, `Extension`, `Role`
- [**MSSQL**]: `Database`, `Grant`, `User`
- **MySQL**: `Database`, `Grant`, `User` (See [the examples](examples/mysql))
- **PostgreSQL**: `Database`, `Grant`, `Extension`, `Role` (See [the examples](examples/postgresql))
- **MSSQL**: `Database`, `Grant`, `User` (See [the examples](examples/mssql))

[Crossplane]: https://crossplane.io
[CloudSQLInstance]: https://doc.crds.dev/github.com/crossplane/provider-gcp/database.gcp.crossplane.io/CloudSQLInstance/[email protected]
[created automatically]: https://crossplane.io/docs/v1.5/concepts/managed-resources.html#connection-details
[**MySQL**]: examples/mysql
[**PostgreSQL**]: examples/postgresql
[**MSSQL**]: examples/mssql

0 comments on commit 0594d35

Please sign in to comment.