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.

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

Adds Documention for how to run an in-place Agones upgrade #3904

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

igooch
Copy link
Collaborator

@igooch igooch commented Jul 15, 2024

What type of PR is this?

/kind documentation

What this PR does / Why we need it:

User documentation for how to perform an Agones in-place upgrade.

Which issue(s) this PR fixes:

Working on #3766

Special notes for your reviewer:

@igooch igooch requested a review from markmandel July 15, 2024 17:00
@github-actions github-actions bot added the kind/documentation Documentation for Agones label Jul 15, 2024
@igooch igooch requested a review from zmerlynn July 15, 2024 17:00
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: bf13e86f-cb31-4dbf-bc9a-7a9eca971e6b

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-9d48f27-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 0f3adad3-ed2c-4494-ab0a-598c38feb4f9

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-b6ae796-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: ee774e85-48d2-45cf-ae5d-0949b35edbee

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-891f503-amd64

site/content/en/docs/Installation/upgrading.md Outdated Show resolved Hide resolved
site/content/en/docs/Installation/upgrading.md Outdated Show resolved Hide resolved
site/content/en/docs/Installation/upgrading.md Outdated Show resolved Hide resolved
site/content/en/docs/Installation/upgrading.md Outdated Show resolved Hide resolved
site/content/en/docs/Installation/upgrading.md Outdated Show resolved Hide resolved
4. Run any other tests to ensure the Agones installation is working as expected.
5. Congratulations - you have now upgraded to a new version of Agones! 👍

##### Delay Upgrade to Existing Fleet (not recommended)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is one recommended over the other?

Copy link
Collaborator Author

@igooch igooch Jul 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean compared to delaying the fleet upgrade, or compared to adding or not adding a label?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Compared to delaying the existing Fleet - we never specify why one is preferred over the other. We should be clear on that (I'm also curious 😆)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally legit question! I'll add in a more consise explanation somewhere on the "why".

It's because if the fleet is not ugpraded, none of the game servers are upgraded. Newly created game servers will be at the new configuraiton, but any existing ready game servers, or allocated game servers that return to the ready state will remain at the old configuraiton. This means that the fleet will remain at the old configuration for much longer. In and of itself that's not necessarily a bad thing, but if they do multiple Agones upgrades they could easily end up with several different versions of game servers in a fleet, and limited to no way of tracking which game server is at which version.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some rearranging / reordering. The wording or format could probably be clearer. Let me know if you have any additional suggestions!

site/content/en/docs/Installation/upgrading.md Outdated Show resolved Hide resolved
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: fc512a2f-5ea9-4a23-98c5-7ae3a49ffa67

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-4081e5e-amd64

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 41fe7c03-3f06-4eeb-a6d2-736be22e4686

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-76b28c8-amd64

@igooch igooch force-pushed the inPlaceUpgrades branch 4 times, most recently from 356582b to e05437f Compare August 5, 2024 18:28
@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 9778b2fd-7db6-4b88-abec-2771a02438c7

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-e05437f

@igooch igooch force-pushed the inPlaceUpgrades branch 2 times, most recently from 1f73c25 to eb170ca Compare August 26, 2024 19:46
@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 1e293a75-e264-4184-bedd-8f27858ff0ac

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.43.0-dev-eb170ca

@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 0f88e6b6-130e-47df-bb00-adecda7221d4

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.44.0-dev-0759344

@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 4015b0a7-1a52-4308-9ab3-52680cc42a4e

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.45.0-dev-d3956c8

@@ -51,6 +51,70 @@ The following are steps to implement this:
If you are upgrading a single cluster, we recommend creating a maintenance window, in which your game goes offline
for the period of your upgrade, as there will be a short period in which Agones will be non-responsive during the upgrade.

{{% feature publishVersion="1.99.0" %}}
#### In-Place Agones Upgrades
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to publish this now, or wait for the release? There's no feature gate, so there's nothing preventing a user from starting to use in place upgrades now.

@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 2ffd3207-6645-4b44-b6d5-d9170392aafc

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3904/head:pr_3904 && git checkout pr_3904
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.46.0-dev-8d33b9a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Documentation for Agones size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants