docs: Self review of doc pages
This commit is contained in:
@@ -20,15 +20,15 @@ Directory `0700`, file `0600`. The install script sets both.
|
||||
```yaml
|
||||
server_url: "vantage.yourdomain.com:9090"
|
||||
server_id: "<uuid>"
|
||||
pre_reg_token: "<token>" # removed after the first successful Register()
|
||||
agent_token: "" # written by the agent after Register()
|
||||
pre_reg_token: "<token>" # cleared once the agent has registered
|
||||
agent_token: "" # written by the agent when it registers
|
||||
poll_interval: 30s
|
||||
tls: true
|
||||
```
|
||||
|
||||
| Field | Meaning |
|
||||
| --------------- | --------------------------------------------------------------------- |
|
||||
| `server_url` | `host:port` of the gRPC endpoint. Comes from the server's `GRPC_HOST` |
|
||||
| `server_url` | The `host:port` the agent connects to. Comes from your `GRPC_HOST` |
|
||||
| `server_id` | The identity issued when the enrolment was created |
|
||||
| `pre_reg_token` | Single-use, one hour. Cleared once registration succeeds |
|
||||
| `agent_token` | The permanent credential, written by the agent itself |
|
||||
@@ -36,8 +36,8 @@ tls: true
|
||||
| `tls` | Whether to use TLS. Leave `true` |
|
||||
|
||||
:::danger This file is the credential
|
||||
`agent_token` is plaintext here and nowhere else the control plane holds only
|
||||
its SHA-256. Anyone who can read this file can act as this agent.
|
||||
`agent_token` exists in full only in this file. Anyone who can read it can act
|
||||
as this agent.
|
||||
:::
|
||||
|
||||
## Service management
|
||||
@@ -77,5 +77,5 @@ rm -rf /etc/vantage
|
||||
systemctl daemon-reload
|
||||
```
|
||||
|
||||
Keys already written to `authorized_keys` remain on disk the agent is no
|
||||
longer running to remove them. Revoke first if that matters.
|
||||
Keys already written to `authorized_keys` remain on disk, because the agent is
|
||||
no longer running to remove them. Revoke first if that matters.
|
||||
|
||||
Reference in New Issue
Block a user