docs: use neutral placeholder agent names in examples
The setup page's first-agent example named the agent iris, and a user copied it verbatim. Use <name> there, with a line saying the name is free to choose, and agent1/agent2 in the hivectl, schedule and label examples.
This commit is contained in:
parent
c1d3b29710
commit
da071e3fa9
3 changed files with 17 additions and 17 deletions
|
|
@ -561,7 +561,7 @@ same third hive, such as a stale endpoint.
|
|||
is names only. Set it only for a hive addressed by something else. This
|
||||
hive's own `services.hyperhive.domain` comes from its entry; it drives
|
||||
`HYPERHIVE_HIVE_DOMAIN` in every container so agents can form qualified
|
||||
labels (`iris@firsthive.myswarm.example`). Setting `services.hyperhive.domain`
|
||||
labels (`agent1@firsthive.myswarm.example`). Setting `services.hyperhive.domain`
|
||||
directly overrides the directory entry, with a deprecation warning: the
|
||||
option is local to this host while every host shares the directory, so a
|
||||
value written only here is invisible to the rest of the swarm.
|
||||
|
|
|
|||
|
|
@ -13,15 +13,15 @@ sets itself, it uses `remind`, which stays inside its container.
|
|||
## Managing them
|
||||
|
||||
```console
|
||||
# swarmctl schedule add --name standup --agent scribe --agent iris \
|
||||
# swarmctl schedule add --name standup --agent agent2 --agent agent1 \
|
||||
--body "post the standup summary" --at 2026-10-05T09:00:00+02:00 --every 1d
|
||||
added schedule kqzpmwab
|
||||
kqzpmwab "standup" every 1d from 2026-10-05T07:00:00Z next 2026-10-05T07:00:00Z agents: iris, scribe | post the standup summary
|
||||
kqzpmwab "standup" every 1d from 2026-10-05T07:00:00Z next 2026-10-05T07:00:00Z agents: agent1, agent2 | post the standup summary
|
||||
|
||||
# swarmctl schedule list
|
||||
# swarmctl schedule list --agent scribe
|
||||
# swarmctl schedule list --agent agent2
|
||||
# swarmctl schedule edit kqzpmwab --body "post the standup summary to the team room"
|
||||
# swarmctl schedule edit kqzpmwab --add-agent atlas --remove-agent iris
|
||||
# swarmctl schedule edit kqzpmwab --add-agent agent3 --remove-agent agent1
|
||||
# swarmctl schedule pause kqzpmwab
|
||||
# swarmctl schedule resume kqzpmwab
|
||||
# swarmctl schedule rm kqzpmwab
|
||||
|
|
|
|||
|
|
@ -804,7 +804,7 @@ controller refuses IP addresses, other wildcards, ports and paths, and a name
|
|||
the proxy already allows every agent (the base list). The dialog shows the
|
||||
refusal's reason under the box and leaves what you typed. Adding does a
|
||||
`POST /api/egress/allowed-domains` and removing a `DELETE` of the same path,
|
||||
each with `{"domain": "github.com", "agent": "atlas"}` (leave out `agent` for
|
||||
each with `{"domain": "github.com", "agent": "agent1"}` (leave out `agent` for
|
||||
a swarm-wide entry); both answer the whole list, and `GET` reads it. Adding
|
||||
an entry that exists changes nothing.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue