a8ctl 0.2.2

Amalgam8 Command Line Interface

Command-line tool for Amalgam8 (http://www.amalgam8.io/).

Installation

To install the Amalgam8 CLI:

pip install a8ctl # for latest
pip install a8ctl==<version> # for specific version, e.g., pip install a8ctl==0.1.8

For usage information, run the following command:

a8ctl -h

Commands

a8ctl service-list

a8ctl route-list
a8ctl route-set <service> [--default <version>] [--selector <version> "(" <condition> ")"]*
a8ctl route-delete <service>

a8ctl rule-list
a8ctl rule-set --source <service> --destination <service> [--header <string>] [--patern <regexp>] [--delay-probability <float>] [--delay <float>] [--abort-probability <float>] [--abort-code <code>]
a8ctl rule-clear

a8ctl traffic-start <service> <version> [--amount <percent>]
a8ctl traffic-step <service> [--amount <percent>]
a8ctl traffic-abort <service>

Examples

$ a8ctl service-list
+-------------+---------------------+
| Service     | Instances           |
+-------------+---------------------+
| reviews     | v1(1), v2(1), v3(1) |
| productpage | v1(1)               |
| ratings     | v1(1)               |
| helloworld  | v1(2), v2(2)        |
| details     | v1(1)               |
| serviceA    | UNVERSIONED(1)      |
+-------------+---------------------+

$ a8ctl route-list
+-------------+-----------------+---------------------------------------+
| Service     | Default Version | Version Selectors                     |
+-------------+-----------------+---------------------------------------+
| productpage | v1              |                                       |
| reviews     | v1              | v2(user="frankb"), v3(user="shriram") |
| ratings     | v1              |                                       |
| details     | v1              |                                       |
| helloworld  | v1              | v2(weight=0.25)                       |
| serviceA    | UNVERSIONED     |                                       |
+-------------+-----------------+---------------------------------------+

$ a8ctl route-set reviews --default v1 --selector 'v2(user="frankb")' --selector 'v3(user="shriram")'
Set routing rules for microservice reviews

$ a8ctl rule-list
+---------+-------------+----------------+----------------+-------------------+-------+-------------------+------------+
| Source  | Destination | Header         | Header Pattern | Delay Probability | Delay | Abort Probability | Abort Code |
+---------+-------------+----------------+----------------+-------------------+-------+-------------------+------------+
| reviews | ratings     | X-Gremlin-Test | *              | 0.5               | 7     | 0                 | 0          |
+---------+-------------+----------------+----------------+-------------------+-------+-------------------+------------+

$ a8ctl rule-set --source reviews --destination ratings --header X-Gremlin-Test --pattern=\* --delay-probability 0.5 --delay 7
Set fault injection rule between reviews and ratings

$ a8ctl rule-clear
Cleared fault injection rules from all microservices

$ a8ctl traffic-start reviews v2
Transfer starting for reviews: diverting 10% of traffic from v1 to v2
$ a8ctl traffic-step reviews
Transfer step for reviews: diverting 20% of traffic from v1 to v2
$ a8ctl traffic-step reviews --amount 40
Transfer step for reviews: diverting 40% of traffic from v1 to v2
...
$ a8ctl traffic-step reviews
Transfer step for reviews: diverting 90% of traffic from v1 to v2
$ a8ctl traffic-step reviews
Transfer complete for reviews: sending 100% of traffic to v2

$ a8ctl traffic-start reviews v2
Transfer starting for reviews: diverting 10% of traffic from v1 to v2
$ a8ctl traffic-abort reviews
Transfer aborted for reviews: all traffic reverted to v1

Documentation

Documentation is available at http://www.amalgam8.io/.

Contributing

Proposals and pull requests will be considered. Please see the https://github.com/amalgam8/amalgam8.github.io/blob/master/CONTRIBUTING.md file for more information.