🥇"Nové eposy." Slona jíme po částech

V tomto článku nastavím pracovní prostředí pro vývoj hry „Epics“ a také hru samotnou rozdělím na části vhodné pro použití v OpenFaaS. Veškeré manipulace udělám na Linuxu, nasadím Kubernetes v minikube pomocí VirtualBoxu. Můj pracovní stroj má 2 procesorová jádra a 12GB RAM, jako systémový disk používám SSD. Jako hlavní vývojový systém budu používat debian 8 s nainstalovanými balíčky emacs, sudo, git a virtualbox, vše ostatní se nainstaluje stažením z GitHubu a dalších zdrojů. Pokud není uvedeno jinak, nainstalujeme tyto aplikace do /usr/local/bin. Začněme!

Příprava pracovního prostředí

Instalace Go

Postupujeme podle pokynů z oficiálních stránek:

$ curl -L0 https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz -o go.tar.gz
$ sudo tar -C /usr/local -xzf go.tar.gz
$ echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.profile

Kontrola funkčnosti:

$ mkdir -p ~/go/src/hello && cd ~/go/src/hello
$ echo 'package main

import "fmt"

func main() {
fmt.Printf("hello, worldn")
}' > hello.go
$ go build
$ ./hello
hello, world

Instalace faas-cli

Postupujeme podle pokynů z oficiálních stránek:

$ curl -sSL https://cli.openfaas.com | sudo -E sh
x86_64
Downloading package https://github.com/openfaas/faas-cli/releases/download/0.11.3/faas-cli as /tmp/faas-cli
Download complete.

Running with sufficient permissions to attempt to move faas-cli to /usr/local/bin
New version of faas-cli installed to /usr/local/bin
Creating alias 'faas' for 'faas-cli'.
  ___                   _____           ____
 / _  _ __   ___ _ __ |  ___|_ _  __ _/ ___|
