В этой статье я буду настраивать рабочее окружение для разработки игры "Былины", а также выполню разбиение самой игры на части, пригодные для использования в OpenFaaS. Все манипуляции буду делать на Linux, Kubernetes буду разворачивать в minikube с использованием VirtualBox. В моей рабочей машине 2 процессорных ядра и 12гб оперативной памяти, в качестве системного диска я применяю SSD. В качестве основной системы для разработки буду использовать debian 8, с установленными пакетами emacs, sudo, git и virtualbox, все остальное установлю путем скачивания из GitHub и других источников. Эти приложения будем устанавливать в /usr/local/bin, если не указано другое. Приступим!

Подготовка рабочего окружения

Установка Go

Следуем инструкциям с официального сайта:

$ 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

Проверяем работоспособность:

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

import "fmt"

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

Установка faas-cli

Следуем инструкциям с официального сайта:

$ 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

Дополнительно можно подключить работу bash-completion:

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

Установка и настройка Kubernetes

Для разработки достаточно minikube, так что установим его и kubelet в /usr/local/bin, для установки приложений также установим helm:

$ 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

Запускаем 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"

Проверяем:

$ 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

Установка OpenFaaS

Разработчики рекомендуют создать 2 namespace для работы:

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

Добавляем репозиторий для helm:

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

В чарте есть возможность задать пароль перед установкой, воспользуемся ею и сохраним данные доступа в виде секрета k8s:

$ 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

Выполняем развертывание:

$ 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"

Спустя некоторое время запускаем предложенную команду:

$ 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

Проверяем работоспособность:

$ 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

Установка Mongodb

Ставим все с использованием helm:

$ 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

Проверяем:

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

Жмем ctrl+D для выхода из контейнера.

Настройка emacs

В принципе, все было уже настроено по этой статье, так что не буду подробно расписывать.

Разбиение игры на функции

Взаимодействие с функциями осуществляется посредством протокола http, сквозная аутентификация между разными функциями обеспечивается JWT. Для хранения токенов, а также состояния игры, данных игроков, последовательностей ходов всех игр и другой информации используется mongodb. Давайте рассмотрим детальнее наиболее интересные функции.

Регистрация

На входе этой функции — JSON с игровым псевдонимом и паролем. При вызове этой функции выполняется проверка отсутствия этого псевдонима в базе данных, при успешной проверке — вставка псевдонима и хэша пароля в базу. Регистрация необходима для активного участия в игре.

Вход

На входе функции — JSON с игровым псевдонимом и паролем, при наличии псевдонима в базе и успешной проверке пароля с сохраненным ранее в базе возвращается JWT, который надо передавать другим функциям при их вызове. Также выполняется вставка в базу разных служебных записей, к примеру времени последнего входа и т.п.

Просмотр списка игр

Любой неавторизованный пользователь может запросить список всех игр, кроме активных. Авторизованный пользователь также видит и список активных игр. Результат функции — JSON, содержащий списки игр (идентификатор игры, человекочитаемое имя и т.п.).

Создание игры

Функция работает только с авторизованными пользователями, на входе принимается максимальное число игроков, а также параметры игры (например, каких персонажей активировать в этой игре, максимальное число игроков и т.п.). Отдельным параметром игры является наличие пароля на присоединение, что позволяет создать непубличные игры. По-умолчанию создается публичная игра. Результатом выполнения функции является JSON, в котором есть поле успешности создания, уникальный идентификатор игры, а также другие параметры.

Присоединение к игре

Функция работает только с авторизованными пользователями, на входе — идентификатор игры и ее пароль, если это непубличная игра, на выходе — JSON с параметрами игры. Авторизованный пользователь, присоединившийся к игре, а также создатель игры далее зовутся участниками игры.

Просмотр событий игры

Любой неавторизованный пользователь может запросить список событий неактивных игр, а авторизованный — получить список событий и любой активной игры. Дополнительным параметром функции может передаваться номер события, который уже есть у пользователя. В этом случае в списке вернутся только те события, которые произошли позднее. Периодически запуская эту функцию авторизованный пользователь смотрит, что происходит в игре. Также эта функция возвращает запрос на действие, на которое пользователь может отреагировать с помощью функции отправки события игры.

Отправка события игры

Функция работает только для участников игры: реализуется возможность запустить игру, сделать ход, проголосовать, написать текстовое сообщение, которое отображается в списке событий игры и т.п.
Авторизованный пользователь, создавший игру, запускает раздачу ролей всем участникам игры, включая себя, они должны подтвердить свою роль с помощью этой же функции. Как только все роли подтверждены, игра автоматически переходит в режим ночи.

Статистика игры

Функция работает только для участников игры, показывает состояние игры, список и число игроков (псевдонимы), роли и их статус (сделан ход, или нет), а также другую информацию. Как и для предыдущей функции, все работает только для участников игры.

Периодически запускаемые функции

Если игра не была запущена в течение некоторого времени, указанного при создании игры — она будет автоматически удалена из списка активных игр с помощью функции зачистки.

Еще одна периодическая задача — принудительное переключение режима игры с ночи в день и обратно для игр, у которых этого не произошло во время хода (к примеру, игрок, которому надо отреагировать на игровое событие, не прислал свое решение по каким-либо причинам).

Анонс

Введение
Установка окружения для разработки, разбиение задачи на функции
Работы над backend
Работы над frontend
Настройка CI\CD, организация тестирования
Запуск пробного сеанса игры
Итоги

«Новые Былины». Едим слона по частям