Orquestador Rocketbot : Instancias

¿Qué es una instancia?

Una instancia es el vínculo entre el ordenador del usuario y el servidor del Orquestador. Es la responsable de la ejecución tanto manual como automatizada de los robots.

¿Cómo asigno una instancia?

Para poder asignar una instancia, lo primero que debemos hacer es tener un proceso de algún proyecto seleccionado. Y entrar a su menú de configuración (“View” del proceso).

_{Si todavía no tiene su primer proyecto o proceso, es recomendable ver el siguiente documento: ¿Cómo crear mi primer proceso?.}

Crear o vincular una instancia.

Una vez dentro del “view” del proceso, se nos mostrara esta vista:

Para crear o seleccionar una instancia, hacemos clic en el botón de [Add or Link Instance], aunque también está el botón de [Connect Instance]. Y se nos abrirá un modal, en el cual tendremos dos opciones.

Vincular una instancia existente

“Link existing instance”: (Vincular una instancia existente) El cual es un select donde podremos ver una lista de todas las instancias que poseemos, y deberemos seleccionar una.

Nueva Instancia

“Create New”: (Crear nueva instancia) El cual es un input al cual le proporcionaremos un nombre para la instancia (un nombre que no exista aun) y al darle a “save” crearemos nuestra nueva instancia.

Conectar instancia al cliente

De forma predeterminada, luego de ponerle nombre a la instancia, no estará vinculada con el equipo. Por lo tanto, hay que hacer clic en el menú de la instancia (los tres puntos) y allí seleccionar el botón [Connect to Client].

Allí se mostrará un paso a paso de cómo descargar el cliente del orquestador y cómo conectar la instancia:

Descargar el “cliente orquestador”: (El boton rojo “Download for MS windows”) Se nos descargara un archivo comprimido, cuyo contenido debemos copiar en nuestra pc.

Dentro correremos el ejecutable ”OrchestratorClient.exe”, el cual nos abrirá una ventana de acceso. Y debemos colocar nuestro servidor (Copiar el “server URL” del punto 4)

Elegir una opción para configurar nuestras credenciales para acceder al servidor.

• “Credentials”: (Credenciales) Debemos colocar el “email” y el “Password” (contraseña) de nuestra cuenta con la que ingresamos normalmente al orquestador.

• “API KEY”: (Llave única de nuestro usuario) La podremos encontrar en la información que nos proporciona el punto 4. O si bien, podremos encontrarla en la información de nuestro perfil. Es la opción más privada ya que no debemos utilizar nuestra contraseña.

^{_{Importante: La “API KEY” tiene un periodo de vencimiento de 2 años, luego de eso hay que volver a generar una nueva por seguridad.}}

• “File noc.ini”: (Archivo de configuración) Opción para retro compatibilidad del “noc.ini” de versiones anteriores. ^{_{(Ver punto 6)}}

Aquí obtenemos los datos relevantes para una configuración rápida.

También podremos descargar una plantilla del “noc.ini” si utilizamos la opción del punto 3 (File noc.ini)

Configuración

En el extremo superior derecho tendremos el icono en el cual podremos aplicar configuraciones secundarias:

• “Proxy”: (Filtro de seguridad) En caso de que exista dicho filtro a la salida de internet, se debe configurar para habilitar la conexión entre el equipo y la instancia del servidor que se desea conectar. Donde debemos colocar el protocolo http seguido del pin de salida y puerto utilizado.

• “Run when Wintows starts”: (Correr cuando inicia Windows) Si está habilitada, el cliente se ejecutara automáticamente cuando se inicie Windows.

• “Login automatically (Only API KEY)”: (Iniciar sesión automáticamente) Si está habilitada y si se utiliza el método “API KEY”, cuando se inicia el cliente se iniciará sesión automáticamente.

• “Run minimized”: (Correr minimizado) Si está habilitado, el cliente correrá minimizado.

• “Reset ALL”: Resetea a la configuración original.}

Método File .ini

Al utilizar este método, no aplica las configuraciones del punto 5 y del punto 8, directamente dichas configuraciones se cargan directamente en el archivo “.ini”

• “user Access”:  Primera opción de acceso. Debemos colocar el “email” y el “Password” (contraseña) de nuestra cuenta con la que ingresamos normalmente al orquestador.

• “or API Key”: Segunda opción de acceso. (Llave única de nuestro usuario) La podremos encontrar en la información que nos proporciona el punto 4. O si bien, podremos encontrarla en la información de nuestro perfil. Es la opción más privada ya que no debemos utilizar nuestra contraseña.

• “Instance ID”: “Key” (llave única) de la instancia. Se obtiene en el punto 4 (instance key). O en la vista de la instancia (key).

