Create getting started docs for Scaleway (#19)

Signed-off-by: Engin Diri <[email protected]>
dirien · Jul 7, 2021 · f8d79b3 · f8d79b3
1 parent e847534
commit f8d79b3
Show file tree

Hide file tree

Showing 16 changed files with 177 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -112,7 +112,9 @@ Flags:
 
 #### Getting Started
 
-- [Civo](docs/getting-started-civo.md)
+- [Civo Java Edition](docs/getting-started-civo.md)
+- [Civo Bedrock Edition](docs/getting-started-civo-bedrock.md)
+- [Scaleway Java Edition](docs/getting-started-scaleway.md)
 
 ### Supported cloud provider ☁
 

diff --git a/docs/getting-started-civo-bedrock.md b/docs/getting-started-civo-bedrock.md
@@ -5,7 +5,7 @@
 Bedrock Edition (also known as the Bedrock editions, Bedrock versions, or just Bedrock) refers to the multi-platform
 versions of Minecraft developed by Mojang Studios, Xbox Game Studios, and SkyBox Labs and based on the Bedrock codebase.
 
-To setup a bedrock server, just follow [getting started with civi](getting-started-civo.md) except of following changes:
+To setup a bedrock server, just follow [getting started with Civo](getting-started-civo.md) except of following changes:
 
 ###### Attention: The server.properties of the bedrock edition is different to the java edition
 

diff --git a/docs/getting-started-civo.md b/docs/getting-started-civo.md
@@ -6,7 +6,13 @@
 
 Get your API Key via https://www.civo.com/account/security 
 
-![key](img/key.png)
+![key](img/civo_key.png)
+
+Export the key as ENV variable:
+
+```
+export CIVO_TOKEN=xx
+```
 
 ## Create SSH Keys
 
@@ -87,7 +93,7 @@ spec:
 ## minectl 🗺
 
 ```bash
-minectl create --filename config/server-civo.yaml 
+minectl create --filename config/java/server-civo.yaml 
 
 🛎 Using cloud provider Civo
 🗺 Minecraft java edition
@@ -101,7 +107,7 @@ To delete the server type:
  minectl delete -f config/java/server-civo.yaml --id 7b9ed37c-fb35-49de-a996-a5f8ae7b7fc1
 ```
 
-![instance](img/instance.png)
+![instance](img/civo_instance.png)
 
 ## Minecraft Client
 
@@ -114,22 +120,22 @@ Start your Minecraft Client
 
 Add your server
 
-![img.png](img/add-server.png)
+![img.png](img/civo_add_server.png)
 
 Join the server
 
-![img.png](img/join.png)
+![img.png](img/civo_join.png)
 
 Play the game
 
-![game.png](img/game.png)
+![game.png](img/civo_game.png)
 
 ## minectl 🗺 
 
 Feed up with your server? Deleting is as easy as creating the server
 
 ```bash
-minectl delete --filename config/server-civo.yaml --id a7ad735a-d1e9-4951-9f9b-83221efd945e
+minectl delete --filename config/java/server-civo.yaml --id a7ad735a-d1e9-4951-9f9b-83221efd945e
 
 🛎 Using cloud provider Civo
 🗺 Minecraft java edition

diff --git a/docs/getting-started-scaleway.md b/docs/getting-started-scaleway.md
@@ -0,0 +1,160 @@
+![Civo](img/scaleway.png)
+
+# Getting Started - Scaleway edition
+
+## Access and Secret Key
+
+Generate a new access and secret key (https://console.scaleway.com/project/credentials)
+
+![img.png](img/scaleway_key.png)
+
+Get the generated API keys.
+
+![img.png](img/scaleway_key_2.png)
+
+Export the keys as ENV variables:
+
+```
+export ACCESS_KEY=xxx
+export SECRET_KEY=yyy
+export ORGANISATION_ID=zzz
+```
+
+See https://www.scaleway.com/en/docs/generate-api-keys/ for even more details on Scaleway Credentials
+
+## Create SSH Keys
+
+```
+ssh-keygen -t rsa -f ./minecraft
+```
+
+## Create MinecraftServer config
+
+```bash
+apiVersion: ediri.io/minectl/v1alpha1
+kind: MinecraftServer
+metadata:
+  name: minecraft-server
+spec:
+  server:
+    cloud: scaleway
+    region: fr-par-1
+    size: GP1-XS
+    volumeSize: 100
+    ssh: "xxx/ssh/minecraft.pub"
+  minecraft:
+    java:
+      xmx: 2G
+      xms: 2G
+    edition: java
+    properties: |
+      level-seed=stackitminecraftrocks
+      broadcast-rcon-to-ops=true
+      view-distance=10
+      enable-jmx-monitoring=false
+      server-ip=
+      resource-pack-prompt=
+      rcon.port=25575
+      gamemode=survival
+      server-port=25565
+      allow-nether=true
+      enable-command-block=false
+      enable-rcon=false
+      sync-chunk-writes=true
+      enable-query=false
+      op-permission-level=4
+      prevent-proxy-connections=false
+      resource-pack=
+      entity-broadcast-range-percentage=100
+      level-name=world
+      rcon.password=
+      player-idle-timeout=0
+      motd=Scaleway Minecraft
+      query.port=25565
+      force-gamemode=false
+      rate-limit=0
+      hardcore=false
+      white-list=false
+      broadcast-console-to-ops=true
+      pvp=true
+      spawn-npcs=true
+      spawn-animals=true
+      snooper-enabled=true
+      difficulty=easy
+      function-permission-level=2
+      network-compression-threshold=256
+      text-filtering-config=
+      require-resource-pack=false
+      spawn-monsters=true
+      max-tick-time=60000
+      enforce-whitelist=false
+      use-native-transport=true
+      max-players=100
+      resource-pack-sha1=
+      spawn-protection=16
+      online-mode=true
+      enable-status=true
+      allow-flight=false
+      max-world-size=29999984
+```
+
+## minectl 🗺
+
+```bash
+minectl create --filename config/server-scaleway.yaml 
+
+🛎 Using cloud provider Scaleway
+🗺 Minecraft java edition
+🏗 Creating instance (minecraft-server)... ⢿ 
+✅ Instance (minecraft-server) created
+Minecraft Server IP: 51.15.132.219
+Minecraft Server ID: 30a219f1-dff2-487f-a3cd-0b03d712de81
+
+To delete the server type:
+
+ minectl delete -f config/java/server-scaleway.yaml --id 30a219f1-dff2-487f-a3cd-0b03d712de81
+```
+
+![img.png](img/scaleway_instance.png)
+
+## Minecraft Client
+
+### Download
+
+Download a Minecraft Client (Java Edition) under https://www.minecraft.net/en-us/get-minecraft
+
+Start your Minecraft Client
+
+![img.png](img/multi.png)
+
+Add your server
+
+![img.png](img/scaleway_add_server.png)
+
+Join the server
+
+![img.png](img/scaleway_join.png)
+
+Play the game
+
+![img.png](img/scaleway_game.png)
+
+## minectl 🗺
+
+Feed up with your server? Deleting is as easy as creating the server
+
+```bash
+minectl delete -f config/java/server-scaleway.yaml --id 30a219f1-dff2-487f-a3cd-0b03d712de81
+
+🛎 Using cloud provider Scaleway
+🗺 Minecraft java edition
+🗑 Delete instance (30a219f1-dff2-487f-a3cd-0b03d712de81)... 
+```
+
+### Legal Disclaimer 👮
+
+This project is not affiliated with Mojang Studios, XBox Game Studios, Double Eleven or the Minecraft brand.
+
+"Minecraft" is a trademark of Mojang Synergies AB.
+
+Other trademarks referenced herein are property of their respective owners.
diff --git a/docs/img/add-server.png → docs/img/civo_add_server.png b/docs/img/add-server.png → docs/img/civo_add_server.png
diff --git a/docs/img/game.png → docs/img/civo_game.png b/docs/img/game.png → docs/img/civo_game.png
diff --git a/docs/img/instance.png → docs/img/civo_instance.png b/docs/img/instance.png → docs/img/civo_instance.png
diff --git a/docs/img/join.png → docs/img/civo_join.png b/docs/img/join.png → docs/img/civo_join.png
diff --git a/docs/img/key.png → docs/img/civo_key.png b/docs/img/key.png → docs/img/civo_key.png
diff --git a/docs/img/scaleway.png b/docs/img/scaleway.png
diff --git a/docs/img/scaleway_add_server.png b/docs/img/scaleway_add_server.png
diff --git a/docs/img/scaleway_game.png b/docs/img/scaleway_game.png
diff --git a/docs/img/scaleway_instance.png b/docs/img/scaleway_instance.png
diff --git a/docs/img/scaleway_join.png b/docs/img/scaleway_join.png
diff --git a/docs/img/scaleway_key.png b/docs/img/scaleway_key.png
diff --git a/docs/img/scaleway_key_2.png b/docs/img/scaleway_key_2.png