Release 0.1.1 (#72)

Author: lucacome

.github/workflows/ci.yml

@@ -135,3 +135,5 @@ jobs:
           cache-to: type=gha,mode=max
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            CONFIG_FILE=configs/example_global.yaml

CHANGELOG.md

@@ -1,3 +1,7 @@
-# 0.1-1 
+# 0.1.1 (Aug 29, 2022)
+
+An automatically generated list of changes can be found on GitHub at: [0.1.1 Release](https://github.com/nginxinc/nginx-ns1-gslb/releases/tag/v0.1.1)
+
+# 0.1-1
 
 Initial Release

Makefile

@@ -1,5 +1,5 @@
 
-VERSION = 0.1-1
+VERSION = 0.1.1
 TAG = $(VERSION)
 PREFIX = nginx/nginx-ns1-gslb
 TARGET ?= local

README.md

@@ -29,19 +29,39 @@ This will run an Agent that fetches stats from one or more NGINX Plus instances,
 
 ### Docker
 
+You can either build the Docker image yourself, or use the [official Docker image](https://github.com/nginxinc/nginx-ns1-gslb/pkgs/container/nginx-ns1-gslb).
+
+#### Build the Docker image
+
 1. Build the image specifying the config file:
-`make CONFIG_FILE=<path/to/your_file.yaml> container`
+
+    `make CONFIG_FILE=<path/to/your_file.yaml> container`
 
     **Note**: By default the binary is built locally, if you need to build it inside a container append `TARGET=container` to the command above.
 
 1. Run the container:
-`docker run nginx/nginx-ns1-gslb:<version>`
 
-**Note:** consider the following while running the agent:
+    `docker run nginx/nginx-ns1-gslb:<version>`
+
+#### Pull the Docker image
+
+1. Alternatively, you can pull the image from GitHub Container Registry:
+
+    `docker pull ghcr.io/nginxinc/nginx-ns1-gslb:0.1.1`
+
+1. Run the container:
+
+    `docker run -v <path/to/your_file.yaml>:/etc/nginx-ns1-gslb/config.yaml ghcr.io/nginxinc/nginx-ns1-gslb:0.1.1`
+
+    **Note**: By default the Docker image contains an example config, so you need to mount you configuration file like shown in the command above `-v <path/to/your_file.yaml>:/etc/nginx-ns1-gslb/config.yaml`.
 
-* All NGINX Plus instances must be reachable and running when the agent is run for the first time.
-* While running, if at least 1 Instance of NGINX Plus is working, the agent will use the data from that one.
-* While running, if all NGINX Plus instances are off, the agent will send `{up: false}` to NS1 API for all the configured services.
+> **Note**
+>
+> Consider the following while running the agent:
+>
+> * All NGINX Plus instances must be reachable and running when the agent is run for the first time.
+> * While running, if at least 1 Instance of NGINX Plus is working, the agent will use the data from that one.
+> * While running, if all NGINX Plus instances are off, the agent will send `{up: false}` to NS1 API for all the configured services.
 
 ## Tests
 Run `make test` to run the tests.

build/Dockerfile

@@ -1,7 +1,7 @@
 FROM alpine:3.16 as base
 ARG CONFIG_FILE
 
-RUN apk update && apk add ca-certificates && rm -rf /var/cache/apk/*
+RUN apk add --no-cache ca-certificates
 
 COPY ${CONFIG_FILE} /etc/nginx-ns1-gslb/config.yaml
 

configs/example_global.yaml

@@ -21,4 +21,4 @@ services:
   method: "global"
   feeds:
     - feed_name: "<NS1-datafeed-1>"
-    - feed_name: "<NS1-datafeed-2>"
+    - feed_name: "<NS1-datafeed-2>"

configs/example_upstreams.yaml

@@ -23,4 +23,4 @@ services:
   sampling_type: "count"
   feeds:
     - name: "<my_backend>"
-      feed_name: "<NS1-datafeed-1>"
+      feed_name: "<NS1-datafeed-1>"

configs/example_zones.yaml

@@ -21,4 +21,4 @@ services:
   method: "status_zones"
   feeds:
     - name: "zone01.com"
-      feed_name: "<NS1-datafeed-1>"
+      feed_name: "<NS1-datafeed-1>"