Skip to content

Commit

Permalink
Update CLI reference documentation (#303)
Browse files Browse the repository at this point in the history
* Add missing category in metrics-categories cli option

* Fix wrong default for validators-external-signer-timeout

* Add alias for data-path in import and export commands

* Fix wrong default for log-include-validator-duties-enabled option

* Fix wrong default for metrics-interface option

* Add default value for log-file-name-pattern option

* Add data-validator-path option to slashing-protection commands

* Add validators-early-attestations-enabled option to vc command

* Add external signer keystore options to vc command

* Add external signer keystore options to voluntary-exit command

* Add validators-graffiti-file option to vc command

* Add external signer trust store options to vc command

* Add external signer truststore options to voluntary-exit command

* Fix linter errors

* Apply suggestions from code review

* update syntax and address reviewer comments

Co-authored-by: Alexandra Tran <12214231+alexandratran@users.noreply.github.com>
Co-authored-by: Alexandra Tran <alexandratran@protonmail.com>
  • Loading branch information
3 people committed Nov 10, 2021
1 parent d3e5504 commit f431a45
Show file tree
Hide file tree
Showing 5 changed files with 405 additions and 34 deletions.
7 changes: 3 additions & 4 deletions docs/Reference/CLI/CLI-Syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,7 @@ The default Docker image location is `/root/.local/share/teku/logs`.
log-file-name-pattern: "tekuL_%d{yyyy-MM-dd}.log"
```

Filename pattern to apply when creating log files.
Filename pattern to apply when creating log files. The default pattern is `teku_%d{yyyy-MM-dd}.log`

### log-include-events-enabled

Expand Down Expand Up @@ -726,8 +726,7 @@ default, Teku accepts access from `localhost` and `127.0.0.1`.
metrics-categories: ["BEACON", "JVM", "PROCESS"]
```

Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `EVENTBUS`,
`EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`,
Categories for which to track metrics. Options are `JVM`, `PROCESS`, `BEACON`, `DISCOVERY`, `EVENTBUS`, `EXECUTOR`, `LIBP2P`, `NETWORK`, `STORAGE`, `STORAGE_HOT_DB`, `STORAGE_FINALIZED_DB`,
`REMOTE_VALIDATOR`, `VALIDATOR`, `VALIDATOR_PERFORMANCE`. All categories are enabled by default.

### metrics-interface
Expand Down Expand Up @@ -1752,7 +1751,7 @@ using Teku to sign blocks and attestations always uses its built-in slashing pro
validators-external-signer-timeout: 2000
```

Timeout in milliseconds for requests to the external signer. The default is 1000.
Timeout in milliseconds for requests to the external signer. The default is 5000.

### validators-external-signer-truststore

Expand Down
22 changes: 11 additions & 11 deletions docs/Reference/CLI/Subcommands/Migrate-Database.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ title: Database migration subcommand options
--config-file=<FILE>
```

=== "Command Line"
=== "Example"

```bash
--config-file=/home/me/me_node/config.yaml
```

=== "Environment Variable"
=== "Environment variable"

```bash
TEKU_CONFIG_FILE=/home/me/me_node/config.yaml
Expand All @@ -42,19 +42,19 @@ The default is `none`.
--data-base-path=<PATH>
```

=== "Command Line"
=== "Example"

```bash
--data-base-path=/home/me/me_node
```

=== "Environment Variable"
=== "Environment variable"

```bash
TEKU_DATA_BASE_PATH=/home/me/me_node
```

=== "Configuration File"
=== "Configuration file"

```bash
data-base-path: "/home/me/me_node"
Expand All @@ -76,19 +76,19 @@ The default Docker image location is `/root/.local/share/teku`.
--data-beacon-path=<PATH>
```

=== "Command Line"
=== "Example"

```bash
--data-beacon-path=/home/me/me_node
```

=== "Environment Variable"
=== "Environment variable"

```bash
TEKU_DATA_BEACON_PATH=/home/me/me_node
```

=== "Configuration File"
=== "Configuration file"

```bash
data-beacon-path: "/home/me/me_node"
Expand All @@ -105,19 +105,19 @@ is specified using [`--data-base-path`](#data-base-path-data-path).
--network=<NETWORK>
```

=== "Command Line"
=== "Example"

```bash
--network=mainnet
```

=== "Environment Variable"
=== "Environment variable"

```bash
TEKU_NETWORK=mainnet
```

=== "Configuration File"
=== "Configuration file"

```bash
network: "mainnet"
Expand Down
94 changes: 82 additions & 12 deletions docs/Reference/CLI/Subcommands/Slashing-Protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,39 @@ Path to the Teku data directory. The default directory is OS-dependent:
* Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku`
* Windows: `%localappdata%\teku`.

### data-validator-path

=== "Syntax"

```bash
teku slashing-protection import --data-validator-path=<PATH>
```

=== "Example"

```bash
teku slashing-protection import --data-validator-path=/home/me/me_validator
```

=== "Environment variable"

```bash
TEKU_DATA_VALIDATOR_PATH=/home/me/me_validator
```

=== "Configuration file"

```bash
data-validator-path: "/home/me/me_validator"
```

Path to the validator client data.
The default is `<data-path>/validator` where `<data-path>` is specified using [`--data-path`](#data-path).

!!! info

Teku imports slashing protection data into a `slashprotection` directory under the validator client data directory.

### from

=== "Syntax"
Expand Down Expand Up @@ -128,6 +161,39 @@ Path to the Teku data directory. The default directory is OS-dependent:
* Unix/Linux: `$XDG_DATA_HOME/teku` if `$XDG_DATA_HOME` is set; otherwise `~/.local/share/teku`
* Windows: `%localappdata%\teku`.

### data-validator-path

=== "Syntax"

```bash
teku slashing-protection export --data-validator-path=<PATH>
```

=== "Example"

```bash
teku slashing-protection export --data-validator-path=/home/me/me_validator
```

=== "Environment variable"

```bash
TEKU_DATA_VALIDATOR_PATH=/home/me/me_validator
```

=== "Configuration file"

```bash
data-validator-path: "/home/me/me_validator"
```

Path to the validator client data.
The default is `<data-path>/validator` where `<data-path>` is specified using [`--data-path`](#data-path).

!!! info

Teku exports slashing protection data from the `slashprotection` directory under the validator client data directory.

### to

=== "Syntax"
Expand Down Expand Up @@ -158,7 +224,7 @@ Repairs corrupted slashing-protection data files used by Teku.
teku slashing-protection repair --checking-only-enabled[=<BOOLEAN>]
```

=== "Command Line"
=== "Example"

```bash
teku slashing-protection repair --checking-only-enabled=false
Expand All @@ -175,7 +241,7 @@ You can specify which files are checked using [`--config-file`](#config-file_2),
teku slashing-protection repair --config-file=<FILE>
```

=== "Command Line"
=== "Example"

```bash
teku slashing-protection repair --config-file=/home/me/me_node/config.yaml
Expand All @@ -184,18 +250,18 @@ You can specify which files are checked using [`--config-file`](#config-file_2),
Path to the YAML configuration file.
The default is `none`.

### data-base-path, data-path
### data-path

=== "Syntax"

```bash
teku slashing-protection repair --data-base-path=<PATH>
teku slashing-protection repair --data-path=<PATH>
```

=== "Command Line"
=== "Example"

```bash
teku slashing-protection repair --data-base-path=/home/me/me_node
teku slashing-protection repair --data-path=/home/me/me_node
```

Path to the Teku data directory. The default directory is OS-dependent:
Expand All @@ -214,14 +280,18 @@ The default Docker image location is `/root/.local/share/teku`.
teku slashing-protection repair --data-validator-path=<PATH>
```

=== "Command Line"
=== "Example"

```bash
teku slashing-protection repair --data-validator-path=/home/me/me_validator
```

Path to validator client data. The default is `<data-base-path>/validator` where `<data-base-path>`
is specified using [`--data-base-path`](#data-base-path-data-path).
Path to validator client data.
The default is `<data-path>/validator` where `<data-path>` is specified using [`--data-path`](#data-path).

!!! info

The slashing protection data is stored in a `slashprotection` directory under the validator client data directory.

### network

Expand All @@ -231,7 +301,7 @@ is specified using [`--data-base-path`](#data-base-path-data-path).
teku slashing-protection repair --network=<NETWORK>
```

=== "Command Line"
=== "Example"

```bash
teku slashing-protection repair --network=mainnet
Expand Down Expand Up @@ -260,7 +330,7 @@ bootnodes, and the address of the Ethereum 1.0 deposit contract.
teku slashing-protection repair --slot=<INTEGER>
```

=== "Command Line"
=== "Example"

```bash
teku slashing-protection repair --slot=1028
Expand All @@ -281,7 +351,7 @@ slot, or after when the validators stopped performing duties.
teku slashing-protection repair --update-all-enabled[=<BOOLEAN>]
```

=== "Command Line"
=== "Example"

```bash
teku slashing-protection repair --update-all-enabled=false
Expand Down
Loading

0 comments on commit f431a45

Please sign in to comment.