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
# NGINX Plus Integration with AWS Auto Scaling groups -- nginx-asg-sync
3
+
# NGINX Plus Integration with Cloud Autoscaling -- nginx-asg-sync
4
4
5
-
**nginx-asg-sync** allows [NGINX Plus](https://www.nginx.com/products/) to discover instances of [AWS Auto Scaling groups](http://docs.aws.amazon.com/autoscaling/latest/userguide/WhatIsAutoScaling.html). When the number of instances in an Auto Scaling group changes, nginx-asg-sync adds the new instances to the NGINX Plus configuration and removes the terminated ones.
5
+
**nginx-asg-sync** allows [NGINX Plus](https://www.nginx.com/products/) to discover instances (virtual machines) of a scaling group of a cloud provider. The following providers are supported:
When the number of instances changes, nginx-asg-sync adds the new instances to the NGINX Plus configuration and removes the terminated ones.
6
11
7
12
## How It Works
8
-
nginx-asg-sync is an agent process that runs on the same EC2 instance as NGINX Plus. It polls for changes to the backend Auto Scaling groups via the AWS Auto Scaling API.
13
+
nginx-asg-sync is an agent process that runs on the same instance as NGINX Plus. It polls for changes to the backend instance groups via the Cloud Provider API.
14
+
9
15
When it sees that a scaling event has happened, it adds or removes the corresponding backend instances from the NGINX Plus configuration via the NGINX Plus API.
10
16
11
-
**Note:** nginx-asg-sync does not scale Auto Scaling groups, it only gets the IP addresses of the instances of Auto Scaling groups.
17
+
**Note:** nginx-asg-sync does not scale cloud scaling groups, it only gets the IP addresses of the instances in the groups.
12
18
13
-
In the example below, NGINX Plus is configured to load balance among the instances of two Auto Scaling groups -- Backend One and Backend Two.
19
+
In the example below (AWS), NGINX Plus is configured to load balance among the instances of two AWS Auto Scaling groups -- Backend One and Backend Two.
14
20
nginx-asg-sync, running on the same instance as NGINX Plus, ensures that whenever you scale the Auto Scaling groups, the corresponding instances are added (or removed) from the NGINX Plus configuration.
@@ -21,15 +27,13 @@ Below you will find documentation on how to use nginx-asg-sync.
21
27
**Note:** the documentation for **the latest stable release** is available via a link in the description of the release. See the [releases page](https://github.com/nginxinc/nginx-asg-sync/releases).
22
28
23
29
**Contents:**
24
-
-[NGINX Plus Integration with AWS Auto Scaling groups -- nginx-asg-sync](#nginx-plus-integration-with-aws-auto-scaling-groups----nginx-asg-sync)
30
+
-[NGINX Plus Integration with Cloud Autoscaling -- nginx-asg-sync](#nginx-plus-integration-with-cloud-autoscaling----nginx-asg-sync)
-[Configuration for Cloud Providers](#configuration-for-cloud-providers)
33
37
-[Usage](#usage)
34
38
-[Troubleshooting](#troubleshooting)
35
39
-[Building a Software Package](#building-a-software-package)
@@ -45,13 +49,6 @@ We provide packages for the following operating systems:
45
49
46
50
Support for other operating systems can be added.
47
51
48
-
## Setting up Access to the AWS API
49
-
50
-
nginx-asg-sync uses the AWS API to get the list of IP addresses of the instances of an Auto Scaling group. To access the AWS API, nginx-asg-sync must have credentials. To provide credentials to nginx-asg-sync:
51
-
52
-
1.[Create an IAM role](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) and attach the predefined `AmazonEC2ReadOnlyAccess` policy to it. This policy allows read-only access to EC2 APIs.
53
-
1. When you launch the NGINX Plus instance, add this IAM role to the instance.
54
-
55
52
## Installation
56
53
57
54
1. Get a software package for your OS:
@@ -61,17 +58,15 @@ nginx-asg-sync uses the AWS API to get the list of IP addresses of the instances
61
58
* For Amazon Linux or CentOS/RHEL, run: `$ sudo rpm -i <package-name>.rpm`
62
59
* For Ubuntu, run: `$ sudo dpkg -i <package-name>.deb`
63
60
64
-
## Configuration
61
+
### NGINX Plus Configuration
65
62
66
-
As an example, we configure NGINX Plus to load balance two AWS Auto Scaling groups -- backend-group-one and backend-group-two. NGINX Plus routes requests to the appropriate Auto Scaling group based on the request URI:
63
+
As an example, we configure NGINX Plus to load balance two groups of instances -- backend-group-one and backend-group-two. NGINX Plus routes requests to the appropriate group based on the request URI:
67
64
68
65
* Requests for /backend-one go to Backend One group.
69
66
* Requests for /backend-two go to Backend Two group.
70
67
71
68
This example corresponds to [the diagram](#how-it-works) at the top of this README.
72
69
73
-
### NGINX Plus Configuration
74
-
75
70
```nginx
76
71
upstream backend-one {
77
72
zone backend-one 64k;
@@ -93,10 +88,30 @@ server {
93
88
proxy_pass http://backend-one;
94
89
}
95
90
91
+
location @hc-backend-one {
92
+
internal;
93
+
proxy_connect_timeout 1s;
94
+
proxy_read_timeout 1s;
95
+
proxy_send_timeout 1s;
96
+
97
+
proxy_pass http://backend-one;
98
+
health_check interval=1s mandatory;
99
+
}
100
+
96
101
location /backend-two {
97
102
proxy_set_header Host $host;
98
103
proxy_pass http://backend-two;
99
104
}
105
+
106
+
location @hc-backend-two {
107
+
internal;
108
+
proxy_connect_timeout 1s;
109
+
proxy_read_timeout 1s;
110
+
proxy_send_timeout 1s;
111
+
112
+
proxy_pass http://backend-two;
113
+
health_check interval=1s mandatory;
114
+
}
100
115
}
101
116
102
117
server {
@@ -112,40 +127,18 @@ server {
112
127
}
113
128
```
114
129
115
-
* We declare two upstream groups – **backend-one** and **backend-two**, which correspond to our Auto Scaling groups. However, we do not add any servers to the upstream groups, because the servers will be added by nginx-aws-sync. The `state` directive names the file where the dynamically configurable list of servers is stored, enabling it to persist across restarts of NGINX Plus.
130
+
* We declare two upstream groups – **backend-one** and **backend-two**, which correspond to our instance groups. However, we do not add any servers to the upstream groups, because the servers will be added by nginx-aws-sync. The `state` directive names the file where the dynamically configurable list of servers is stored, enabling it to persist across restarts of NGINX Plus.
116
131
* We define a virtual server that listens on port 80. NGINX Plus passes requests for **/backend-one** to the instances of the Backend One group, and requests for **/backend-two** to the instances of the Backend Two group.
117
132
* We define a second virtual server listening on port 8080 and configure the NGINX Plus API on it, which is required by nginx-asg-sync:
118
133
* The API is available at **127.0.0.1:8080/api**
119
134
120
-
### nginx-asg-sync Configuration
121
-
122
-
nginx-asg-sync is configured in **/etc/nginx/aws.yaml**. For our example, we define the following configuration:
123
-
124
-
```yaml
125
-
region: us-west-2
126
-
api_endpoint: http://127.0.0.1:8080/api
127
-
sync_interval_in_seconds: 5
128
-
cloud_provider: AWS
129
-
upstreams:
130
-
- name: backend-one
131
-
autoscaling_group: backend-one-group
132
-
port: 80
133
-
kind: http
134
-
- name: backend-two
135
-
autoscaling_group: backend-two-group
136
-
port: 80
137
-
kind: http
138
-
```
135
+
Because cloud provider APIs return the instances IP addresses before the instances are ready and/or provisioned, we recommend setting up mandatory active [healthchecks](http://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check) for all upstream groups - **@hc-backend-one** and **@hc-backend-two**. This way, NGINX Plus won't pass any request to an instance that is still being provisioned or has been deleted recently.
136
+
137
+
Small timeouts ensure that a health check will fail fast if the backend instance is not healthy. Also, the mandatory parameter ensures NGINX Plus won't consider a newly added instance healthy until a health check passes.
138
+
139
+
### Configuration for Cloud Providers
139
140
140
-
* The `region` key defines the AWS region where we deploy NGINX Plus and the Auto Scaling groups.
141
-
* The `api_endpoint` key defines the NGINX Plus API endpoint.
142
-
* The `sync_interval_in_seconds` key defines the synchronization interval: nginx-asg-sync checks for scaling updates every 5 seconds.
143
-
* The `cloud_provider` key defines a cloud provider that will be used. The default is `AWS`. This means the key can be empty if using AWS.
144
-
* The `upstreams` key defines the list of upstream groups. For each upstream group we specify:
145
-
* `name` – The name we specified for the upstream block in the NGINX Plus configuration.
146
-
* `autoscaling_group` – The name of the corresponding Auto Scaling group.
147
-
* `port` – The port on which our backend applications are exposed.
148
-
* `kind` – The protocol of the traffic NGINX Plus load balances to the backend application, here `http`. If the application uses TCP/UDP, specify `stream` instead.
141
+
See the example for your cloud provider: [AWS](examples/aws.md), [Azure](examples/azure.md).
0 commit comments