Skip to content

Commit

Permalink
Adding missing documentation about: add option for extensions compone…
Browse files Browse the repository at this point in the history 
…nts to use host network and configure ports (#3912)

* Docs updated:

Added `agones.extensions.webhooks.port` & `agones.extensions.hostNetwork` params to helm installation
Added topic about using custom CNI plugins with EKS

* hide new options with feature shortcode for v1.43 release

* Update site/content/en/docs/Installation/Creating Cluster/eks.md

Co-authored-by: Mark Mandel <[email protected]>

* Update site/content/en/docs/Installation/Install Agones/helm.md

Co-authored-by: Mark Mandel <[email protected]>

* Update helm.md to reflect the new published version

* Update eks.md to reflect the new published version

* Update eks.md to remove the feature block since the feature is already released

* Update helm.md to remove the feature block since the feature is already released

* Update eks.md to fix an invalid link

---------

Co-authored-by: Zach Loafman <[email protected]>
Co-authored-by: Mark Mandel <[email protected]>
Co-authored-by: igooch <[email protected]>
Co-authored-by: Mengye (Max) Gong <[email protected]>
  • Loading branch information
@Orza @zmerlynn
@markmandel @igooch @gongmax
5 people authored Sep 19, 2024
1 parent 89038b6 commit 5c18bef
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 7 additions & 1 deletion site/content/en/docs/Installation/Creating Cluster/eks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ For Agones to work correctly, we need to allow UDP traffic to pass through to ou
* Select **Inbound Rules**
* **Edit Rules** to add a new **Custom UDP Rule** with a 7000-8000 port range and an appropriate **Source** CIDR range (`0.0.0.0/0` allows all traffic)

## Use with custom CNI plugins

To ensure compatibility with custom CNI plugins (such as Calico or [Cilium](https://docs.cilium.io/en/stable/installation/k8s-install-helm/)), configure extensions application to use `hostNetwork` for proper functionality via the `agones.extensions.hostNetwork` Agones [Helm]({{< relref "../Install Agones/helm.md" >}}) variable. Also make sure to set the `agones.extensions.http.port` and the `agones.extensions.webhooks.port` values as well.
This requirement arises due to the control plane's inability to reach in-cluster pod endpoints when the data plane operates on a separate network layer ([Github Issue](https://github.com/aws/containers-roadmap/issues/2227)).
Reconfiguring the kube-apiserver is not possible as it is an AWS managed component.

## Next Steps

- Continue to [Install Agones]({{< relref "../Install Agones/_index.md" >}}).
* Continue to [Install Agones]({{< relref "../Install Agones/_index.md" >}}).
10 changes: 2 additions & 8 deletions site/content/en/docs/Installation/Install Agones/helm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,9 @@ The following tables lists the configurable parameters of the Agones chart and t

| Parameter | Description | Default |
|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
|`agones.extensions.hostNetwork` | Determines if the Agones extensions should operate in hostNetwork mode. If running in hostNetwork mode, you should change `agones.extensions.http.port` and `agones.extensions.webhooks.port` to an available port. | `false` |
| `agones.extensions.http.port` | Port to use for liveness probe service and metrics | `8080` |
|`agones.extensions.webhooks.port` | Port to use for webhook service | `8081` |
| `agones.extensions.healthCheck.initialDelaySeconds` | Initial delay before performing the first probe (in seconds) | `3` |
| `agones.extensions.healthCheck.periodSeconds` | Seconds between every liveness probe (in seconds) | `3` |
| `agones.extensions.healthCheck.failureThreshold` | Number of times before giving up (in seconds) | `3` |
Expand Down Expand Up @@ -328,14 +330,6 @@ The following tables lists the configurable parameters of the Agones chart and t

### GameServers

{{% feature expiryVersion="1.40.0" %}}
| Parameter | Description | Default |
|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| `gameservers.namespaces` | a list of namespaces you are planning to use to deploy game servers | `["default"]` |
| `gameservers.minPort` | Minimum port to use for dynamic port allocation | `7000` |
| `gameservers.maxPort` | Maximum port to use for dynamic port allocation | `8000` |
| `gameservers.podPreserveUnknownFields` | Disable [field pruning][pruning] and schema validation on the Pod template for a [GameServer][gameserver] definition | `false` |
{{% /feature %}}
| Parameter | Description | Default |
|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| `gameservers.namespaces` | a list of namespaces you are planning to use to deploy game servers | `["default"]` |
Expand Down

0 comments on commit 5c18bef

Please sign in to comment.