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

Typo "Azure database for MySQL"→"Azure Database for MySQL" #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Typo "Azure database for MySQL"→"Azure Database for MySQL" #39

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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ With the Azure MySQL Action for GitHub, you can automate your workflow to deploy

Get started today with a [free Azure account](https://azure.com/free/open-source)!

This repository contains GitHub Action for [Azure database for MySQL server](https://github.com/Azure/mysql) to deploy .
This repository contains GitHub Action for [Azure Database for MySQL server](https://github.com/Azure/mysql) to deploy .

The action uses Connection String for authentication and SQL scripts to deploy to your MySQL database.

Expand All @@ -26,15 +26,15 @@ Connecton string parameter is kept for backward compatability, not to break any

* Authenticate using [Azure Login](https://github.com/Azure/login)

For the action to run, the IP Address of the GitHub Action runner (automation agent) must be added to the 'Allowed IP Addresses' by setting [MySQL server firewall rules](https://docs.microsoft.com/en-us/azure/mysql/howto-manage-firewall-using-portal) in Azure. Without the firewall rules, the runner cannot communicate with Azure database for MySQL.
For the action to run, the IP Address of the GitHub Action runner (automation agent) must be added to the 'Allowed IP Addresses' by setting [MySQL server firewall rules](https://docs.microsoft.com/en-us/azure/mysql/howto-manage-firewall-using-portal) in Azure. Without the firewall rules, the runner cannot communicate with Azure Database for MySQL.

By default, the action would auto-detect the IP Address of the runner to automatically add firewall exception rule. These firewall rules will be deleted after the action executes.

However, this auto-provisioning of firewall rules needs a pre-req that the workflow includes an `azure/login@v1` action before the `azure/mysql-action@v1` action. Also, the service principal used in the Azure login action needs to have elevated permissions, i.e. membership in SQL Security Manager RBAC role, or a similarly high permission in the database to create the firewall rule.

Alternatively, if enough permissions are not granted on the service principal or login action is not included, then the firewall rules have to be explicitly managed by user using CLI/PS scripts.

### Create an Azure database for MySQL server and deploy using GitHub Actions
### Create an Azure Database for MySQL server and deploy using GitHub Actions

1. Follow the tutorial [Azure Database for MySQL server Quickstart](https://docs.microsoft.com/en-us/azure/mysql/quickstart-create-mysql-server-database-using-azure-portal)
2. Copy the MySQL-on-Azure.yml template from [starter templates](https://github.com/Azure/actions-workflow-samples/tree/master/Database) and paste the template contents into `.github/workflows/` within your project repository as workflow.yml.
Expand Down Expand Up @@ -73,7 +73,7 @@ Follow the steps to configure the secret:

> If you want to use the connection string, please refer [ConnectionString properties](https://docs.microsoft.com/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring?redirectedfrom=MSDN&view=dotnet-plat-ext-3.1#remarks) for handling special characters in connection string.

#### Sample workflow to deploy to an Azure database for MySQL server
#### Sample workflow to deploy to an Azure Database for MySQL server

##### Using a connection string (deprecated)

Expand Down