Skip to content

docs: Add Wasm autoscaling documentation to FleetAutoscaler reference#4314

Merged
lacroixthomas merged 3 commits intoagones-dev:mainfrom
markmandel:reference/wasm-autoscaler
Nov 5, 2025
Merged

docs: Add Wasm autoscaling documentation to FleetAutoscaler reference#4314
lacroixthomas merged 3 commits intoagones-dev:mainfrom
markmandel:reference/wasm-autoscaler

Conversation

@markmandel
Copy link
Copy Markdown
Collaborator

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it:

  • Add new Wasm Autoscaling section with complete specification and examples
  • Document Wasm function specification using Extism framework
  • Reorganize document by moving Webhook Endpoint Specification earlier
  • Update policy type list to include all available types (Buffer, Webhook, Counter, List, Schedule, Chain, and Wasm)
  • Add wasm policy parameters to spec field documentation

Which issue(s) this PR fixes:

Work on #4080

Special notes for your reviewer:

Last step will be a quickstart.

@github-actions github-actions bot added kind/documentation Documentation for Agones size/M labels Oct 24, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds comprehensive documentation for the new Wasm-based FleetAutoscaler feature to the existing FleetAutoscaler reference documentation.

Key Changes:

  • Added complete Wasm Autoscaling section with specification, examples, and function interface documentation
  • Reorganized document structure by moving Webhook Endpoint Specification earlier for better flow
  • Updated policy type list to include all seven available autoscaling types (Buffer, Webhook, Counter, List, Schedule, Chain, and Wasm)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@agones-bot
Copy link
Copy Markdown
Collaborator

Build Succeeded 🥳

Build Id: 28a18d4c-8a60-40d7-9f53-302ab5bd175d

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/4314/head:pr_4314 && git checkout pr_4314
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.54.0-dev-ac3597e

@markmandel markmandel force-pushed the reference/wasm-autoscaler branch from c40202f to 14c6b0e Compare October 27, 2025 21:37
@agones-bot
Copy link
Copy Markdown
Collaborator

Build Succeeded 🥳

Build Id: 12792a98-4fac-4a27-93f1-7734643c815a

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/4314/head:pr_4314 && git checkout pr_4314
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.54.0-dev-14c6b0e

Copy link
Copy Markdown
Collaborator

@lacroixthomas lacroixthomas left a comment

Choose a reason for hiding this comment

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

LGTM, just the comment about the counters and lists that could be nice to add in this PR, otherwise looks great !

// and then returned with a populated Response.
type FleetAutoscaleReview struct {
Request *FleetAutoscaleRequest `json:"request"`
Response *FleetAutoscaleResponse `json:"response"`
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think it's github that is going funky and says that the identations was removed (I've checked the file itself and looks alright), you can ignore this comment

- Add new Wasm Autoscaling section with complete specification and
  examples
- Document Wasm function specification using Extism framework
- Reorganize document by moving Webhook Endpoint Specification earlier
- Update policy type list to include all available types (Buffer,
  Webhook, Counter, List, Schedule, Chain, and Wasm)
- Add wasm policy parameters to spec field documentation
@markmandel markmandel force-pushed the reference/wasm-autoscaler branch from 14c6b0e to 01b7fcc Compare November 4, 2025 04:57
@markmandel
Copy link
Copy Markdown
Collaborator Author

Added the warnings for Counters and Lists and Wasm. Should be good to go now.

@agones-bot
Copy link
Copy Markdown
Collaborator

Build Succeeded 🥳

Build Id: e22d3ddf-d70b-4c2f-bc8b-a01d593cdb5a

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/4314/head:pr_4314 && git checkout pr_4314
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.54.0-dev-01b7fcc

Copy link
Copy Markdown
Collaborator

@lacroixthomas lacroixthomas left a comment

Choose a reason for hiding this comment

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

LGTM !

@agones-bot
Copy link
Copy Markdown
Collaborator

Build Succeeded 🥳

Build Id: ff653e4f-a333-46cf-81d8-de08a5f81bf4

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/4314/head:pr_4314 && git checkout pr_4314
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.54.0-dev-132f549

@lacroixthomas lacroixthomas merged commit 6196cd8 into agones-dev:main Nov 5, 2025
4 checks passed
@markmandel markmandel deleted the reference/wasm-autoscaler branch November 7, 2025 17:03
mnthe pushed a commit to mnthe/agones that referenced this pull request Mar 23, 2026
…agones-dev#4314)

* docs: Add Wasm autoscaling documentation to FleetAutoscaler reference

- Add new Wasm Autoscaling section with complete specification and
  examples
- Document Wasm function specification using Extism framework
- Reorganize document by moving Webhook Endpoint Specification earlier
- Update policy type list to include all available types (Buffer,
  Webhook, Counter, List, Schedule, Chain, and Wasm)
- Add wasm policy parameters to spec field documentation

* Review updates

---------

Co-authored-by: Thomas Lacroix <thomas.lacroix@ubisoft.com>
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/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants