TokkoCLI

Komm her, bleib hier, Wir sind gut zu dir

TOC

• English version
• Como instalar TokkoCLI
  • Pip
  • Setup.py
• Primeros pasos
  • Seciones
    • Auth
    • User
      • Inicializar
    • Daemon
      • Instalar
      • Desinstalar
      • Ejecutar en Foreground
      • Estado
      • SystemCtl
    • RPC
      • Ejecutar funciones
    • Workflow

Como instalar la TokkoCLI?

La herramienta TokkoCLI debe ser instalada a nivel global usando cualquiera de las opciones de instalación que a continuación se presentan:

Mediante PIP:

sudo -H pip3 install tools/tokko-cli

O mediante el instalador:

sudo -H python3 tools/tokko-cli/setup.py install

Primeros pasos

Finalizada la instalación del paquete tokko-cli (Pip|Setup.py), tendras una nueva herramienta de consola llamada tokky. Lo primero que debemos hacer antes de comenzar a utilizar nuestra CLI es inicializarla, para ello vamos a ejecutar el siguiente comando:

# No require permisos de super usuario.
# Y no, no es buena idea ...
tokky user init [--user]

Este comando mostrara una salida similar a esta:

---
Welcome {YOUR-USER}!
Your CLI is ready to use!!

More Info:
+ Sources: /home/{your-user}/tokko/sources/services-tokkobroker
+ Github RefreshToken: r1.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ Token Expiration: 2021-01-20T03:15:00.00000-03:00

Una vez inicializada la tokko-cli vamos a proceder a instalar el daemon la misma con el siguiente comando:

# Requiere permisos de super usuario.
sudo -H tokky daemon install

Y si todo salio bien, deberias tener una salida similar a esta:

Installing TokkoCLI daemon ...
TokkoCLI daemon was successfully installed

Ahora si! Ya esta todo listo para que empieces a utilizar tu tokko-cli,

Para continuar, no olvides revisar nuestra seccion de tutoriales

Secciones:

La tokkoCLI se encuentra dividida en cinco secciones, Auth, Daemon, Project, RPC y User.

Auth

Integracion con el TokkoAuthSDK. Este feature aun no se encuentra disponible en las versiones estables.

Daemon:

Proceso en background utilizado por la CLI para procesar las solucitudes del usario.

Install

Install tokkoCLI daemon as SystemD service.

$ sudo tokky daemon install

Desinstalar el Daemon

Desistala el proceso de la tokkoCLI.

$ tokky daemon uninstall

Correr deamon en Foregound

El daemon de la tokkoCLI tambien puede ser ejecutado en modo "attached".

$ tokky daemon run [--port {custom-port}]

Estado del Daemon

Obtener el estado actual del deaemon. Esta información tambien puede consultarse mediante SystemCtl.

$ tokky daemon status

La tokkoCLI y SystemCtl

El daemon de la tokkoCLI es un servicio SystemD, por tanto es fatible utilizar ``SystemCtl`

Chequear el estado del servicio

systemctl status tokko-cli-daemon.service

Activar el servicio TokkoCLI.daemon

systemctl Enable tokko-cli-daemon.service

Iniciar el servicio TokkoCLI.daemon

systemctl start tokko-cli-daemon.service

User

Manejo de la cuenta de usuario dentro de la tokkoCLI

Inicializar usuario de la TokkoCLI

tokky user init

RPC

Integracion TokkoRPC. LLamados a procedimientos remotos dentro del cloud de servicios.

Invocando funciones RPC

tokky rpc call {function} [--service {my-serice: String}] [--data {data: String}]

Ejemplo: Invocando a la funcion Echo:

$ tokky rpc call echo --data "Hola Mundo!"
>>> "Hola Mundo!"

Project

Herramientas para la gestion de projectos dentro del stack de servicios de TokkoBroker

Listar los servicios

tokky project ls [--details|-d]

Crear un nuevo Servicio:

Crear un nuevo Project(Servicio) utilizando los templates de Tokko. Por omision este comando creara proyectos basados en el template django, pero en caso de que quieras utilizar el template flask solo debes anexar el flag --flask

# No requiere permisos de super usuario
tokky project new {nombre-del-projecto} [--flask]

Exportar Servicio

Para agregar un nuevo servicio al Stack general de servicios de TokkoBroker utilizaremos en comando export de la tokkoCLI. Este comando generara una carpeta llamada .meta dentro del raiz del proyecto. La carpeta .meta contendra el descriptor del servicio(AKA *.tbs file).

# No requiere permisos de super usuario
tokky project export {nombre-del-projecto}

Un TBS tendra un aspecto similar al siguiente, dependiendo el servicio que se haya exportado

[nombre-del-servicio]
RequirePostgreDB = yes
DatabaseName = nombre_del_servicio_srv_db
RequireRabbitMQ = no
Volumes = .:/app
ContainerPort = 8000
Command = python manage.py runserver 0.0.0.0:8000
ShouldPatchCommand = yes

[nombre-del-servicio-rpc-service]
RequirePostgreDB = yes
DatabaseName = nombre_del_servicio_srv_db
RequireRabbitMQ = no
Volumes = .:/app
ContainerPort = 9142
Command = python manage.py run_rpc_server
ShouldPatchCommand = no

Sicronizar stack de sevicios

# No requiere permisos de super usuario
tokky project sync