Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formatting and minor wording changes in Readme #57

Merged
merged 1 commit into from
Nov 26, 2021
Merged

Formatting and minor wording changes in Readme #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 15 additions & 18 deletions README.md
View file
Open in desktop
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/v1beta1@v0.18.0
[created automatically]: https://crossplane.io/docs/v1.5/concepts/managed-resources.html#connection-details
[**MySQL**]: examples/mysql
[**PostgreSQL**]: examples/postgresql
[**MSSQL**]: examples/mssql