Base de conocimientos  /  Cloud Application Manager  /  Tutoriales
Base de conocimientos  /  Cloud Application Manager  /  Tutoriales

Cómo utilizar ebcli

Actualizado por Diego Sanjuan en 20 de mayo de 2019
Código del artículo: kb/1216

En este artículo:

Resumen

Este tutorial es para que los usuarios de Cloud Application Manager aprendan a usar ebcli, nuestra herramienta de línea de comando, para controlar su cuenta de Cloud Application Manager como se ve a continuación: 

  • Para casillas - cómo implementar, exportar, importar como versión o como borrador, etc., con ebcli.
  • Para instancias - cómo reconfigurar, reinstalar, apagar, encender, exportar, etc., con ebcli.
  • Para imágenes ECS - cómo gestionarlas con ebcli.
  • Para espacios de trabajo - cómo enumerarlos con ebcli.

ebcli hace que las API en segundo plano de Cloud Application Manager enumeren, provean y gestionen el ciclo de vida de sus cargas de trabajo en función de la configuración de la casilla.

Público

Todos los usuarios de Cloud Application Manager que quieran controlar su cuenta de Cloud Application Manager utilizando la herramienta de línea de comando ebcli.

Requisitos previos

  • Acceso al sitio de Cloud Application Manager o a la Cloud Application Manager Dedicated Edition (dispositivo CAM) local.
  • El usuario debe tener una cuenta existente para iniciar sesión utilizando nombre de usuario y contraseña o su mecanismo de autenticación preferido.

Instalación de la herramienta de línea de comando ebcli

Antes de comenzar a utilizar ebcli, necesita instalarla utilizando pip que es un administrador de paquetes para paquetes Python, o módulos si lo prefiere.

Si no tiene pip instalado.  Siga esta guía para instalarla en su ordenador: https://pip.pypa.io/en/stable/install/

Comando de terminal

Abra una terminal en su computadora y ejecute el comando de instalación:

pip install ebcli

Cuando el proceso de instalación termine, pip debería haber instalado ebcli y todas sus dependencias requeridas.

Iniciar sesión en su cuenta de Cloud Application Manager con ebcli

Antes de que pueda controlar su cuenta de Cloud Application Manager con ebcli, necesita conectar su cuenta en Cloud Application Manager con ebcli.

Ebcli necesita un token para iniciar sesión en su cuenta de Cloud Application Manager.

Pasos a seguir para crear un token

  • Abra https://cam.ctl.io si está utilizando SaaS o https://YOUR_APPLIANCE_FQDN si está utilizando una edición in situ de Cloud Application Manager
  • Inicie sesión con su nombre de usuario y contraseña o su método de autenticación preferido. 
  • Haga clic en el menú de su nombre de usuario (en la esquina superior derecha de la interfaz de usuario de CAM)
  • Haga clic en "Authentication Tokens" (Tokens de autenticación)
  • Escriba un nombre descriptivo para su token, es decir, ebcli
  • Haga clic en "Create Token" (Crear token)
  • Haga clic en el botón copiar a la derecha de su token para copiarlo

Comando de terminal

Abra una terminal en su computadora y ejecute el comando de inicio de sesión:

ebcli login

Se le pedirá que introduzca su "token de autenticación", solo debe pegar su token y presionar Enter.

Ahora su computadora le pedirá la contraseña de su token físico para guardar el token de Cloud Application Manager con seguridad en su token físico.

Mostrar los comandos de ebcli disponibles

Comando de terminal

Abra una terminal en su computadora y ejecute el comando de inicio de sesión:

ebcli

ebcli mostrará ayuda de uso como esta:

usage: ebcli [-h] [--url URL] [--token TOKEN] [--debug] [--verbose] [-j]
             {boxes,build,delete,deploy,get,export,export-instance,import,instances,login,logout,set,poweron,reconfigure,reinstall,shutdown,terminate,workspaces}
             ...
ebcli: error: too few arguments

Parámetros generales

Opción para obtener casillas Descripción
--url De manera predeterminada es https://cam.ctl.io, pero puede utilizar esto para especificar el FQDN de su dispositivo.
–-token Puede utilizarlo para especificar su token en cada comando si no quiere guardarlo en su token físico.
–-debug Muestre información de depuración para proporcionar rastreos detallados en caso de problemas.
–-verbose Muestre información detallada de operaciones y llamadas api solicitadas a Cloud Operation Manager.

