readme

Author: Andrea Cambieri

Readme.md

@@ -121,20 +121,118 @@ continuity pool add http://my-app.domain.com -i 30 -t 10 -d 35 --health-ok 1 --h
 
 ### Add a server to the pool
 ```
+continuity server add  --pool POOL_HOSTNAME   # Pool hostname the server should be added to
+  --address SERVER_ADDRESS:PORT               # Address of the server (IP or hostname)
+ [--health-check /healthcheck_endpoint]       # Optional header name for routing condition
+ [--condition MY_HEADER=MY_VALUE]             # Optional header value for routing condition
+```
 
+Example:
+```bash
+continuity server add --pool http://my-app.domain.com --address docker-1:8080 --health-check /health
 ```
 
 ### Add a server with a routing condition to the pool
+```bash
+continuity server add --pool http://my-app.domain.com --address docker-2:8080 --condition X-HEADER=srv2
+```
+
 ### Add a server and remove an old server transactionally (zero downtime deployments)
+```
+continuity server transaction --pool POOL_HOSTNAME    # Pool hostname the server should be added to
+  -address NEW_SERVER_ADDRESS:PORT                    # Address of the new server (IP or hostname)
+  --remove-server OLD_SERVER_UUID                     # Address of the old server to remove
+ [--health-check /healthcheck_endpoint]               # Optional header name for routing condition
+ [--condition MY_HEADER=MY_VALUE]                     # Optional header value for routing condition
+```
+To obtain the server UUID, use the `continuity pool config POOLNAME` command (use `--json` for JSON output), see [View current configuration](#view-current-configuration) below.
+
+Example:
+```bash
+continuity server transaction --pool http://my-app.domain.com --address docker-3:8080 --remove-server 123e4567-e89b-12d3-a456-426614174000 --health-check /health
+```
+
 ### View current configuration
-### Json output
+```bash
+continuity pool config POOL_HOSTNAME   # Pool hostname to view configuration for
+ [--json]                               # Output in JSON format
+```
+
 ### Server statistics
+```bash
+continuity pool stats POOL_HOSTNAME    # Pool hostname to view statistics for
+ [--json]                               # Output in JSON format
+```
+
 ### Remove a server from a pool
+```
+continuity server remove --pool POOL_HOSTNAME   # Pool hostname the server should be removed from
+  --server SERVER_UUID                          # UUID of the server to remove
+```
+
+Example:
+```bash
+continuity server remove --pool http://my-app.domain.com --server 123e4567-e89b-12d3-a456-426614174000
+```
+
 ### Update a pool
+```
+continuity pool update POOL_HOSTNAME              # Pool hostname to update
+  --health-check-interval SECONDS           # Seconds between health checks, default 10s
+  --health-check-timeout SECONDS            # Health check connection timeout, default 5s
+  --health-check-initial-delay SECONDS      # Initial delay on new server registration before starting health checks, default 20s
+  --health-fail NUM_KO_RESPONSES_THRESHOLD  # Number of failed health checks before marking server as down, default 3
+  --health-ok NUM_OK_RESPONSES_THRESHOLD    # Number of successful health checks before marking server as healthy, default 2
+ [--sticky-sessions true/false]             # Enable sticky sessions
+ [--sticky-method [IP|AppCookie|LBCookie] ] # Sticky session method
+ [--cookie-name NAME]                       # Name of the application cookie to use for sticky sessions
+```
+Example:
+```bash
+continuity pool update http://my-app.domain.com --health-check-interval 20 --health-fail 5
+```
 ### Delete a pool
+```bash
+continuity pool delete POOL_HOSTNAME   # Pool hostname to delete
+```
 
 ## Server Usage
 
 ### Start the server
+If you are using the docker image, you can start the server as shown in the [Docker installation section](#docker).
+
+If you have installed the .deb or .rpm package, the server will be started automatically as a systemd service and you can manage it via systemctl:
+
+```bash
+sudo systemctl [start/stop/restart] continuity-server
+```
+
+if you have installed the statically linked binary or built from source, you can start the server with:
+
+```bash
+./continuity-server -config /path/to/config.yaml
+```
+If -config is not specified, the server will look for a config.yaml file in the current directory.
+
 ### Configuration file auto update
-### View server logs
+
+Every configuration update made via the CLI client or RESTful API is automatically persisted to the configuration file specified when starting the server.
+Please note that the file is overwritten on every change, so if you are manually editing the file don't use the CLI / API at the same time to avoid losing changes.
+
+### View server logs
+
+The server will print logs to stdout, so if you are running it via docker you can view the logs with:
+
+```bash
+docker logs -f <container_id>
+```
+If you are running the server as a systemd service, you can view the logs with:
+
+```bash
+sudo journalctl -u continuity-server -f
+```
+If you are running the server manually, the logs will be printed to the terminal and is up to you to redirect them to a file:
+
+```bash
+./continuity-server -config /path/to/config.yaml >> /path/to/log/continuity-server.log 2>&1 &
+```