From a15e98587148456242d0242d184e17746c191dd2 Mon Sep 17 00:00:00 2001 From: Kalaiselvi Murugesan Date: Fri, 3 May 2024 17:14:09 +0000 Subject: [PATCH] revert gs.md --- site/content/en/docs/Reference/gameserver.md | 147 ------------------- 1 file changed, 147 deletions(-) diff --git a/site/content/en/docs/Reference/gameserver.md b/site/content/en/docs/Reference/gameserver.md index 82df105548..0f02866a5f 100644 --- a/site/content/en/docs/Reference/gameserver.md +++ b/site/content/en/docs/Reference/gameserver.md @@ -10,7 +10,6 @@ description: > A full GameServer specification is available below and in the {{< ghlink href="examples/gameserver.yaml" >}}example folder{{< /ghlink >}} for reference : -{{% feature expiryVersion="1.41.0" %}} ```yaml apiVersion: "agones.dev/v1" kind: GameServer @@ -154,152 +153,6 @@ The `spec` field is the actual GameServer specification and it is composed as fo {{< alert title="Note" color="info">}} The GameServer resource does not support updates. If you need to make regular updates to the GameServer spec, consider using a [Fleet]({{< ref "/docs/Reference/fleet.md" >}}). {{< /alert >}} -{{% /feature %}} -{{% feature publishVersion="1.41.0" %}} -```yaml -apiVersion: "agones.dev/v1" -kind: GameServer -# GameServer Metadata -# {{< k8s-api-version href="#objectmeta-v1-meta" >}} -metadata: - # generateName: "gds-example" # generate a unique name, with the given prefix - name: "gds-example" # set a fixed name -spec: - # if there is more than one container, specify which one is the game server - container: example-server - # Array of ports that can be exposed as direct connections to the game server container - ports: - # name is a descriptive name for the port - - name: default - # portPolicy has three options: - # - "Dynamic" (default) the system allocates a free hostPort for the gameserver, for game clients to connect to - # - "Static", user defines the hostPort that the game client will connect to. Then onus is on the user to ensure that the - # port is available. When static is the policy specified, `hostPort` is required to be populated - # - "Passthrough" dynamically sets the `containerPort` to the same value as the dynamically selected hostPort. - # This will mean that users will need to lookup what port has been opened through the server side SDK. - portPolicy: Static - # The name of the container to open the port on. Defaults to the game server container if omitted or empty. - container: simple-game-server - # the port that is being opened on the game server process - containerPort: 7654 - # the port exposed on the host, only required when `portPolicy` is "Static". Overwritten when portPolicy is "Dynamic". - hostPort: 7777 - # protocol being used. Defaults to UDP. TCP and TCPUDP are other options - # - "UDP" (default) use the UDP protocol - # - "TCP", use the TCP protocol - # - "TCPUDP", uses both TCP and UDP, and exposes the same hostPort for both protocols. - # This will mean that it adds an extra port, and the first port is set to TCP, and second port set to UDP - protocol: UDP - # Health checking for the running game server - health: - # Disable health checking. defaults to false, but can be set to true - disabled: false - # Number of seconds after the container has started before health check is initiated. Defaults to 5 seconds - initialDelaySeconds: 5 - # If the `Health()` function doesn't get called at least once every period (seconds), then - # the game server is not healthy. Defaults to 5 - periodSeconds: 5 - # Minimum consecutive failures for the health probe to be considered failed after having succeeded. - # Defaults to 3. Minimum value is 1 - failureThreshold: 3 - # Parameters for game server sidecar - sdkServer: - # sdkServer log level parameter has three options: - # - "Info" (default) The SDK server will output all messages except for debug messages - # - "Debug" The SDK server will output all messages including debug messages - # - "Error" The SDK server will only output error messages - logLevel: Info - # grpcPort and httpPort control what ports the sdkserver listens on. - # Starting with Agones 1.2 the default grpcPort is 9357 and the default - # httpPort is 9358. In earlier releases, the defaults were 59357 and 59358 - # respectively but as these were in the ephemeral port range they could - # conflict with other TCP connections. - grpcPort: 9357 - httpPort: 9358 - # [Stage:Alpha] - # [FeatureFlag:PlayerTracking] - # Players provides the configuration for player tracking features. - # Commented out since Alpha, and disabled by default - # players: - # # set this GameServer's initial player capacity - # initialCapacity: 10 - # - # [Stage:Beta] - # [FeatureFlag:CountsAndLists] - # Counts and Lists provides the configuration for generic (player, room, session, etc.) tracking features. - # Now in Beta, and enabled by default - counters: # counters are int64 counters that can be incremented and decremented by set amounts. Keys must be declared at GameServer creation time. - games: # arbitrary key. - count: 1 # initial value. - capacity: 100 # (Optional) Defaults to 1000 and setting capacity to max(int64) may lead to issues and is not recommended. See GitHub issue https://github.com/googleforgames/agones/issues/3636 for more details. - sessions: - count: 1 - lists: # lists are lists of values stored against this GameServer that can be added and deleted from. Keys must be declared at GameServer creation time. - players: # an empty list, with a capacity set to 10. - capacity: 10 # capacity value, defaults to 1000. - rooms: - capacity: 333 - values: # initial set of values in a list. - - room1 - - room2 - - room3 - # Pod template configuration - # {{< k8s-api-version href="#podtemplate-v1-core" >}} - template: - # pod metadata. Name & Namespace is overwritten - metadata: - labels: - myspeciallabel: myspecialvalue - # Pod Specification - spec: - containers: - - name: simple-game-server - image: {{< example-image >}} - imagePullPolicy: Always - # nodeSelector is a label that can be used to tell Kubernetes which host - # OS to use. For Windows game servers uncomment the nodeSelector - # definition below. - # Details: https://kubernetes.io/docs/setup/production-environment/windows/user-guide-windows-containers/#ensuring-os-specific-workloads-land-on-the-appropriate-container-host - # nodeSelector: - # kubernetes.io/os: windows -``` -Since Agones defines a new [Custom Resources Definition (CRD)](https://kubernetes.io/docs/concepts/api-extension/custom-resources/) we can define a new resource using the kind `GameServer` with the custom group `agones.dev` and API version `v1`. - -You can use the metadata field to target a specific [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) -but also attach specific [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) and [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to your resource. This is a very common pattern in the Kubernetes ecosystem. - -The length of the `name` field of the Gameserver should not exceed 63 characters. - -The `spec` field is the actual GameServer specification and it is composed as follow: - -- `container` is the name of container running the GameServer in case you have more than one container defined in the [pod](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/). If you do, this is a mandatory field. For instance this is useful if you want to run a sidecar to ship logs. -- `ports` are an array of ports that can be exposed as direct connections to the game server container - - `name` is an optional descriptive name for a port - - `portPolicy` has three options: - - `Dynamic` (default) the system allocates a random free hostPort for the gameserver, for game clients to connect to. - - `Static`, user defines the hostPort that the game client will connect to. Then onus is on the user to ensure that the port is available. When static is the policy specified, `hostPort` is required to be populated. - - `Passthrough` dynamically sets the `containerPort` to the same value as the dynamically selected hostPort. This will mean that users will need to lookup what port to open through the server side SDK before starting communications. - - `container` (Alpha) the name of the container to open the port on. Defaults to the game server container if omitted or empty. - - `containerPort` the port that is being opened on the game server process, this is a required field for `Dynamic` and `Static` port policies, and should not be included in Passthrough configuration. - - `protocol` the protocol being used. Defaults to UDP. TCP and TCPUDP are other options. -- `health` to track the overall healthy state of the GameServer, more information available in the [health check documentation]({{< relref "../Guides/health-checking.md" >}}). -- `sdkServer` defines parameters for the game server sidecar - - `logging` field defines log level for SDK server. Defaults to "Info". It has three options: - - "Info" (default) The SDK server will output all messages except for debug messages - - "Debug" The SDK server will output all messages including debug messages - - "Error" The SDK server will only output error messages - - `grpcPort` the port that the SDK Server binds to for gRPC connections - - `httpPort` the port that the SDK Server binds to for HTTP gRPC gateway connections -- `players` (Alpha, behind "PlayerTracking" feature gate), sets this GameServer's initial player capacity -- `counters` (Beta, requires "CountsAndLists" feature flag) are int64 counters with a default capacity of 1000 that can be incremented and decremented by set amounts. Keys must be declared at GameServer creation time. Note that setting the capacity to max(int64) may lead to issues. -- `lists` (Beta, requires "CountsAndLists" feature flag) are lists of values stored against this GameServer that can be added and deleted from. Key must be declared at GameServer creation time. -- `template` the [pod spec template]({{% k8s-api-version href="#podtemplatespec-v1-core" %}}) to run your GameServer containers, [see](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/#pod-templates) for more information. - -{{< alert title="Note" color="info">}} -The GameServer resource does not support updates. If you need to make regular updates to the GameServer spec, consider using a [Fleet]({{< ref "/docs/Reference/fleet.md" >}}). -{{< /alert >}} -{{% /feature %}} - ## Stable Network ID