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.

Sign up for GitHub

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

Jump to bottom

Move the README.md into /agones/ so it's in the Helm Chart #466

Merged
merged 1 commit into from
Jan 1, 2019
Merged

Move the README.md into /agones/ so it's in the Helm Chart #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 docs/limiting_resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ If you do not set a limit or request, the default is set my Kubernetes at a 100m
You may also want to tweak the CPU request or limits on the SDK `GameServer` sidecar process that spins up alongside
each game server container.

You can do this through the [Helm configuration](../install/helm/README.md#configuration) when installing Agones.
You can do this through the [Helm configuration](../install/helm/agones/README.md#configuration) when installing Agones.

By default, this is set to having a CPU request value of 30m, with no hard CPU limit. This ensures that the sidecar always has enough CPU
to function, but it is configurable in case a lower, or higher value is required on your clusters, or if you desire
Expand Down
2 changes: 1 addition & 1 deletion docs/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Finally include that `ServiceMonitor` in your [Prometheus instance CRD](https://
### Stackdriver

We don't yet support the [OpenCensus Stackdriver exporter](https://opencensus.io/exporters/supported-exporters/go/stackdriver/) but you can still use the Prometheus Stackdriver integration by following these [instructions](https://cloud.google.com/monitoring/kubernetes-engine/prometheus).
Annotations required by this integration can be activated by setting the `agones.metrics.prometheusServiceDiscovery` to true (default) via the [helm chart value](../install/helm/README.md#configuration).
Annotations required by this integration can be activated by setting the `agones.metrics.prometheusServiceDiscovery` to true (default) via the [helm chart value](../install/helm/agones/README.md#configuration).

## Metrics available

Expand Down
2 changes: 1 addition & 1 deletion docs/ping_service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ for the purpose of timing how long the rountrip takes for information to be retu

By default, Agones installs [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/) for
both HTTP and the UDP ping endpoints. These can be disabled entirely,
or disabled individually. See the [Helm install guide](../install/helm/README.md) for the parameters to pass through,
or disabled individually. See the [Helm install guide](../install/helm/agones/README.md) for the parameters to pass through,
as well as configuration options.

The ping services as all installed under the `agones-system` namespace.
Expand Down
2 changes: 1 addition & 1 deletion install/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ Also, we can install Agones using [Helm][helm] package manager. If you want more
options see the [Helm installation guide for Agones][agones-install-guide]

[helm]: https://docs.helm.sh
[agones-install-guide]: helm/README.md
[agones-install-guide]: helm/agones/README.md

## Confirming Agones started successfully

Expand Down
6 changes: 3 additions & 3 deletions install/helm/README.md → install/helm/agones/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ The following tables lists the configurable parameters of the Agones chart and t
| `gameservers.maxPort` | Maximum port to use for dynamic port allocation | `8000` |

[constraints]: https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/cpu-constraint-namespace/
[ping]: ../../docs/ping_service.md
[ping]: ../../../docs/ping_service.md
[service]: https://kubernetes.io/docs/concepts/services-networking/service/

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
Expand All @@ -145,7 +145,7 @@ Alternatively, a YAML file that specifies the values for the parameters can be p
$ helm install --name my-release --namespace agones-system -f values.yaml agones/agones
```

> **Tip**: You can use the default [values.yaml](agones/values.yaml)
> **Tip**: You can use the default [values.yaml](values.yaml)

## TLS Certificates

Expand All @@ -156,4 +156,4 @@ For most used cases the controller would have required a restart anyway (eg: con

## Confirm Agones is running

To confirm Agones is up and running, [go to the next section](../README.md#confirming-agones-started-successfully)
To confirm Agones is up and running, [go to the next section](../../README.md#confirming-agones-started-successfully)