docs: Consul API Gateway scaling config #13333
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ces and deployment.minInstances
github-actions
bot
added
the
type/docs
mikemorris
added
pr/no-changelog
mikemorris
force-pushed
the
docs/capig-instances-config
branch
from
a68b85c to
3afe19c
Compare
mikemorris
force-pushed
the
docs/capig-instances-config
branch
from
3afe19c to
f2f011c
Compare
website/content/docs/api-gateway/consul-api-gateway-install.mdx
Outdated
Show resolved
Hide resolved
boruszak
approved these changes
Jun 7, 2022
website/content/docs/api-gateway/consul-api-gateway-install.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/api-gateway/consul-api-gateway-install.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Jeff Boruszak <[email protected]>
Co-authored-by: Jeff Boruszak <[email protected]>
| @@ -168,6 +168,9 @@ The following table describes the allowed parameters for the `spec` array: | |||
| | `consul.ports.http` | Specifies the port for Consul's HTTP server. | Integer | `8500` | | |||
| | `consul.scheme` | Specifies the scheme to use for connecting to Consul. The supported values are `"http"` and `"https"`. | String | `"http"` | | |||
| | `copyAnnotations.service` | List of annotations to copy to the gateway service. | Array | `["external-dns.alpha.kubernetes.io/hostname"]` | | |||
| | `deployment.defaultInstances` | Specifies the number of instances to deploy by default for each gateway. | Integer | 1 | | |||
| | `deployment.maxInstances` | Specifies the maximum allowed number of instances per gateway. | Integer | 8 | | |||
There was a problem hiding this comment.
Should we mention that 8 is the absolute max for this value?
2 tasks
nathancoleman
removed
the
pr/do-not-merge
|
Going to go ahead and merge since the base has changed from |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add docs for GatewayClasConfig
defaultInstances,maxInstancesandminInstancesfields, and instructions for manually scaling the number of replicas for a Gateway Deployment.This should not be published until after the next release of Consul API Gateway.
Testing & Reproduction steps
apiGateway.imageconfig inlocal/consul/config.yamlto use a Docker image built from themainbranch of http://github.com/hashicorp/consul-api-gateway/deployment.defaultInstances,deployment.maxInstancesanddeployment.minInstancesmanually in a GatewayClassConfig after removing themanagedGatewayClassconfig fromlocal/consul/config.yamlin a fresh deployment, then creating a Gateway (Deployment replicas should initially reflectdeployment.defaultInstances) and attempting to scale the Deployment outside of the set bounds.Links
PR Checklist
updated test coverage