You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+24-24
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
# NGINX for Azure Deployment Action
2
2
3
-
This action supports managing the configuration of an an [NGINX for Azure](https://docs.nginx.com/nginx-for-azure/quickstart/overview/) deployment in a GitHub repository. It enables continuous deployment through GitHub workflows to automatically update the NGINX for Azure deployment when changes are made to the NGINX configuration files stored in the respository.
3
+
This action supports managing the configuration of an [NGINX for Azure](https://docs.nginx.com/nginx-for-azure/quickstart/overview/) deployment in a GitHub repository. It enables continuous deployment through GitHub workflows to automatically update the NGINX for Azure deployment when changes are made to the NGINX configuration files stored in the respository.
4
4
5
5
## Connecting to Azure
6
6
7
7
This action leverages the [Azure Login](https://github.com/marketplace/actions/azure-login) action for authenticating with Azure and performing update to an NGINX for Azure deployment. Two different ways of authentication are supported:
8
8
-[Service principal with secrets](https://docs.microsoft.com/en-us/azure/developer/github/connect-from-azure?tabs=azure-portal%2Cwindows#use-the-azure-login-action-with-a-service-principal-secret)
9
-
-[OpenID Connect](https://docs.microsoft.com/en-us/azure/developer/github/connect-from-azure?tabs=azure-portal%2Cwindows#use-the-azure-login-action-with-openid-connect) (OIDC) with a Azure service principal using a Federated Identity Credential
9
+
-[OpenID Connect](https://docs.microsoft.com/en-us/azure/developer/github/connect-from-azure?tabs=azure-portal%2Cwindows#use-the-azure-login-action-with-openid-connect) (OIDC) with an Azure service principal using a Federated Identity Credential
10
10
11
-
### Sample workflow that authenticates with Azure using Azure Service Principal with a secret
11
+
### Sample workflow that authenticates with Azure using an Azure service principal with a secret
12
12
13
13
```yaml
14
14
# File: .github/workflows/nginxForAzureDeploy.yml
15
15
16
-
name: Sync the NGINX configuration from the Git repository to an NGINX for Azure deployment
16
+
name: Sync the NGINX configuration from the GitHub repository to an NGINX for Azure deployment
17
17
on:
18
18
push:
19
19
branches:
@@ -28,13 +28,13 @@ jobs:
28
28
- name: 'Checkout repository'
29
29
uses: actions/checkout@v2
30
30
31
-
- name: 'Run Azure Login using Azure Service Principal with a secret'
31
+
- name: 'Run Azure Login using an Azure service principal with a secret'
32
32
uses: azure/login@v1
33
33
with:
34
34
creds: ${{ secrets.AZURE_CREDENTIALS }}
35
35
36
-
- name: 'Sync the NGINX configuration from the Git repository to the NGINX for Azure deployment'
37
-
uses: nginxinc/nginx-for-azure-deploy-action@v1
36
+
- name: 'Sync the NGINX configuration from the GitHub repository to the NGINX for Azure deployment'
To facilitate the migration of the existing NGINX configuration, NGINX for Azure supports multiple-files configuration with each file uniquely identified by a file path, just like how NGINX configuration files are created and used in a self-hosting machine. An NGINX configuration file can include another file using the [include directive](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/). The file path used in an include directive can either be an absolute path or a relative path to the [prefix path](https://www.nginx.com/resources/wiki/start/topics/tutorials/installoptions/).
90
+
To facilitate the migration of the existing NGINX configuration, NGINX for Azure supports multiple-files configuration with each file uniquely identified by a file path, just like how NGINX configuration files are created and used in a self-hosting machine. An NGINX configuration file can include another file using the [include directive](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/). The file path used in an `include` directive can either be an absolute path or a relative path to the [prefix path](https://www.nginx.com/resources/wiki/start/topics/tutorials/installoptions/).
91
91
92
-
The following example shows two NGINX configuration files inside the `/etc/nginx` directory on disk are copied and stored in the a GitHub respository under its `config` directory.
92
+
The following example shows two NGINX configuration files inside the `/etc/nginx` directory on disk are copied and stored in a GitHub respository under its `config` directory.
93
93
94
-
| File path on disk | File path in respository |
94
+
| File path on disk | File path in the respository |
To use this action to sync the configuration files from this example, the directory path relative to the GitHub repository root `config/` is set to the action's input `nginx-config-directory-path` for the action to find and package the configuration files. The root file `nginx.conf` is set to the input `nginx-root-config-file`.
100
100
101
101
```yaml
102
-
- name: 'Sync the NGINX configuration from the Git repository to the NGINX for Azure deployment'
103
-
uses: nginxinc/nginx-for-azure-deploy-action@v1
102
+
- name: 'Sync the NGINX configuration from the GitHub repository to the NGINX for Azure deployment'
@@ -111,10 +111,10 @@ To use this action to sync the configuration files from this example, the direct
111
111
112
112
By default, the action uses a file's relative path to `nginx-config-directory-path` in the respository as the file path in the NGINX for Azure deployment.
113
113
114
-
| File path on disk | File path in respository | File path in NGINX for Azure |
The default file path handling works for the case of using relative paths in `include` directives, for example, if the root `nginx.conf` references `mysite.conf` using:
120
120
@@ -132,7 +132,7 @@ The action supports an optional input `transformed-nginx-config-directory-path`
132
132
133
133
```yaml
134
134
- name: 'Sync the NGINX configuration from the Git repository to the NGINX for Azure deployment'
0 commit comments