• “You Url Orchestrator”: Debemos colocar nuestro servidor (Copiar el “server URL” del punto 4)

• “proxy”: (Filtro de seguridad) En caso de que exista dicho filtro a la salida de internet, se debe configurar para habilitar la conexión entre el equipo y la instancia del servidor que se desea conectar. Donde debemos colocar el protocolo http seguido del pin de salida y puerto utilizado.

• “logs”: (Enviar registros al orquestador) Cuando está habilitado, permite enviar un registro de los comandos que se ejecutaron en nuestro robot. (Ver “getlogs” en herramientas de instancias)

• “path”: Colocaremos la dirección del ejecutable de rocketbot studio en nuestra computadora/equipo.

• “Nodebug”: Habilita (true) / deshabilita (false) los registros de consola de studio.

• “Screenshot”: (Permitir tomar captura de pantalla) Cuando está habilitado, permite capturar pantalla en el momento de la ejecución del robot, para visualizar si los programas que intervienen cumplieron su función y se cerraron correctamente. (Ver screenchot en herramientas de instancias)

Una vez configurado todo, conectar.

Configurar instancia y extras.

• “Select instance”: (Seleccionar instancia) Se nos abrirá un select con la lista de nuestras instancias para que elijamos cual queremos vincular.

• Allow take screenchot: (Permitir tomar captura de pantalla) Cuando está habilitado, permite capturar pantalla en el momento de la ejecución del robot, para visualizar si los programas que intervienen cumplieron su función y se cerraron correctamente. (Ver screenchot en herramientas de instancias)

• Send logs to Orchestrator: (Enviar registros al orquestador) Cuando está habilitado, permite enviar un registro de los comandos que se ejecutaron en nuestro robot. (Ver “getlogs” en herramientas de instancias)

• Enable Studio nodebug: Habilita/deshabilita los registros de consola de studio.

• Rocketbot path:  Colocaremos la dirección del ejecutable de rocketbot studio en nuestra computadora/equipo.

• Extra arguments: Para instalar módulos o actualizar drivers.

Se nos abrirá la consola y luego de unos segundos se conectará nuestra instancia.

Podremos visualizar en la vista del proceso que nuestra instancia se conectó correctamente.

Una vez corriendo la consola, podremos minimizarla lo cual se “ocultará”. Si queremos volver a interactuar con la ella iremos a “iconos ocultos”.

IMPORTANTE: No cerrar la consola.

• “Show”: Abrir consola.

• “Config”: Abrir configuración del punto 5.

• “change instance”: Cambiar instancia.

• “Exit”: Cerrar cliente orquestador.

Lista de instancias

Para ir a la lista de instancias nos dirigiremos a la pestaña “instances” ( ) abriendo la tabla de nuestras instancias.

Dentro de este listado podremos visualizar el nombre de la instancia, su llave única (key), su estado (status) y los procesos en donde dicha instancia interactúa. Y a un extremo podremos visualizar un menú desplegable (…) de las funciones que podremos hacer.

Estado de una instancia

El estado de cada instancia puede llegar a ser uno de los tres siguientes:

• “Connected”: (Conectado) Dicho estado se visualiza en la instancia cuando el proceso de configuración se completó correctamente y el puente de conexión entre la instancia y el equipo (Client) esté corriendo correctamente. En este estado podremos ver los datos de nuestro equipo en tiempo real.
• “Stopped”: (Interrumpido) Dicho estado se visualiza en la instancia cuando el proceso de configuración se completó correctamente, pero el puente de conexión entre la instancia y el equipo (Client) está cerrado o sin conexión. En este estado podremos ver los datos que tuvo nuestro equipo en su última conexión.
• “Not Connected” : (Desconectado) Dicho estado se visualiza en la instancia cuando el proceso de configuración no se completó correctamente. Se creó la instancia, pero nunca llego a tener un puente de conexión (Client) con algún equipo. Y debido a esto, no se puede visualizar los datos ya que nunca “perteneció” a ningún equipo.

Menú desplegable

“Connect to client”: Conexión con el cliente.

“Details”: (Detalles de la instancia) Se nos abrirá un modal con la información de dicha instancia:

Podremos encontrar:

• Su nombre.
• Su sistema operativo.
• Los datos del equipo:
  • Procesador.
  • RAM.
  • CPU.
  • Disco.
• Llave única (key).
• Lista de los procesos en donde interviene.

“Delete”: (Eliminar) Elimina una instancia. Por seguridad se nos abrirá un modal para poder confirmar la eliminación.

IMPORTANTE: Si eliminamos una instancia, se desvinculara automáticamente de todos los procesos en donde interviene.

Herramientas de una instancia

En caso de querer conocer las herramientas que posee la instancia, es recomendable leer el siguiente documento: Herramientas de Instancia.