Skip to content

Commit

Permalink
Update configuration reference docs
Browse files Browse the repository at this point in the history
Update the configuration reference docs to include `clusters` and
`localities`.

Work on googleforgames#546
  • Loading branch information
markmandel committed Aug 25, 2022
1 parent 578af87 commit 97e2e3f
Showing 1 changed file with 46 additions and 30 deletions.
76 changes: 46 additions & 30 deletions docs/src/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,37 +39,53 @@ properties:
Configuration of proxy admin HTTP interface.
properties:
address:
type: string
description: |
Socket Address and port to bind the administration interface to.
default: [::]:9091
type: string
description: |
Socket Address and port to bind the administration interface to.
default: "[::]:9091"
filters:
type: array
description: |
A filter chain.
items:
'$ref': {} # Refer to the Filter documentation for a filter configuration schema.
endpoints:
type: array
clusters:
type: object
description: |
A list of upstream endpoints to forward packets to.
items:
grouping of clusters, each with a key for a name
additionalProperties:
type: object
description: |
An upstream endpoint
properties:
address:
type: string
description: |
Socket address of the endpoint. This must be of the ´IP:Port` form e.g `192.168.1.1:7001`
metadata:
type: object
description: |
Arbitrary key value pairs that is associated with the endpoint.
These are visible to Filters when processing packets and can be used to provide more context about endpoints (e.g whether or not to route a packet to an endpoint).
Keys must be of type string otherwise the configuration is rejected.
required:
- address
description: |
An individual cluster
properties:
localities:
type: array
description: |
grouping of endpoints, per cluster.
items:
type: object
properties:
endpoints:
type: array
description: |
A list of upstream endpoints to forward packets to.
items:
type: object
description: |
An upstream endpoint
properties:
address:
type: string
description: |
Socket address of the endpoint. This must be of the ´IP:Port` form e.g `192.168.1.1:7001`
metadata:
type: object
description: |
Arbitrary key value pairs that is associated with the endpoint.
These are visible to Filters when processing packets and can be used to provide more context about endpoints (e.g whether or not to route a packet to an endpoint).
Keys must be of type string otherwise the configuration is rejected.
required:
- address
management_servers:
type: array
description: |
Expand All @@ -78,14 +94,14 @@ properties:
fall back to upon error.
items:
type: object
description: |
Configuration for a management server.
properties:
address:
type: string
description: |
Configuration for a management server.
properties:
address:
type: string
description: |
Address of the management server. This must have the `http(s)` scheme prefix.
Example: `http://example.com`
Address of the management server. This must have the `http(s)` scheme prefix.
Example: `http://example.com`
```
[examples]: https://github.com/googleforgames/quilkin/blob/main/examples
Expand Down

0 comments on commit 97e2e3f

Please sign in to comment.