Skip to content

Commit

Permalink
docs: update Agones prerequisites
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremylvln committed Nov 28, 2023
1 parent 5ebb4da commit ef4dcd5
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@
"https://json.schemastore.org/github-workflow.json": ".github/workflows/deploy.yml",
"https://json.schemastore.org/github-issue-config.json": ".github/ISSUE_TEMPLATE/config.yml"
},
"rust-analyzer.cargo.features": "all"
"rust-analyzer.cargo.features": "all",
"githubPullRequests.ignoredPullRequestBranches": ["main"]
}
7 changes: 7 additions & 0 deletions docs/project.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@
"command": "vitepress dev src",
"cwd": "docs"
}
},
"promote-latest": {
"executor": "nx:run-commands",
"options": {
"command": "bash ./copy_next_to_latest.sh",
"cwd": "docs/scripts"
}
}
},
"tags": ["lang:js"]
Expand Down
4 changes: 4 additions & 0 deletions docs/scripts/copy_next_to_latest.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env bash

rm -Rf ../src/latest
cp -r ../src/next ../src/latest
19 changes: 16 additions & 3 deletions docs/src/next/guide/getting-started/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
Shulker should be able to be installed on any Kubernetes cluster meeting
the following criterias:

- The minimum Kubernetes version supported is **TODO**
- At least one Linux node is needed for the Shulker operators to work
(no special architecture is required)
- The minimum known working Kubernetes version is **1.27**, but it way
work on older versions as well
- At least one **Linux node** is needed for the Shulker operators to work
(amd64 or arm64 architectures are supported)

:::info

Expand Down Expand Up @@ -41,6 +42,18 @@ Agones.
- Website: https://agones.dev/site/
- Installation guide: https://agones.dev/site/docs/installation/

Shulker requires that you to configure Agones to work properly:

- Add your Shulker deployment's namespace (`shulker-system` by default) to
Agones's list of `GameServer` namespaces. This will make Agones create
the secret containing the gRPC credentials Shulker will use to interact
with its API. Add the namespace to the `gameservers.namespaces` Helm value
- Enable Agones Allocator component. It is used to summon manually a new
`GameServer` when needed (mostly used in Shulker addons). Set the
`agones.allocator.install=true` Helm value. Optionally make its `Service`
be of type `ClusterIP` so it will be only used internally by setting the
`agones.allocator.service.serviceType=ClusterIP` value

:::warning

Watch out that while Shulker does not need heavy scaling to handle
Expand Down

0 comments on commit ef4dcd5

Please sign in to comment.