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.

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

Add dynamic proxy configuration #150

Merged
merged 4 commits into from
Dec 7, 2020
Merged
Changes from 1 commit
Commits
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
27 changes: 27 additions & 0 deletions docs/proxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,40 @@ properties:
type: object
description: |
Static configuration of endpoints and filters.
NOTE: Exactly one of `static` or `dynamic` can be specified.
properties:
filter:
'$ref': '#/definitions/filterchain'
endpoints:
'$ref': '#/definitions/endpoints'
required:
- endpoints
dynamic:
Copy link
Member

@markmandel markmandel Dec 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a oneOf with children of dynamic and static ? https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/#oneof

Or would that be too complicated for the documentation? (Not for this PR, but maybe we should split this up into separate docs)

Actually, this would be the link of oneOf, yes? http://json-schema.org/draft-04/json-schema-validation.html#rfc.section.5.5 ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah ideally it'll be oneof but oneof is a bit weird at the top level, instead of being able to say oneof static or dynamic at the top level, we can only say oneof or which might be more complex

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good - just wanted to check 👍

type: object
description: |
Dynamic configuration of endpoints and filters.
NOTE: Exactly one of `static` or `dynamic` can be specified.
properties:
filter:
'$ref': '#/definitions/filterchain'
management_servers:
type: array
description: |
A list of XDS management servers to fetch configuration from.
Multiple servers can be provided for redundancy for the proxy to
fall back to upon error.
items:
type: object
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`
required:
- management_servers

required:
- version
Expand Down