Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update agent documentation #976

Merged
merged 1 commit into from
Jun 5, 2024
Merged

Update agent documentation #976

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions docs/src/services/agent.md
View file
Open in desktop
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
Loading