Configuration for Azure

Setting up Access to Azure API

nginx-asg-sync uses the Azure API to get the list of IP addresses of the instances of a Virtual Machine Scale Set. To access the Azure API, nginx-asg-sync must have credentials. To provide credentials to nginx-asg-sync:

Create the NGINX Plus VM with the system or user identity.
Create a Reader role for the selected subscription or resource group and assign it to the identity of the NGINX Plus VM.

nginx-asg-sync Configuration

nginx-asg-sync is configured in /etc/nginx/config.yaml.

api_endpoint: http://127.0.0.1:8080/api
sync_interval: 5s
cloud_provider: Azure
subscription_id: my_subscription_id
resource_group_name: my_resource_group
upstreams:
  - name: backend-one
    virtual_machine_scale_set: backend-one-group
    port: 80
    kind: http
    max_conns: 0
    max_fails: 1
    fail_timeout: 10s
    slow_start: 0s
  - name: backend-two
    virtual_machine_scale_set: backend-two-group
    port: 80
    kind: http
    max_conns: 0
    max_fails: 1
    fail_timeout: 10s
    slow_start: 0s

The api_endpoint key defines the NGINX Plus API endpoint.
The sync_interval key defines the synchronization interval: nginx-asg-sync checks for scaling updates every 5 seconds. The value is a string that represents a duration (e.g., 5s). The maximum unit is hours.
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. Possible values are: AWS, Azure.
The subscription_id key defines the Azure unique subscription id that identifies your Azure subscription.
The resource_group_name key defines the Azure resource group of your Virtual Machine Scale Set and Virtual Machine for NGINX Plus.
The upstreams key defines the list of upstream groups. For each upstream group we specify:
- name – The name we specified for the upstream block in the NGINX Plus configuration.
- virtual_machine_scale_set – The name of the corresponding Virtual Machine Scale Set.
- port – The port on which our backend applications are exposed.
- 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.
- max_conns – The maximum number of simultaneous active connections to an upstream server. Default value is 0, meaning there is no limit.
- max_fails – The number of unsuccessful attempts to communicate with an upstream server that should happen in the duration set by the fail-timeout to consider the server unavailable. Default value is 1. The zero value disables the accounting of attempts.
- fail_timeout – The time during which the specified number of unsuccessful attempts to communicate with an upstream server should happen to consider the server unavailable. Default value is 10s.
- slow_start – The slow start allows an upstream server to gradually recover its weight from 0 to its nominal value after it has been recovered or became available or when the server becomes available after a period of time it was considered unavailable. By default, the slow start is disabled.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!