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.

Sign up for GitHub

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

Jump to bottom

Added new docs about the GameServer API #314

Merged
merged 3 commits into from
Jul 15, 2022
Merged

Added new docs about the GameServer API #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52e2259
Added new docs about the GameServer API
javier-op Jul 14, 2022
88d6934
Typo
javier-op Jul 14, 2022
6e18b7f
Typo 2
javier-op Jul 14, 2022
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
2 changes: 1 addition & 1 deletion docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Frequently Asked Questions
nav_order: 14
nav_order: 15
---

# Frequently Asked Questions
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Contributing
nav_order: 12
nav_order: 13
---

# Contributing Guide
Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Development
nav_order: 13
nav_order: 14
---

# Development
Expand Down
16 changes: 16 additions & 0 deletions docs/gameserverapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
layout: default
title: GameServer API
nav_order: 9
has_children: true
---

# GameServer API

The GameServer API is a RESTful API service that facilitates access to Thundernetes' Custom Resources: GameServerBuilds, GameServers, and GameServerDetails. It is an alternative for people who don't want to use tools like [kubectl](https://kubernetes.io/docs/reference/kubectl/kubectl/), and an easy way to integrate Thundernetes to your own applications. It also allows you to use our [Thundernetes UI](../thundernetesui/README.md).

## How to install the GameServer API
dgkanatsios marked this conversation as resolved.
Show resolved Hide resolved

We provide a [Docker image](https://github.com/PlayFab/thundernetes/pkgs/container/thundernetes-gameserverapi) with the API, you have to deploy it into your cluster along with Thundernetes. We also have an [example YAML file](https://github.com/PlayFab/thundernetes/blob/main/cmd/gameserverapi/deployment/default/deploy.yaml) for the deployment, all you have to do is change the name of the container image for the latest version and run ```kubectl apply -f deploy.yaml```. This example uses a LoadBalancer to expose the application, so it will be assigned an external IP (this doesn't work locally unless you have a local implementation of a LoadBalancer, you can use [port forwarding](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) instead).

> **_NOTE_**: The GameServer API provides direct access to your Thundernetes resources, we delegate the securing of the service to the user, for example, you can [use an Ingress](../howtos/serviceingress.md).
Loading