Comandos de casilla con ebcli

Obtener casillas

Utilice ebcli para enumerar sus casillas.

Comando de terminal

ebcli boxes [-f [-f [<FIELD> [<FIELD> ...]]] [-r [<REQUIREMENT> [<REQUIREMENT> ...]]] [-w “<WORKSPACE ID>”]

Parámetros

Opción para obtener casillas Descripción
-f Campo o campos que quiere enumerar.
–r Etiquetas de requisitos que quiere utilizar para filtrar sus casillas, por ej. ubuntu
–w El espacio de trabajo que contiene las casillas que quiere enumerar.

Exportar una casilla

Utilice ebcli para explotar una casilla de Cloud Application Manager hacia JSON y archivos de texto para poder importarla luego.

Comando de terminal

ebcli export [--boxes-path <BOXES_PATH>] [-r] ”<box ID>”

Parámetros

Opción Descripción
–-boxes-path Ruta hacia donde se exportarán las casillas.
-r Exporte de manera recursiva casillas y casillas internas.

Importar una casilla

Utilice ebcli para importar una casilla desde su JSON y archivos de texto hacia Cloud Application Manager o su dispositivo.

Comando de terminal

ebcli import [--boxes-path <BOXES_PATH>] [-w <WORKSPACE_ID>] [-m <COMMENT>] [--image <IMAGE>] [--as-draft] box-name

Parámetros

Opción Descripción
–-boxes-path Ruta donde están ubicadas las casillas.
-w ID de espacio de trabajo donde se importará la casilla.
–m Se creará una descripción de la versión, por ejemplo, "Requisitos de actualización".
–-image Nombre de la imagen base que se utilizará, por ejemplo, ubuntu:0.1 o Centos.
–-as-draft En lugar de crear una versión, la casilla se importará como borrador de la casilla.

Implementar una application box

Utilice ebcli para implementar una application box en su Cloud Application Manager o en la cuenta de su dispositivo.

Comando de terminal

ebcli deploy [-w <WORKSPACE_ID>] [-t [<TAG> [<TAG> ...]]] [-c [<CLAIM> [<CLAIM> ...]]] input

Parámetros

Opción Descripción
-w ID de espacio de trabajo donde se importará la casilla
–t Etiqueta o etiquetas que marcarán y aislarán las instancias y enlaces de su aplicación, por ejemplo, "producción us-east-0"
–c Afirma seleccionar las políticas de implementación correctas para ser utilizadas por instancias. Por ejemplo, "ubuntu us-east-0"
–input El documento JSON de la aplicación a implementar

Ciclo de vida de la instancia con ebcli

Obtener instancias

Utilice ebcli para enumerar sus instancias.

Comando de terminal

ebcli instances [-f [<FIELD> [<FIELD> ...]]] [-t [<TAG> [<TAG> ...]]] [-w “<WORKSPACE ID>”]

Parámetros

Opción para obtener casillas Descripción
-f Campo o campos que quiere enumerar.
–t Etiqueta o etiquetas utilizadas para filtrar sus instancias, por ejemplo, "producción us-east-0"
–w El espacio de trabajo que contiene las instancias que quiere enumerar.

Reconfigurar una instancia

Utilice ebcli para ejecutar una operación de reconfiguración en una instancia que está activa.

Comando de terminal

ebcli reconfigure ”<instance-id>”

Parámetros

Opción Descripción
instance-id ID de la instancia cuyas casillas quiere reconfigurar.

Reinstalar una instancia

Utilice ebcli para ejecutar una operación de reinstalación en una instancia que está activa.

Comando de terminal

ebcli reinstall ”<instance-id>”

Parámetros

Opción Descripción
instance-id ID de la instancia que quiere activar.

Cancelar una instancia

Utilice ebcli para ejecutar una operación de cancelación en una instancia que esté aprovisionada.

ADVERTENCIA: Esta es una operación destructiva

No se puede conectar a una instancia, reiniciarla o recuperarla luego de cancelarla.

Antes de cancelar la instancia, verifique que no perderá datos al corroborar que sus volúmenes no serán eliminados con la terminación y que ha copiado todos los datos que necesita de los volúmenes de su instancia a un servidor de almacenamiento persistente.

Cuando una instancia es cancelada, los datos en cualquier almacenamiento de instancia y volúmenes asociados con esa instancia se eliminan.

Cuando cancela una instancia, toda el historial de la instancia se mantiene en Cloud Application Manager y puede utilizarlo como referencia para otras instancias, copiar las variables o clonar la instancia. La instancia en su proveedor en la nube está cancelada o desaprovisionada.

Después de cancelar una instancia, se mantiene visible en la consola de su proveedor en la nube durante un corto período de tiempo, y luego se elimina automáticamente la entrada. Después de que se cancela una instancia, los recursos como etiquetas y volúmenes se desvinculan gradualmente de la instancia.

Comando de terminal

ebcli terminate ”<instance-id>”

Parámetros

Opción Descripción
instance-id ID de la instancia que desea cancelar.

Activar una instancia

Utilice ebcli para ejecutar una operación de reinstalación en una instancia que está apagada.

Comando de terminal

ebcli reinstall ”<instance-id>”

Parámetros

Opción Descripción
instance-id ID de la instancia que quiere reinstalar.

Apagar una instancia

Utilice ebcli para ejecutar una operación de apagado en una instancia que está activa.

Comando de terminal

ebcli shutdown ”<instance-id>”

Parámetros

Opción Descripción
instance-id ID de la instancia cuyas casillas quiere apagar.

Exportar casillas de instancias

Utilice ebcli para explotar una casilla de Cloud Application Manager hacia JSON y archivos de texto para poder importarla luego.

Comando de terminal

ebcli export-instance [--boxes-path <BOXES_PATH>] [-r] ”<instance-id>”

Parámetros

Opción Descripción
–-boxes-path Ruta hacia donde se exportarán las casillas.
-r Exporte de manera recursiva casillas externas e internas.
instance-id ID de la instancia cuyas casillas quiere exportar.

Ciclo de vida de imágenes ECS utilizando con ebcli

Compilar la imagen

Utilice ebcli para compilar la imagen.

Comando de terminal

ebcli build ”<box ID>” [-t “<image name>”] [--image <image name>] [--boxes-path <boxes path>]

Parámetros

Opción de implementación Descripción
-t Nombre de la imagen a compilar.
–-image Nombre de la imagen base que se utilizará. Por ejemplo, ubuntu:0.1 o Centos.
–-boxes-path Ruta donde están ubicadas las casillas.

Subir la imagen

Utilice el cliente docker para subir la imagen a su registro de docker favorito. Si tiene preguntas acerca de este paso, revise la documentacion oficial de Docker acerca de imágenes.

Comando de terminal

docker push “<image name>”

Publicar la imagen

Utilice ebcli para publicar la imagen en su casilla

Comando de terminal

ebcli post “<docker image>”

Lista de espacios de trabajo con ebcli

Obtener espacios de trabajo

Utilice ebcli para enumerar sus espacios de trabajo

Comando de terminal

ebcli workspaces [-f [<FIELD> [<FIELD> ...]]]

Parámetros

Opción para obtener casillas Descripción
-f Campo o campos que quiere enumerar.

Eliminar recursos con ebcli

Eliminar instancias, casillas o espacios de trabajo

Utilice ebcli para eliminar sus recursos.

Comando de terminal

ebcli delete (-b BOX_ID | -i INSTANCE_ID | -w WORKSPACE_ID)

Parámetros

Opción para obtener casillas Descripción
box-id ID de la casilla que quiere eliminar.
instance-id ID de la instancia que quiere eliminar.
workspace-id ID del espacio de trabajo que quiere eliminar.

Cerrar sesión de su cuenta de Cloud Application Manager con ebcli

Quitar token del token físico de su computadora

Utilice ebcli para cerrar sesión

Comando de terminal

ebcli logout

Comunicarse con soporte de Cloud Application Manager

Lamentamos que esté teniendo problemas en el Gestor de aplicaciones en la nube. Revise los consejos para solucionar problemas o comuníquese con soporte de Cloud Application Manager para proporcionar detalles y capturas de pantalla de ser posible.

Para problemas relacionados con las llamadas API, envíe el cuerpo de la solicitud junto con los detalles del problema.

En el caso de error de casilla, comparta la casilla en el espacio de trabajo en el que su organización y Cloud Application Manager pueden ingresar y adjunte los registros.

  • Linux: SSH y busque el registro en /var/log/elasticbox/elasticbox-agent.log
  • Windows: RDP dentro de la instancia para buscar el registro en C:\ProgramData\ElasticBox\Logs\elasticbox-agent.log
Powered by Translations.com GlobalLink OneLink SoftwarePowered By OneLink