Skip to content

Commit

Permalink
Update agent documentation (#976)
Browse files Browse the repository at this point in the history
Removes some outdated terminology and corrects incorrectly calling configuration sources control planes.
  • Loading branch information
XAMPPRocky authored Jun 5, 2024
1 parent 497f938 commit b818af1
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions docs/src/services/agent.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Control Plane Agents
# Quilkin Agent

| services | ports | Protocol |
|----------|-------|-------------------|
| QCMP | 7600 | UDP(IPv4 OR IPv6) |

For multi-cluster integration, Quilkin provides a `agent` service, that can be
deployed to a cluster to act as a beacon for QCMP pings and forward cluster
configuration information to a `relay` service
configuration information to a `relay` service.

Agent configuration and functionality matches that of Control Plane Providers, such as
Agent configuration sources matches that of the [Management Server](./xds.md), such as
[Filesystem](./xds/providers/filesystem.md) and [Agones](./xds/providers/agones.md).

To view all options for the `agent` subcommand, run:
Expand All @@ -18,9 +18,6 @@ $ quilkin agent --help
{{#include ../../../target/quilkin.agent.commands}}
```

> Each sub-control planes (`file`, `agones`, etc) matches the `quilkin manage` providers capabilities.
> Have a look at each of the [Control Plane > Providers](../services/xds.md) documentation for integration details.
## Quickstart
The simplest version of the `agent` service is just running `quilkin agent`,
this will setup just the QCMP service allowing the agent to be pinged for
Expand Down

0 comments on commit b818af1

Please sign in to comment.