Agones versions are expressed as x.y.z, where x is the major version, y is the minor version, and z is the patch version , following Semantic Versioning terminology.
A feature within Agones can be in
Beta features can be enabled or disabled through the
agones.featureGates configuration option
that can be found in the Helm configuration documentation.
The current set of
beta feature gates are:
|Example Gate (not in use)||
*Multicluster Allocation was started before this process was in place, and therefore is enabled by default, and will not have a feature flag.
Description of Stages
Alpha feature means:
- Disabled by default.
- Might be buggy. Enabling the feature may expose bugs.
- Support for this feature may be dropped at any time without notice.
- The API may change in incompatible ways in a later software release without notice.
- Recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.
NotePlease do try
Alphafeatures and give feedback on them. This is important to ensure less breaking changes through the
Beta feature means:
- Enabled by default, but able to be disabled through a feature gate.
- The feature is well tested. Enabling the feature is considered safe.
- Support for the overall feature will not be dropped, though details may change.
- The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable releases. When this happens, we will provide instructions for migrating to the next version. This may require deleting, editing, and re-creating API objects. The editing process may require some thought. This may require downtime for applications that rely on the feature.
- Recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases. If you have multiple clusters that can be upgraded independently, you may be able to relax this restriction.
NoteNote: Please do try
Betafeatures and give feedback on them! After they exit beta, it may not be practical for us to make more changes.
Stable feature means:
- The feature is enabled and the corresponding feature gate no longer exists.
- Stable versions of features will appear in released software for many subsequent versions.
Feature Stage Indicators
There are a variety of features with Agones, how can we determine what stage each feature is in?
Below are indicators for each type of functionality that can be used to determine the feature stage for a given aspect of Agones.
Custom Resource Definitions (CRDs)
This refers to Kubernetes resource for Agones, such as
For new resources, the stage of the resource will be indicated by the
apiVersion of the resource.
apiVersion: "agones.dev/v1" is a
apiVersion: "agones.dev/v1beta1" is a
stage resource, and
apiVersion: "agones.dev/v1alpha1" is an
alpha stage resource.
New CRD attributes
beta attributes are added to an existing stable Agones CRD, we will follow the Kubernetes Adding
Unstable Features to Stable Versions
Guide to optimise on the least amount of breaking changes for users as attributes progress through feature stages.
beta attributes will be added to the existing CRD as
optional and documented with their feature stage.
Attempting to populate these
beta attributes on an Agones CRD will return a validation error if their
accompanying Feature Flag is not enabled.
beta attributes can be subject to change of name and structure, and will result in breaking changes
before moving to a
stable stage. These changes will be outlined in release notes and feature documentation.
Agones Game Server SDK
beta Game Server SDK functionality will be a subpackage of the
sdk package. For example
, functionality found in a
sdk.alphav1 package should be considered at the
alpha feature stage.
Only experimental functionality will be found in any
beta SDK packages, and as such may change as
As SDK features move to through feature stages towards
stable, the previous version of the SDK API
will remain for at least one release to enable easy migration to the more stable feature stage (i.e. from
Any other SDK functionality not marked as
beta is assumed to be
REST & gRPC APIs
REST and gRPC API will have versioned paths where appropriate to indicate their feature stage.
For example, a REST API with a prefix of
v1alpha1 is an
alpha stage feature:
Similar to the SDK, any
beta gRPC functionality will be a subpackage of the main API package.
For example, functionality found in a
api.alphav1 package should be considered at the
alpha feature stage.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.