Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

docs: general fixes and additions based on read through. #115

Merged
merged 1 commit into from
Dec 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This endpoint can be used to scale a Nomad job group out, therefore increasing i

```
$ curl \
--request PUT \
--request POST \
--data @payload.json \
http://127.0.0.1:8000/v1/scale/out/my-job/my-job-group?count=2
```
Expand Down Expand Up @@ -68,7 +68,7 @@ This endpoint can be used to scale a Nomad job group in, therefore decreasing it

```
$ curl \
--request PUT \
--request POST \
--data @payload.json \
http://127.0.0.1:8000/v1/scale/in/my-job/my-job-group?count=2
```
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $ sherpa <subcommand> -h

## CLI Command Structure

There are a number of command and subcommand options available. Construct your Vault CLI command such that the command options precede its and arguments if any:
There are a number of command and subcommand options available. Construct your Sherpa CLI command such that the command options precede its and arguments if any:

```bash
sherpa <command> <subcommand> [options] [args]
Expand Down
8 changes: 7 additions & 1 deletion docs/commands/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ The policy command groups subcommands for interacting with policies. Users can w

## Examples

Create an example job group scaling policy:
```bash
$ sherpa policy init
```

List all policies:
```bash
$ sherpa policy list
Expand Down Expand Up @@ -42,7 +47,8 @@ Usage:

Available Commands:
delete Deletes a scaling policy from Sherpa
init Creates an example job group scaling policy
list Lists all scaling policies
read Details the scaling policy
read Details scaling policies associated to a job
write Uploads a policy from file
```
2 changes: 1 addition & 1 deletion docs/commands/server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Server CLI

The server command starts a Sherpa server that responds to API requests. Please see the [configuration documentation](../configuration/_readme.md) for all server configuration options.
The server command starts a Sherpa server that responds to API requests. Please see the [configuration documentation](../configuration/README.md) for all server configuration options.

## Examples

Expand Down
6 changes: 6 additions & 0 deletions docs/commands/system.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ Output the latest metric data points for the running server:
$ sherpa system metrics
```

Get information about the backend HA status and leader:
```bash
$ sherpa system leader
```

## Usage
```bash
Usage:
Expand All @@ -28,5 +33,6 @@ Usage:
Available Commands:
health Retrieve health information of a Sherpa server
info Retrieve information about a Sherpa server
leader Check the HA status and current leader
metrics Retrieve metrics from a Sherpa server
```