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

Production Best Practices Doc Updates #186

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion site/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ github_docs_repo = "https://github.com/googleforgames/open-match-docs"
# Google Custom Search Engine ID. Remove or comment out to disable search.
gcs_engine_id = "008748710159674449076:sqoelpnrdoe"

release_branch = "master"
release_branch = "release-1.0"
release_version = "1.0.0"
slack_link = "https://join.slack.com/t/open-match/shared_invite/enQtNDM1NjcxNTY4MTgzLTM5ZWQxNjc1YWI3MzJmN2RiMWJmYWI0ZjFiNzNkZmNkMWQ3YWU5OGVkNzA5Yzc4OGVkOGU5MTc0OTA5ZTA5NDU"

Expand Down
17 changes: 15 additions & 2 deletions site/content/en/docs/Guides/Production/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,18 @@ Open Match project provides a recommended helm config file for production setups
helm install my-release -n open-match open-match/open-match -f values-production.yaml
```

## Use Enovy or other load balancing solution if you plan to connect to Open Match via an out-of-cluster client
The above load balancing solution is sufficient if you have both the client and the server deployment within the same cluster. However, some game architectures may requires connecting to Open Match services from an out-of-cluster client. We recommend [Envoy](https://www.envoyproxy.io/) as a solution. Alternatives like Kubernetes Ingress or platform specific L7 Load Balancer can also work.
## Use Envoy or other load balancing solution if you plan to connect to Open Match via an out-of-cluster client
The above load balancing solution is sufficient if you have both the client and the server deployment within the same cluster. However, some game architectures may requires connecting to Open Match services from an out-of-cluster client. We recommend [Envoy](https://www.envoyproxy.io/) as a solution. Alternatives like Kubernetes Ingress or platform specific L7 Load Balancer can also work.

## Increase memory limits for query request for performance boost
When querying Tickets in Open Match, there is a possibility of requests being larger or smaller than configured. Open Match comes default with the following configuration:
```yaml
resources:
limits:
cpu: 100m
memory: 100Mi
requests:
cpu: 100m
memory: 100Mi
```
We recommend increasing the limit for memory to accomodate larger than expected query requests. For more information on Kubernetes Best Practices, please consult the following [Blog Post](https://cloud.google.com/blog/products/gcp/kubernetes-best-practices-resource-requests-and-limits) as a reference.
Binary file removed site/static/swaggerui/favicon-16x16.png
Binary file not shown.
Binary file removed site/static/swaggerui/favicon-32x32.png
Binary file not shown.
60 changes: 0 additions & 60 deletions site/static/swaggerui/index.html

This file was deleted.

67 changes: 0 additions & 67 deletions site/static/swaggerui/oauth2-redirect.html

This file was deleted.

100 changes: 0 additions & 100 deletions site/static/swaggerui/swagger-ui-bundle.js

This file was deleted.

1 change: 0 additions & 1 deletion site/static/swaggerui/swagger-ui-bundle.js.map

This file was deleted.

Loading