Skip to content

Commit

Permalink
Remove GameServer UpdateStatus() since its not being used.
Browse files Browse the repository at this point in the history
Also included documentation on why we don't provide a status
subresource.
  • Loading branch information
markmandel committed Jul 30, 2019
1 parent 06ffbd3 commit da81414
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 31 deletions.
7 changes: 6 additions & 1 deletion pkg/apis/agones/v1/gameserver.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,14 @@ var (
)

// +genclient
// +genclient:noStatus
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// GameServer is the data structure for a GameServer resource
// GameServer is the data structure for a GameServer resource.
// It is worth noting that while there is a `GameServerStatus` Status entry for the `GameServer`, it is not
// defined as a subresource - unlike `Fleet` and other Agones resources.
// This is so that we can retain the ability to change multiple aspects of a `GameServer` in a single atomic operation,
// which is particularly useful for operations such as allocation.
type GameServer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 0 additions & 17 deletions pkg/client/clientset/versioned/typed/agones/v1/gameserver.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion site/content/en/docs/Reference/agones_crd_api_reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -2497,7 +2497,11 @@ <h3 id="Fleet">Fleet
<h3 id="GameServer">GameServer
</h3>
<p>
<p>GameServer is the data structure for a GameServer resource</p>
<p>GameServer is the data structure for a GameServer resource.
It is worth noting that while there is a <code>GameServerStatus</code> Status entry for the <code>GameServer</code>, it is not
defined as a subresource - unlike <code>Fleet</code> and other Agones resources.
This is so that we can retain the ability to change multiple aspects of a <code>GameServer</code> in a single atomic operation,
which is particularly useful for operations such as allocation.</p>
</p>
<table>
<thead>
Expand Down

0 comments on commit da81414

Please sign in to comment.