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

Changelog, and documentation changes for 0.4.0.rc #331

Merged
merged 1 commit into from
Aug 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,47 @@
# Change Log

## [v0.3.0](https://github.com/GoogleCloudPlatform/agones/tree/v0.3.0) (2018-07-25)
## [v0.4.0.rc](https://github.com/GoogleCloudPlatform/agones/tree/v0.4.0.rc) (2018-08-28)
[Full Changelog](https://github.com/GoogleCloudPlatform/agones/compare/v0.3.0...v0.4.0.rc)

**Implemented enhancements:**

- When running the SDK sidecar in local mode, be able to specify the backing `GameServer` configuration [\#296](https://github.com/GoogleCloudPlatform/agones/issues/296)
- Move Status \> Address & Status \> Ports population to `Creating` state processing [\#293](https://github.com/GoogleCloudPlatform/agones/issues/293)
- Propagating game server process events to Agones system [\#279](https://github.com/GoogleCloudPlatform/agones/issues/279)
- Session data propagation to dedicated server [\#277](https://github.com/GoogleCloudPlatform/agones/issues/277)
- Ability to pass `GameServer` yaml/json to local sdk server [\#328](https://github.com/GoogleCloudPlatform/agones/pull/328) ([markmandel](https://github.com/markmandel))
- Move Status \> Address & Ports population to `Creating` state processing [\#326](https://github.com/GoogleCloudPlatform/agones/pull/326) ([markmandel](https://github.com/markmandel))
- Implement SDK SetLabel and SetAnnotation functionality [\#323](https://github.com/GoogleCloudPlatform/agones/pull/323) ([markmandel](https://github.com/markmandel))
- Metadata propagation from fleet allocation to game server [\#312](https://github.com/GoogleCloudPlatform/agones/pull/312) ([victor-prodan](https://github.com/victor-prodan))
- Features/e2e [\#315](https://github.com/GoogleCloudPlatform/agones/pull/315) ([Kuqd](https://github.com/Kuqd))
- Implements SDK callback for GameServer updates [\#316](https://github.com/GoogleCloudPlatform/agones/pull/316) ([markmandel](https://github.com/markmandel))

**Fixed bugs:**

- Fleet allocation request could not find fleet [\#324](https://github.com/GoogleCloudPlatform/agones/issues/324)
- Fleet Allocation via REST was failing [\#325](https://github.com/GoogleCloudPlatform/agones/pull/325) ([markmandel](https://github.com/markmandel))
- Make sure the test-e2e ensures the build image. [\#322](https://github.com/GoogleCloudPlatform/agones/pull/322) ([markmandel](https://github.com/markmandel))
- Update getting started guides with kubectl custom columns [\#319](https://github.com/GoogleCloudPlatform/agones/pull/319) ([markmandel](https://github.com/markmandel))
- Fix bug: Disabled health checking not implemented [\#317](https://github.com/GoogleCloudPlatform/agones/pull/317) ([markmandel](https://github.com/markmandel))

**Closed issues:**

- Release 0.3.0 [\#304](https://github.com/GoogleCloudPlatform/agones/issues/304)
- Change container builder steps to run concurrently [\#186](https://github.com/GoogleCloudPlatform/agones/issues/186)
- Move Deployment in install script out of v1beta1 [\#173](https://github.com/GoogleCloudPlatform/agones/issues/173)
- YAML packaging [\#101](https://github.com/GoogleCloudPlatform/agones/issues/101)

**Merged pull requests:**

- Added github.com/spf13/viper to dep toml [\#327](https://github.com/GoogleCloudPlatform/agones/pull/327) ([markmandel](https://github.com/markmandel))
- Add Minikube instructions [\#321](https://github.com/GoogleCloudPlatform/agones/pull/321) ([slartibaartfast](https://github.com/slartibaartfast))
- Convert Go example into multi-stage Docker build [\#320](https://github.com/GoogleCloudPlatform/agones/pull/320) ([markmandel](https://github.com/markmandel))
- Removal of the legacy port configuration [\#318](https://github.com/GoogleCloudPlatform/agones/pull/318) ([markmandel](https://github.com/markmandel))
- Fix flakiness with TestSidecarHTTPHealthCheck [\#313](https://github.com/GoogleCloudPlatform/agones/pull/313) ([markmandel](https://github.com/markmandel))
- Move linting into it's own serial step [\#311](https://github.com/GoogleCloudPlatform/agones/pull/311) ([markmandel](https://github.com/markmandel))
- Update to move from release to the next version \(0.4.0.rc\) [\#306](https://github.com/GoogleCloudPlatform/agones/pull/306) ([markmandel](https://github.com/markmandel))

## [v0.3.0](https://github.com/GoogleCloudPlatform/agones/tree/v0.3.0) (2018-07-26)
[Full Changelog](https://github.com/GoogleCloudPlatform/agones/compare/v0.3.0.rc...v0.3.0)

**Fixed bugs:**
Expand All @@ -13,6 +54,7 @@

**Merged pull requests:**

- Changes for release 0.3.0 [\#305](https://github.com/GoogleCloudPlatform/agones/pull/305) ([markmandel](https://github.com/markmandel))
- Move back to 0.3.0 [\#292](https://github.com/GoogleCloudPlatform/agones/pull/292) ([markmandel](https://github.com/markmandel))

## [v0.3.0.rc](https://github.com/GoogleCloudPlatform/agones/tree/v0.3.0.rc) (2018-07-17)
Expand Down
4 changes: 2 additions & 2 deletions docs/fleet_spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ spec:
fleetName: fleet-example
# Custom metadata that is added to game server status in the moment of allocation
# You can use this to tell the server necessary session data
# ⚠️⚠️⚠️ **This is currently a development feature and has not been released** ⚠️⚠️⚠️
# ⚠️⚠️⚠️ **This is currently a release candidate feature** ⚠️⚠️⚠️
metadata:
labels:
mode: deathmatch
Expand All @@ -98,4 +98,4 @@ The `spec` field is the actual `FleetAllocation` specification and it is compose
when the `FleetAllocation` is created
- `metadata` is an optional list of custom labels and/or annotations that will be used to patch
the game server's metadata in the moment of allocation.
⚠️⚠️⚠️ **This is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **This is currently a release candidate feature** ⚠️⚠️⚠️
2 changes: 1 addition & 1 deletion docs/sdk_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Response:

### Watch GameServer

⚠️⚠️⚠️ **/watch/gameserver is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **/watch/gameserver is currently a release candidate feature** ⚠️⚠️⚠️

Call this when you want to get updates of when the backing `GameServer` configuration is updated.

Expand Down
8 changes: 4 additions & 4 deletions sdks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The GameServer state will be set `Shutdown` and the
backing Pod will be deleted, if they have not shut themselves down already.

### SetLabel(key, value)
⚠️⚠️⚠️ **`SetLabel` is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **`SetLabel` is currently a release candidate feature** ⚠️⚠️⚠️

This will set a [Label](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) value on the backing `GameServer`
record that is stored in Kubernetes. To maintain isolation, the `key` value is automatically prefixed with "stable.agones.dev/sdk-"
Expand All @@ -57,7 +57,7 @@ record that is stored in Kubernetes. To maintain isolation, the `key` value is a
This can be useful if you want to information from your running game server process to be observable or searchable through the Kubernetes API.

### SetAnnotation(key, value)
⚠️⚠️⚠️ **`SetAnnotation` is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **`SetAnnotation` is currently a release candidate feature** ⚠️⚠️⚠️

This will set a [Annotation](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) value on the backing
`Gameserver` record that is stored in Kubernetes. To maintain isolation, the `key` value is automatically prefixed with "stable.agones.dev/sdk-"
Expand All @@ -81,7 +81,7 @@ and the [examples](../examples).

### WatchGameServer(function(gameserver){...})

⚠️⚠️⚠️ **`WatchGameServer` is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **`WatchGameServer` is currently a release candidate feature** ⚠️⚠️⚠️

This executes the passed in callback with the current `GameServer` details whenever the underlying `GameServer` configuration is updated.
This can be useful to track `GameServer > Status > State` changes, `metadata` changes, such as labels and annotations, and more.
Expand Down Expand Up @@ -137,7 +137,7 @@ $ ./sidecar.linux.amd64 --local

### Providing your own `GameServer` configuration for local development

⚠️⚠️⚠️ **Providing your own `GameServer` is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **Providing your own `GameServer` is currently a release candidate feature** ⚠️⚠️⚠️

By default, the local sdk-server will create a dummy `GameServer` configuration that is used for `GameServer()`
and `WatchGameServer()` SDK calls. If you wish to provide your own configuration, as either yaml or json, this
Expand Down
6 changes: 3 additions & 3 deletions sdks/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ if (!status.ok()) { ... }
To [set a Label](../README.md#setlabelkey-value) on the backing `GameServer` call
`sdk->SetLabel(key, value)`.

⚠️⚠️⚠️ **`SetLabel` is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **`SetLabel` is currently a release candidate feature** ⚠️⚠️⚠️

This will return a grpc::Status object, from which we can call `status.ok()` to determine
if the function completed successfully.
Expand All @@ -73,7 +73,7 @@ if (!status.ok()) { ... }
To [set an Annotation](../README.md#setannotationkey-value) on the backing `GameServer` call
`sdk->SetAnnotation(key, value)`.

⚠️⚠️⚠️ **`SetAnnotation` is currently a development feature and has not been released** ⚠️⚠️⚠️
⚠️⚠️⚠️ **`SetAnnotation` is currently a release candidate feature** ⚠️⚠️⚠️

This will return a grpc::Status object, from which we can call `status.ok()` to determine
if the function completed successfully.
Expand Down Expand Up @@ -101,7 +101,7 @@ if (!status.ok()) {...}
To get [updates on the backing `GameServer`](../README.md#watchgameserverfunctiongameserver) as they happen,
call `sdk->WatchGameServer([](stable::agones::dev::sdk::GameServer gameserver){...})`.

⚠️⚠️⚠️ **`WatchGameServer` is currently a development feature and has not been released** ⚠️⚠️️⚠️
⚠️⚠️⚠️ **`WatchGameServer` is currently a release candidate feature** ⚠️⚠️️⚠️

This will call the passed in `std::function`
synchronously (this is a blocking function, so you may want to run it in its own thread) whenever the backing `GameServer`
Expand Down