Skip to content

Commit

Permalink
Release 1.8 into main (#305)
Browse files Browse the repository at this point in the history
* Release 1.8.0-rc.1 (#301)

* Latest autogen docs for 1.8

* Release v1.8.0-rc.1

* Bump versions for 1.8.0-rc.1, fix typos from issue/297

* Release 1.8 (#303)

* Latest autogen docs for 1.8

* Release v1.8.0-rc.1

* Bump versions for 1.8.0-rc.1, fix typos from issue/297

* remove rc from release 1.8

---------

Co-authored-by: Joseph Holley <joeholley@users.noreply.github.com>
  • Loading branch information
kemurayama and joeholley committed Jan 18, 2024
1 parent 356700b commit 6a59d69
Show file tree
Hide file tree
Showing 7 changed files with 1,221 additions and 32 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
# If you want information on how to edit this file checkout,
# http://makefiletutorial.com/

BASE_VERSION = 1.7.0
BASE_VERSION = 1.8.0
SHORT_SHA = $(shell git rev-parse --short=7 HEAD | tr -d [:punct:])
VERSION_SUFFIX = $(SHORT_SHA)
BRANCH_NAME = $(shell git rev-parse --abbrev-ref HEAD | tr -d [:punct:])
Expand Down
2 changes: 1 addition & 1 deletion cloudbuild.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ steps:
path: '/go'

substitutions:
_OM_VERSION: "1.7.0"
_OM_VERSION: "1.8.0"
_GCB_POST_SUBMIT: "0"
_GCB_LATEST_VERSION: "undefined"
logsBucket: 'gs://open-match-site-build-logs/'
Expand Down
4 changes: 2 additions & 2 deletions site/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ github_docs_repo = "https://github.com/googleforgames/open-match-docs"
gcs_engine_id = "008748710159674449076:sqoelpnrdoe"

release_branch = "main"
release_version = "1.7.0"
release_version = "1.8.0"
slack_link = "https://join.slack.com/t/open-match/shared_invite/enQtNDM1NjcxNTY4MTgzLTM5ZWQxNjc1YWI3MzJmN2RiMWJmYWI0ZjFiNzNkZmNkMWQ3YWU5OGVkNzA5Yzc4OGVkOGU5MTc0OTA5ZTA5NDU"

# Enable syntax highlighting and copy buttons on code blocks with Prism
Expand Down Expand Up @@ -126,4 +126,4 @@ expiryDate = ["expiryDate"]
[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
unsafe = true
15 changes: 4 additions & 11 deletions site/content/en/docs/Installation/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: >

## Prerequisites

- [Helm](https://docs.helm.sh/helm/) package manager 3.0.0+
- [Kubernetes](https://kubernetes.io) cluster, tested on Kubernetes version 1.13+
- [Helm](https://docs.helm.sh/helm/) package manager, tested on version 3.12.3+
- [Kubernetes](https://kubernetes.io) cluster, tested on Kubernetes version 1.27+

## Install the Open Match helm chart

Expand Down Expand Up @@ -91,11 +91,10 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm

```bash
helm install --name open-match --namespace open-match open-match/open-match \
--set open-match-telemetry.enabled=true \
--set open-match-telemetry.jaeger.enabled=true
--set open-match-telemetry.enabled=true
```

The above command sets the namespace where Open Match is deployed to `open-match`. Additionally turn on the telemetry exporters and deploy Jaeger along with Open Match core services.
The above command sets the namespace where Open Match is deployed to `open-match`, and turns on the telemetry exporters along with installing Open Match core services.

The following tables lists the configurable parameters of the Open Match chart and their default values.

Expand All @@ -114,7 +113,6 @@ The following tables lists the configurable parameters of the Open Match chart a
| `open-match-core.proposalCollectionInterval` | Length of time after match function has started before it will be canceled. | `20s` |
| `open-match-core.pendingReleaseTimeout` | Defines the time before a ticket returns to the pool after it was fetched. | `1m` |
| `open-match-core.assignedDeleteTimeout` | Time after a ticket has been assigned before it is automatically deleted. | `10m` |
| `open-match-core.queryPageSize` | Maximum number of tickets to return on a single QueryTicketsResponse. | `10000` |
| `open-match-core.backfillLockTimeout` | Defines the time of keeping a lock on a single backfill. | `1m` |
| `open-match-override.enabled` | Turn on/off the installation of `om-override-configmap` | `false` |
| `open-match-telemetry.enabled` | Turn on/off the installation of Open Match telemetry services | `false` |
Expand All @@ -127,10 +125,6 @@ The following tables lists the configurable parameters of the Open Match chart a
| `global.tls.rootca.mountPath` | The VolumeMount path for TLS CA | `/app/secrets/tls/rootca` |
| `global.logging.rpc.enabled` | Turn on/off RPC payload logging for all Open Match core services | `false` |
| `global.telemetry.zpages.enabled` | Turn on/off Open Match zPages instrument. | `true` |
| `global.telemetry.jaeger.enabled` | Turn on/off Open Match Jaeger exporter. Also install Jaeger if `open-match-telemetry.enabled` is set to true | `false` |
| `global.telemetry.jaeger.samplerFraction` | Configure a sampler that samples a given fraction of traces | `1` |
| `global.telemetry.jaeger.agentEndpoint` | AgentEndpoint instructs exporter to send spans to jaeger-agent at this address | `open-match-jaeger-agent:6831` |
| `global.telemetry.jaeger.collectorEndpoint` | CollectorEndpoint is the full url to the Jaeger HTTP Thrift collector | `open-match-jaeger-collector:14268/api/traces` |
| `global.telemetry.prometheus.enabled` | Turn on/off Open Match Prometheus exporter. Also install Prometheus if `open-match-telemetry.enabled` is set to true | `false` |
| `global.telemetry.prometheus.endpoint` | Bind the Prometheus exporters to the specified endpoint handler, also configures the `prometheus.io/path` k8s scraping annotations | `/metrics` |
| `global.telemetry.prometheus.serviceDiscovery` | If Prometheus is enabled and `serviceDiscover: true`, add the Prometheus scraping annotations to each Pod of the Open Match core services | `true` |
Expand All @@ -139,7 +133,6 @@ The following tables lists the configurable parameters of the Open Match chart a
| `global.telemetry.grafana.enabled` | Turn on/off Open Match Grafana exporter. Also install Grafana if `open-match-telemetry.enabled` is set to true | `false` |
| `global.telemetry.reportingPeriod` | Overrides the reporting periods of Open Match telemetry exporters | `1m` |
| `open-match-telemetry.grafana` | Inherits the values from [Grafana helm chart](https://github.com/helm/charts/tree/master/stable/grafana) | |
| `open-match-telemetry.jaeger` | Inherits the values from [Jaeger helm chart](https://github.com/helm/charts/tree/master/incubator/jaeger) | |
| `open-match-telemetry.prometheus` | Inherits the values from [Prometheus helm chart](https://github.com/helm/charts/tree/master/stable/prometheus) | |
| `redis` | Inherits the values from the [Bitnami Redis Helm chart](https://github.com/bitnami/charts/tree/master/bitnami/redis) | |

Expand Down
18 changes: 8 additions & 10 deletions site/content/en/docs/Installation/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >

## Prerequisites

- [Kubernetes](https://kubernetes.io) cluster, tested on Kubernetes version 1.13+
- [Kubernetes](https://kubernetes.io) cluster, tested on Kubernetes version 1.27+

## Install Core Open Match

Expand All @@ -18,7 +18,6 @@ The `01-open-match-core.yaml` contains:

* Core Open Match service deployments.
* A Redis deployment as Open Match's state storage system.
* ServiceAccounts, Roles, and RoleBindings to define Open Match deployments' IAMs.
* HorizontalAutoScalars to auto-scale Open Match based on pods' average CPU utilization.

Here is the command to install the Open Match core in your cluster:
Expand All @@ -40,18 +39,18 @@ kubectl get -n open-match pod
```
Output:
NAME READY STATUS RESTARTS AGE
om-backend-76d8d76c96-fmhmn 0/1 ContainerCreating 0 3m53s
om-frontend-57fc9f6b66-86hxj 0/1 ContainerCreating 0 3m53s
om-query-799d8549d4-5qpgx 0/1 ContainerCreating 0 3m53s
om-swaggerui-867d79b885-m9q6x 0/1 ContainerCreating 0 3m54s
om-synchronizer-7f48f84dfd-j8swx 0/1 ContainerCreating 0 3m54s
NAME READY STATUS RESTARTS AGE
open-match-backend-76d8d76c96-fmhmn 0/1 ContainerCreating 0 3m53s
open-match-frontend-57fc9f6b66-86hxj 0/1 ContainerCreating 0 3m53s
open-match-query-799d8549d4-5qpgx 0/1 ContainerCreating 0 3m53s
open-match-swaggerui-867d79b885-m9q6x 0/1 ContainerCreating 0 3m54s
open-match-synchronizer-7f48f84dfd-j8swx 0/1 ContainerCreating 0 3m54s
```

{{% alert title="Note" color="info" %}}
Open Match needs to be customized to run as a Matchmaker.
This custom configuration is provided to the Open Match components via a ConfigMap
(<code>om-configmap-override</code>).
(<code>open-match-configmap-override</code>).

Thus, starting the core service pods will remain in <code>ContainerCreating</code> until this config map is available.
{{% /alert %}}
Expand All @@ -75,7 +74,6 @@ kubectl apply --namespace open-match \
To delete Open Match and the corresponding sample components from this cluster, simply run:

```bash
kubectl delete psp,clusterrole,clusterrolebinding --selector=release=open-match
kubectl delete namespace open-match
```

Expand Down
Loading

0 comments on commit 6a59d69

Please sign in to comment.