| | | | '_  / _  '_ | |_ / _` |/ _` ___ 
| |_| | |_) |  __/ | | |  _| (_| | (_| |___) |
 ___/| .__/ ___|_| |_|_|  __,_|__,_|____/
      |_|

CLI:
 commit:  73004c23e5a4d3fdb7352f953247473477477a64
 version: 0.11.3

Navíc můžete povolit dokončování bash:

faas-cli completion --shell bash | sudo tee /etc/bash_completion.d/faas-cli

Instalace a konfigurace Kubernetes

Pro vývoj stačí minikube, takže si jej a kubelet nainstalujte do /usr/local/bin a nainstalujte helm pro instalaci aplikací:

$ curl https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 -o minikube && chmod +x minikube && sudo mv minikube /usr/local/bin/
$ curl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl -o kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/
$ curl https://get.helm.sh/helm-v3.0.2-linux-amd64.tar.gz | tar -xzvf - linux-amd64/helm --strip-components=1; sudo mv helm /usr/local/bin

Spustit minikube:

$ minikube start
  minikube v1.6.2 on Debian 8.11
  Automatically selected the 'virtualbox' driver (alternates: [])
  Downloading VM boot image ...
    > minikube-v1.6.0.iso.sha256: 65 B / 65 B [--------------] 100.00% ? p/s 0s
    > minikube-v1.6.0.iso: 150.93 MiB / 150.93 MiB [-] 100.00% 5.67 MiB p/s 27s
  Creating virtualbox VM (CPUs=2, Memory=8192MB, Disk=20000MB) ...
  Preparing Kubernetes v1.17.0 on Docker '19.03.5' ...
  Downloading kubeadm v1.17.0
  Downloading kubelet v1.17.0
  Pulling images ...
  Launching Kubernetes ...  Waiting for cluster to come online ...
  Done! kubectl is now configured to use "minikube"

Zkontrolujeme:

$ kubectl get pods --all-namespaces
NAMESPACE     NAME                               READY   STATUS    RESTARTS   AGE
kube-system   coredns-6955765f44-knlcb           1/1     Running   0          29m
kube-system   coredns-6955765f44-t9cpn           1/1     Running   0          29m
kube-system   etcd-minikube                      1/1     Running   0          28m
kube-system   kube-addon-manager-minikube        1/1     Running   0          28m
kube-system   kube-apiserver-minikube            1/1     Running   0          28m
kube-system   kube-controller-manager-minikube   1/1     Running   0          28m
kube-system   kube-proxy-hv2wc                   1/1     Running   0          29m
kube-system   kube-scheduler-minikube            1/1     Running   0          28m
kube-system   storage-provisioner                1/1     Running   1          29m

Instalace OpenFaaS

Vývojáři doporučují vytvořit 2 jmenné prostory, se kterými budete pracovat:

$ kubectl apply -f https://raw.githubusercontent.com/openfaas/faas-netes/master/namespaces.yml
namespace/openfaas created
namespace/openfaas-fn created

Přidejte úložiště pro kormidlo:

$ helm repo add openfaas https://openfaas.github.io/faas-netes/
"openfaas" has been added to your repositories

Graf má možnost nastavit heslo před instalací, využijme jej a uložme přístupové údaje jako k8s secret:

$ PASSWORD=verysecurerandompasswordstring
$ kubectl -n openfaas create secret generic basic-auth --from-literal=basic-auth-user=admin --from-literal=basic-auth-password="$PASSWORD"
secret/basic-auth created

Pojďme nasadit:

$ helm repo update
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "openfaas" chart repository
Update Complete.  Happy Helming!
$ helm upgrade openfaas --install openfaas/openfaas --namespace openfaas --set functionNamespace=openfaas-fn --set generateBasicAuth=false
Release "openfaas" does not exist. Installing it now.
NAME: openfaas
LAST DEPLOYED: Fri Dec 25 10:28:22 2019
NAMESPACE: openfaas
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
To verify that openfaas has started, run:

  kubectl -n openfaas get deployments -l "release=openfaas, app=openfaas"

Po nějaké době spustíme navrhovaný příkaz:

$ kubectl -n openfaas get deployments -l "release=openfaas, app=openfaas"
NAME                READY   UP-TO-DATE   AVAILABLE   AGE
alertmanager        1/1     1            1           114s
basic-auth-plugin   1/1     1            1           114s
faas-idler          1/1     1            1           114s
gateway             1/1     1            1           114s
nats                1/1     1            1           114s
prometheus          1/1     1            1           114s
queue-worker        1/1     1            1           114s

Kontrola funkčnosti:

$ kubectl rollout status -n openfaas deploy/gateway
deployment "gateway" successfully rolled out
$ kubectl port-forward -n openfaas svc/gateway 8080:8080 &
[1] 6985
Forwarding from 127.0.0.1:8080 -> 8080
$ echo -n $PASSWORD | faas-cli login --username admin --password-stdin
Calling the OpenFaaS server to validate the credentials...
Handling connection for 8080
WARNING! Communication is not secure, please consider using HTTPS. Letsencrypt.org offers free SSL/TLS certificates.
credentials saved for admin http://127.0.0.1:8080
$ faas-cli list
Function                        Invocations     Replicas

Instalace Mongodb

Vše nainstalujeme pomocí kormidla:

$ helm repo add stable https://kubernetes-charts.storage.googleapis.com/
"stable" has been added to your repositories
$ helm install stable/mongodb --generate-name
NAME: mongodb-1577466908
LAST DEPLOYED: Fri Dec 25 11:15:11 2019
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
** Please be patient while the chart is being deployed **

MongoDB can be accessed via port 27017 on the following DNS name from within your cluster:

    mongodb-1577466908.default.svc.cluster.local

To get the root password run:

    export MONGODB_ROOT_PASSWORD=$(kubectl get secret --namespace default mongodb-1577466908 -o jsonpath="{.data.mongodb-root-password}" | base64 --decode)

To connect to your database run the following command:

    kubectl run --namespace default mongodb-1577466908-client --rm --tty -i --restart='Never' --image bitnami/mongodb --command -- mongo admin --host mongodb-1577466908 --authenticationDatabase admin -u root -p $MONGODB_ROOT_PASSWORD

To connect to your database from outside the cluster execute the following commands:

    kubectl port-forward --namespace default svc/mongodb-1577466908 27017:27017 &
    mongo --host 127.0.0.1 --authenticationDatabase admin -p $MONGODB_ROOT_PASSWORD

Zkontrolujeme:

kubectl run --namespace default mongodb-1577466908-client --rm --tty -i --restart='Never' --image bitnami/mongodb --command -- mongo admin --host mongodb-1577466908 --authenticationDatabase admin -u root -p $(kubectl get secret --namespace default mongodb-1577466908 -o jsonpath="{.data.mongodb-root-password}" | base64 --decode)
If you don't see a command prompt, try pressing enter.

> db.version();
4.0.14

Stisknutím ctrl+D opustíte kontejner.

Nastavení emacsu

V zásadě bylo vše již nakonfigurováno podle tento článek, takže nebudu zacházet do detailů.

Rozdělení hry na funkce

Interakce s funkcemi probíhá přes protokol http, end-to-end autentizaci mezi různými funkcemi zajišťuje JWT. Mongodb slouží k ukládání tokenů, ale i stavu hry, hráčských dat, sekvencí tahů všech her a dalších informací. Pojďme se blíže podívat na ty nejzajímavější funkce.

Registrace

Vstup této funkce je JSON s herní přezdívkou a heslem. Při zavolání této funkce je zkontrolováno, zda tento alias není v databázi, pokud je kontrola úspěšná, je alias a hash hesla vložen do databáze. Pro aktivní účast ve hře je nutná registrace.

vchod

Vstupem funkce je JSON s přezdívkou hry a heslem; pokud je v databázi přezdívka a heslo je úspěšně ověřeno s heslem dříve uloženým v databázi, vrátí se JWT, který musí být předán dalším funkcím, když jsou volal. Do databáze se také vkládají různé servisní záznamy, například čas posledního přihlášení atp.

Zobrazit seznam her

Každý neoprávněný uživatel si může vyžádat seznam všech her kromě aktivních. Oprávněný uživatel také vidí seznam aktivních her. Výsledkem funkce je JSON obsahující seznamy her (ID hry, člověkem čitelné jméno atd.).

Tvorba hry

Funkce funguje pouze s oprávněnými uživateli, na vstupu je akceptován maximální počet hráčů a parametry hry (například jaké postavy v této hře aktivovat, maximální počet hráčů atd.). Samostatným parametrem hry je přítomnost hesla pro připojení, které umožňuje vytvářet neveřejné hry. Ve výchozím nastavení je vytvořena veřejná hra. Výsledkem funkce je JSON, který obsahuje pole úspěšnosti vytvoření, jedinečný identifikátor hry a další parametry.

Připojení ke hře

Funkce funguje pouze s oprávněnými uživateli, vstupem je ID hry a její heslo, pokud se jedná o neveřejnou hru, výstupem je JSON s parametry hry. Oprávněný uživatel, který se připojil ke hře, stejně jako tvůrce hry, jsou dále nazýváni účastníky hry.

Prohlížení herních událostí

Každý neoprávněný uživatel si může vyžádat seznam událostí pro neaktivní hry a oprávněný uživatel může obdržet seznam událostí pro jakoukoli aktivní hru. Doplňkovým parametrem funkce může být číslo události, které již uživatel má. V tomto případě budou do seznamu vráceny pouze události, které nastaly později. Pravidelným spouštěním této funkce oprávněný uživatel sleduje, co se děje ve hře. Tato funkce také vrací požadavek na akci, na který může uživatel reagovat pomocí funkce odeslání události hry.

Odeslání herní události

Funkce funguje pouze pro účastníky hry: je možné spustit hru, provést tah, hlasovat, napsat textovou zprávu, která se zobrazí v seznamu herních událostí atd.
Oprávněný uživatel, který hru vytvořil, začne distribuovat role všem účastníkům hry, včetně sebe, svou roli musí potvrdit pomocí stejné funkce. Jakmile jsou všechny role potvrzeny, hra se automaticky přepne do nočního režimu.

Herní statistiky

Funkce funguje pouze pro účastníky hry, zobrazuje stav hry, seznam a počet hráčů (přezdívky), role a jejich stav (provedený či neprovedený tah) a další informace. Stejně jako u předchozí funkce vše funguje pouze pro účastníky hry.

Pravidelně spouštěné funkce

Pokud hra nebyla spuštěna po určitou dobu uvedenou při vytváření hry, bude automaticky odstraněna ze seznamu aktivních her pomocí funkce clear.

Dalším periodickým úkolem je nucené přepínání herního režimu z noci na den a zpět u her, u kterých k tomu během tahu nedošlo (např. hráč, který potřebuje reagovat na herní událost, z nějakého důvodu neposlal své řešení ).

Oznámení

úvod
Nastavení vývojového prostředí, rozdělení úkolu do funkcí
Backendová práce
Frontendová práce
Nastavení CICD, organizace testování
Spusťte zkušební hru
Výsledky

Zdroj: www.habr.com

"Nové eposy". Slona jíme po částech