Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
XAMPPRocky committed Oct 10, 2023
1 parent 3bdb278 commit 8ca75b4
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions docs/src/deployment/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,36 @@ The admin interface provides the following endpoints:
This provides a liveness probe endpoint, most commonly used in
[Kubernetes based systems](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-command).

Will return an HTTP status of 200 when all health checks pass.
Liveness is defined as "hasn't panicked", as long as the process has not
panicked quilkin is considered live.

### /ready

This provides a readiness probe endpoint, most commonly used in
[Kubernetes based systems](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes).

Depending on whether Quilkin is run in Proxy mode i.e. `quilkin proxy`, vs an xDS provider mode, such as `quilkin
manage agones`, will dictate how readiness is calculated:
Readiness is service and provider specific, so based on what you're running
there will be different criteria for a service to be considered ready. Here's
a list of the criteria for each service an provider.

| Service | Readiness |
|---------|---------------------------------------------------------------------|
| Proxy | Management server is connected (or always true if config is static) |
| Manage | Provider is ready |
| Relay | Provider is ready |
| Agent | Provider is ready AND connected to relay |

| Provider | Readiness |
|----------|--------------------------------------------|
| Agones | The service is connected to kube-api |
| File | The service has found and watches the file |

When setting thresholds for your `proxy` probes, you generally want to set a low
check period (e.g. `periodSeconds=1`) and a low success threshold
(e.g. `successThreshold=1`), but a high `failureThreshold`
(e.g. `failureThreshold=60`) and `terminationGracePeriodSeconds` to allow for
backoff attempts and existing player sessions to continue without disruption.


#### Proxy Mode

Expand All @@ -67,4 +88,4 @@ See the [xDS Metrics](../services/xds/metrics.md) documentation for what xDS met
Returns a JSON representation of the cluster and filterchain configuration that the instance is running
with at the time of invocation.

[log-docs]: https://docs.rs/env_logger/latest/env_logger/#enabling-logging
[log-docs]: https://docs.rs/env_logger/latest/env_logger/#enabling-logging

0 comments on commit 8ca75b4

Please sign in to comment.