Skip to content

Commit

Permalink
Merge pull request #115 from amalgam8/doc_updates
Browse files Browse the repository at this point in the history
removed service list commands
  • Loading branch information
GregHanson authored Mar 31, 2017
2 parents ec00768 + baed95a commit fc95456
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 46 deletions.
29 changes: 5 additions & 24 deletions _docs/1-demo/bookinfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,31 +116,12 @@ _IBM Bluemix_
```
where <bookinfo_route_name> is the route name used in the `bluemix cf create-route` command.

### List the Services in the App
### Services in the App

You can view the microservices that are running using the following command:

```bash
a8ctl service-list
```

The expected output is the following:

```bash
+-------------+------------------------------+
| Service | Instances |
+-------------+------------------------------+
| details | version=v1(1) |
| productpage | version=v1(1) |
| ratings | version=v1(1) |
| reviews | version=v1(1), version=v2(1) |
+-------------+------------------------------+
```

There are 4 microservices as described in the diagram above. The `reviews`
microservice has 3 versions v1, v2, and v3. Note that in a realistic
deployment, new versions of a microservice are deployed over time
instead of deploying all versions simultaneously.
There are 4 microservices. The `reviews` microservice has 3 versions
v1, v2, and v3. Note that in a realistic deployment, new versions of
a microservice are deployed over time instead of deploying all versions
simultaneously.

## Set the default routes

Expand Down
18 changes: 1 addition & 17 deletions _docs/1-demo/helloworld.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,23 +90,7 @@ _IBM Bluemix_
export GATEWAY_URL=helloworld.mybluemix.net
```

### List the Services in the App

You can view the microservices that are running using the following command:

```bash
a8ctl service-list
```

The expected output is the following:

```bash
+------------+------------------------------+
| Service | Instances |
+------------+------------------------------+
| helloworld | version=v1(1), version=v2(1) |
+------------+------------------------------+
```
### Services in the App

There are 4 instances of the helloworld service. Two are instances of
version "v1" and the other two belong to version "v2".
Expand Down
2 changes: 1 addition & 1 deletion _docs/2-controlplane/1-controller/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ order: 2
$ git clone [email protected]:amalgam8/amalgam8.git
$ cd amalgam8
# trick makefile to generate all with a "latest" version tag by setting version to "vlatest"
$ APP_VER_ABBR=vlatest make build.sidecar build.exampleapps build.k8srules dockerize.sidecar.envoy.ubuntu dockerize.k8srules
$ APP_VER_ABBR=vlatest make build.controller build.sidecar build.exampleapps dockerize.sidecar.envoy.ubuntu dockerize.controller
```
Expand Down
43 changes: 39 additions & 4 deletions _docs/2-controlplane/1-controller/rules-dsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ but must rather be represented using two seperate rules in the DSL.
* [route.backends.weight](#route-backends-weight)
* [route.backends.name](#route-backends-name)
* [route.backends.resilience](#route-backends-resilience)
* [route.backends.lbtype])(#route-backends-lbtype)
* [route.httpreqtimeout](#route.httpreqtimeout)
* [route.httpreqretries](#route.httpreqretries)
* [route.uri](#route.uri)
* [route.lbtype](#route-lbtype)
* [route.httpreqtimeout](#route-httpreqtimeout)
* [route.httpreqretries](#route-httpreqretries)
* [route.uri](#route-uri)
* [Action Rules](#action-rules)
* [actions](#actions)
* [actions.action](#actions-action)
Expand Down Expand Up @@ -222,6 +222,31 @@ A routing rule is one that contains a `route` field in the A8 Rules DSL.
The `route` field is an object, although currently with only one nested field, `backends`, a list of weighted backends for the route.
*(Note: More fields will be added to the route object in future versions of the Rules DSL.)*

#### Property: route.lbtype <a id="route-lbtype"></a>

Supported proxy load balancing algorithms are:

* `round_robin`
* `least_request`
* `random`

Default is `round_robin`.

#### Property route.httpreqtimeout <a id="route-httpreqtimeout"></a>

Timeout for a HTTP request. Includes retries as well. Unit is in floating point seconds. Default 15.0s

#### Property route.httpreqretries <a id="route-httpreqretries"></a>

Number of retries for a given request. The interval between retries will be determined automatically (25ms+).
Actual number of retries attempted depends on the http_req_timeout.

#### Property route.uri <a id="route-uri"></a>

* `path`
* `prefix`
* `prefix_rewrite`

#### Property: route.backends <a id="route-backends"></a>

Each backend in the `backends` list is an object with the following fields.
Expand Down Expand Up @@ -275,6 +300,16 @@ the "v2" tag and the remaining traffic (i.e., 75%) to "v1".
The `name` field is optional and specifies the service name of the target instances. If not specified, it defaults
to the value of the rule's `destination` field.

#### Property: route.backends.resilience <a id="route-backends-resilience"></a>

* `max_connections`: Maximum number of connections to a backend. Defaults to 1024.
* `max_pending_requests`: Maximum number of pending requests to a backend. Defaults to 1024.
* `max_requests`: Maximum number of requests to a backend. Defaults to 1024
* `sleep_window`: Minimum time the circuit will be closed. Defaults to 30s
* `consecutive_errors`: Number of 5XX errors before circuit is opened. Defaults to 5
* `detection_interval`: Interval for checking state of circuit. Defaults to 10s.
* `max_requests_per_connection`: Maximum number of requests per connection to an backend.

### Routing Rule Execution

Whenever the routing story for a particular microservice is purely weight base,
Expand Down

0 comments on commit fc95456

Please sign in to comment.