DOC UPDATE: restgw new feature

README.md

@@ -40,6 +40,8 @@ IPs of AeroLab containers can be seen by running `aerolab cluster-list`
   * [Deploy a VS Code Client Machine](docs/usage/vscode.md) - Launch a [VS Code](https://code.visualstudio.com/) IDE in a browser, complete with Java, Go, Python and C# language clients, and code against your Aerospike cluster
   * [Deploy a Trino server](docs/usage/trino.md) - Launch a [Trino](https://trino.io/) server and shell, and query your Aerospike cluster with SQL
   * [Deploy a Jupyter Notebook Machine](docs/usage/jupyter.md) - Launch a Jupyter Notebook IDE in a browser, complete with Java, Go and Python language clients, and code against your Aerospike cluster
+  * [Deploy an ElasticSearch connector](docs/usage/elasticsearch.md)
+  * [Deploy a Rest Gateway](docs/usage/restgw.md)
 * [Useful Scripts](scripts/README.md)
   * [Create new certificates](scripts/CERTS.md)
   * [Deploy an LDAP server](scripts/aerolab-ldap/README.md)

docs/README.md

@@ -10,6 +10,7 @@
   * [Deploy a Trino server](usage/trino.md)
   * [Deploy a Jupyter Notebook Machine](usage/jupyter.md)
   * [Deploy an ElasticSearch connector](usage/elasticsearch.md)
+  * [Deploy a Rest Gateway](usage/restgw.md)
 * [Rest API](usage/REST.md)
 * [Useful scripts](../scripts/README.md)
   * [Deploy an LDAP server](../scripts/aerolab-ldap/README.md)

docs/usage/restgw.md

@@ -0,0 +1,31 @@
+# Deploying a Rest Gateway
+
+## Create a test cluster with three nodes
+
+```
+aerolab cluster create -n bob -c 3
+```
+
+## Insert test data into test namespace
+
+```
+aerolab data insert -z 10000 -u 5 -n bob -m test
+```
+
+## Deploy a rest gateway client
+
+```
+aerolab client create rest-gateway -n myrest -C bob
+```
+
+## Attach to the rest gateway machine and execute a scan
+
+```
+aerolab attach client -n myrest
+$ curl http://localhost:8080/v1/scan/test
+```
+
+## Notes
+
+* to adjust the seed IP or connect username or password at a later time, use the `aerolab client configure rest-gateway` command. Append `help` at the end of usage information
+* all settings can be adjusted, including the startup, by changing the startup script on the rest gateway machine, located at `/opt/autoload/01-restgw.sh`