Nginx-Consul-Template

An example template for rendering an nginx configuration file with Consul Template.

Description

The purpose of this project is creating dynamic configurations with Consul Template which can query a service entries, keys, and key values in Consul.

Usage

This example assumes Consul and Consul Template are installed.

Example

• Register Entity

    curl -X PUT http://your-ip:8500/v1/catalog/register -d'{"Node" : "server1", "Address" : "192.168.46.115", "Service":{"Service": "test", "Port":1234}, "NodeMeta":{"location" : "test", "upstream" : "test"}}'
    curl -X PUT http://your-ip:8500/v1/catalog/register -d'{"Node" : "server2", "Address" : "192.168.46.155", "Service":{"Service": "test", "Port":1234}, "NodeMeta":{"location" : "test", "upstream" : "test"}}'

• Run Consul Template

consul-template -consul-addr 127.0.0.1:8500 \
    -template "consul_server_conf.tpl:/opt/openresty/nginx/conf/consul_server.conf" \
    -template "consul_upstream_conf.tpl:/opt/openresty/nginx/conf/consul_upstream.conf" \
    -exec=" /opt/openresty/nginx/sbin/nginx -c /opt/openresty/nginx/conf/consul.conf -s reload "

• Output You should see output similar to the following:

-- consul_upstream.conf
upstream test {
    server 192.168.46.115:1234 max_fails=3 fail_timeout=10 weight=1;
    server 192.168.46.155:1234 max_fails=3 fail_timeout=10 weight=1;
}

-- consul_server.conf
server {
    listen 1234;
    location /test{
        proxy_pass http://test;
    }
}

Copyright and License

The MIT License (MIT) Copyright (c) 2017 xiaoxuanzi [email protected]

See Also

• Consul Template: https://github.com/hashicorp/consul-template
• Consul: https://www.consul.io/