Add ingress activation + create RUS readme (#4)

* Add ingress activation + create RUS readme

Author: lenkis

.gitignore

@@ -74,4 +74,6 @@ tags
 ### VisualStudioCode ###
 .vscode/*
 .history
+### MacOS specific ###
+.DS_Store
 # End of https://www.gitignore.io/api/go,vim,emacs,visualstudiocode

README.md

@@ -5,19 +5,23 @@ align="right">
 
 # Tarantool Kubernetes operator
 
-The Tarantool Operator provides automation that simplifies the administration of [Tarantool Cartridge](https://github.com/tarantool/cartridge)-based clusters on Kubernetes.
+The Tarantool Operator provides automation that simplifies the administration
+of [Tarantool Cartridge](https://github.com/tarantool/cartridge)-based clusters
+on Kubernetes.
 
-The Operator introduces new API version `tarantool.io/v1alpha1` and installs custom resources for objects of three custom types: Cluster, Role, and ReplicasetTemplate.
+The Operator introduces new API version `tarantool.io/v1alpha1` and installs
+custom resources for objects of three custom types: Cluster, Role, and
+ReplicasetTemplate.
 
 ## Table of contents
 
 * [Resources](#resources)
 * [Resource ownership](#resource-ownership)
 * [Deploying the Tarantool operator on minikube](#deploying-the-tarantool-operator-on-minikube)
-* [Example: key value storage](#example-key-value-storage)
-  * [Application topology overview](#application-topology-overview)
-  * [Running the example](#running-the-example)
-  * [Scaling the example application](#scaling-the-example-application)
+* [Example: key-value storage](#example-key-value-storage)
+  * [Application topology](#application-topology)
+  * [Running the application](#running-the-application)
+  * [Scaling the application](#scaling-the-application)
   * [Running tests](#running-tests)
 
 ## Resources
@@ -30,11 +34,14 @@ The Operator introduces new API version `tarantool.io/v1alpha1` and installs cus
 
 ## Resource ownership
 
-Resources managed by the Operator being deployed have the following resource ownership hierarchy:
+Resources managed by the Operator being deployed have the following resource
+ownership hierarchy:
 
 ![Resource ownership](./assets/resource_map.png)
 
-Resource ownership directly affects how Kubernetes garbage collector works. If you execute a delete command on a parent resource, then all its dependants will be removed.
+Resource ownership directly affects how Kubernetes garbage collector works.
+If you execute a delete command on a parent resource, then all its dependants
+will be removed.
 
 ## Deploying the Tarantool operator on minikube
 
@@ -66,6 +73,12 @@ Resource ownership directly affects how Kubernetes garbage collector works. If y
     apiserver: Running
     ```
 
+1. Enable Ingress add-on:
+
+    ```shell
+    minikube addons enable ingress
+    ```
+
 1. Create operator resources:
 
     ```shell
@@ -74,7 +87,7 @@ Resource ownership directly affects how Kubernetes garbage collector works. If y
     kubectl create -f deploy/role_binding.yaml
     ```
 
-1. Create Tarantool Operator CRD's;
+1. Create Tarantool Operator CRD's (Custom Resource Definitions):
 
     ```shell
     kubectl create -f deploy/crds/tarantool_v1alpha1_cluster_crd.yaml
@@ -94,43 +107,48 @@ Resource ownership directly affects how Kubernetes garbage collector works. If y
     kubectl get pods --watch
     ```
 
-    Wait for `tarantool-operator-xxxxxx-xx` Pod's STATUS to become `Running`.
+    Wait for `tarantool-operator-xxxxxx-xx` Pod's status to become `Running`.
 
-## Example: key value storage
+## Example: key-value storage
 
-`examples/kv` contains a Tarantool-based distributed key value storage. Data are accessed via HTTP REST API.
+`examples/kv` contains a Tarantool-based distributed key-value storage.
+Data are accessed via HTTP REST API.
 
-### Application topology overview
+### Application topology
 
 ![App topology](./examples/kv/assets/topology.png)
 
-### Running the example
+### Running the application
 
-We assume that commands are executed from the repository root and Tarantool Operator is up and running.
+We assume that commands are executed from the repository root and
+Tarantool Operator is up and running.
 
 1. Create a cluster:
 
     ```shell
     kubectl create -f examples/kv/deployment.yaml
     ```
 
-1. Wait until the cluster Pods are up:
+   Wait until all the cluster Pods are up (status becomes `Running`):
 
      ```shell
      kubectl get pods --watch
      ```
 
 1. Access the cluster web UI:
 
-   1. Get `minikube` vm ip-address:
+   1. Get `minikube` vm IP-address:
 
        ```shell
        minikube ip
        ```
 
-   1. Navigate to **http://MINIKUBE_IP** with your browser. Replace MINIKUBE_IP with the IP-address reported by the previous command.
+   1. Open **http://MINIKUBE_IP** in your browser.
+      Replace MINIKUBE_IP with the IP-address reported by the previous command.
+
+      ![Web UI](./assets/kv_web_ui.png)
 
-1. Access KV API:
+1. Access the key-value API:
 
    1. Store some value:
 
@@ -144,15 +162,15 @@ We assume that commands are executed from the repository root and Tarantool Oper
        curl http://MINIKUBE_IP/kv_dump
        ```
 
-### Scaling the example application
+### Scaling the application
 
 1. Increase the number of replica sets in Storages Role:
 
     ```shell
     kubectl scale roles.tarantool.io storage --replicas=3
     ```
 
-    This will add one or more replica sets to the existing cluster.
+    This will add new replica sets to the existing cluster.
 
     View the new cluster topology via the cluster web UI.
 
@@ -162,7 +180,8 @@ We assume that commands are executed from the repository root and Tarantool Oper
     kubectl edit replicasettemplates.tarantool.io storage-template
     ```
 
-    This will open a text editor. Change `spec.replicas` field value to 3, then save and exit the editor.
+    This will open a text editor. Change `spec.replicas` field value to 3,
+    then save and exit the editor.
 
     This will add one more replica to each Storages Role replica set.
 

README_RUS.md

@@ -0,0 +1,197 @@
+<a href="http://tarantool.org">
+   <img src="https://avatars2.githubusercontent.com/u/2344919?v=2&s=250"
+align="right">
+</a>
+
+# Tarantool Kubernetes-оператор
+
+Tarantool Kubernetes-оператор -- это средство автоматизации, позволяющее
+упростить администрирование Tarantool-кластеров, разработанных на фреймворке
+[Tarantool Cartridge](https://github.com/tarantool/cartridge) и развернутых
+под управлением Kubernetes.
+
+Kubernetes-оператор реализует API версии `tarantool.io/v1alpha1` устанавливает
+ресурсы для объектов трех типов: Cluster, Role и ReplicasetTemplate.
+
+## Содержание
+
+* [Ресурсы](#ресурсы)
+* [Владение ресурсами](#владение-ресурсами)
+* [Развертывание оператора в minikube](#развертывание-оператора-в-minikube)
+* [Пример: база данных типа ключ-значение](#пример-база-данных-типа-ключ-значение)
+  * [Топология приложения](#топология-приложения)
+  * [Запуск приложения](#запуск-приложения)
+  * [Масштабирование приложения](#масштабирование-приложения)
+  * [Запуск тестов](#запуск-тестов)
+
+## Ресурсы
+
+**Cluster** -- это кластер, разработанный с помощью Tarantool Cartridge.
+
+**Role** -- это пользовательская роль, разработанная с помощью Tarantool Cartridge.
+
+**ReplicasetTemplate** -- это шаблон StatefulSet-ов, которые являются членами Role.
+
+## Владение ресурсами
+
+Так выглядит иерархия владения у ресурсов, которыми управляет запущенный оператор:
+
+![Resource ownership](./assets/resource_map.png)
+
+Иерархия владения ресурсами прямым образом влияет работу сборщика мусора в Kubernetes.
+Если выполнить команду удаления на родительском ресурсе, то сборщик удалит и все
+зависимые ресурсы.
+
+## Развертывание оператора в minikube
+
+1. Установите необходимое ПО:
+
+    - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl)
+
+    - [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
+
+1. Создайте кластер в `minikube`:
+
+    ```shell
+    minikube start --memory=4096
+    ```
+
+    Для работы кластера и приложений-примеров вам понадобится выделить 4Gb оперативной памяти.
+
+    Удостоверьтесь, что `minikube` успешно запущен:
+
+    ```shell
+    minikube status
+    ```
+
+    В случае успеха вывод в консоли будет выглядеть так:
+
+    ```shell
+    host: Running
+    kubelet: Running
+    apiserver: Running
+    ```
+
+1. Активируйте компонент Ingress:
+
+    ```shell
+    minikube addons enable ingress
+    ```
+
+1. Создайте ресурсы для оператора:
+
+    ```shell
+    kubectl create -f deploy/service_account.yaml
+    kubectl create -f deploy/role.yaml
+    kubectl create -f deploy/role_binding.yaml
+    ```
+
+1. Создайте пользовательские описания ресурсов (CRD) для оператора:
+
+    ```shell
+    kubectl create -f deploy/crds/tarantool_v1alpha1_cluster_crd.yaml
+    kubectl create -f deploy/crds/tarantool_v1alpha1_role_crd.yaml
+    kubectl create -f deploy/crds/tarantool_v1alpha1_replicasettemplate_crd.yaml
+    ```
+
+1. Запустите оператор:
+
+    ```shell
+    kubectl create -f deploy/operator.yaml
+    ```
+
+    Удостоверьтесь, что оператор успешно запущен:
+
+    ```shell
+    kubectl get pods --watch
+    ```
+
+    Дождитесь, пока Pod `tarantool-operator-xxxxxx-xx` перейдет в статус `Running`.
+
+## Пример: база данных типа ключ-значение
+
+В директории `examples/kv` содержится код распределенного приложения на Tarantool,
+которое реализует базу данных типа ключ-значение.
+Доступ к данным осуществляется с помощью HTTP REST API.
+
+### Топология приложения
+
+![App topology](./examples/kv/assets/topology.png)
+
+### Запуск приложения
+
+Предполагается, что все команды выполняются из корня репозитория,
+а Tarantool-оператор уже запущен и работает.
+
+1. Создайте кластер:
+
+    ```shell
+    kubectl create -f examples/kv/deployment.yaml
+    ```
+
+   Дождитесь, пока все Pod-ы кластера перейдут в статус Running:
+
+     ```shell
+     kubectl get pods --watch
+     ```
+
+1. Откройте веб-интерфейс администратора кластера:
+
+   1. Узнайте IP-адрес виртуальной машины `minikube`:
+
+       ```shell
+       minikube ip
+       ```
+
+   1. Откройте страницу **http://MINIKUBE_IP** в браузере,
+      заменив MINIKUBE_IP на IP-адрес из вывода предыдущей команды.
+
+      ![Web UI](./assets/kv_web_ui.png)
+
+1. Выполните API-запросы к хранилищу:
+
+   1. Запишите в базу тестовые данные:
+
+       ```shell
+       curl -XPOST http://MINIKUBE_IP/kv -d '{"key":"key_1", "value": "value_1"}'
+       ```
+
+   1. Запросите данные из базы:
+
+       ```shell
+       curl http://MINIKUBE_IP/kv_dump
+       ```
+
+### Масштабирование приложения
+
+1. Увеличьте количество репликасетов-хранилищ:
+
+    ```shell
+    kubectl scale roles.tarantool.io storage --replicas=3
+    ```
+
+    В результате к существующему кластеру добавятся новые репликасеты.
+
+    Проверьте в веб-интерфейсе, что топология изменилась.
+
+1. Увеличьте количество реплик внутри каждого репликасета-хранилища:
+
+    ```shell
+    kubectl edit replicasettemplates.tarantool.io storage-template
+    ```
+
+    В открывшемся текстовом редакторе поменяйте значение поля `spec.replicas`
+    на 3, сохраните изменения и закройте редактор.
+
+    В результате к каждому репликасету-хранилищу добавятся новые реплики.
+
+    Проверьте в веб-интерфейсе, что топология изменилась.
+
+### Запуск тестов
+
+```shell
+make build
+make start
+./bootstrap.sh
+make test
+```