Modo Declarativo de Sensedia CLI

Visión General

Con el Modo Declarativo de Sensedia CLI, puede gestionar los recursos utilizando archivos .yaml en lugar de escribir comandos seguidos de flags o responder a las preguntas interactivas. Nuestro Modo Declarativo se enfoca más en lo que quiere lograr en vez que en cómo. También significa que puede describir los recursos que desea añadir, editar o eliminar en un solo archivo, lo que puede permitir un resultado más rápido. Sin embargo, si prefiere ir paso a paso, sólo tiene que volver a las páginas anteriores. Allí describimos cómo gestionar los recursos de API Platform y Adaptive Governance a través de preguntas, con el modo interactivo, o mediante flags.

Comandos Necesarios

Básicamente, sólo se utilizarán dos comandos para soportar el Modo Declarativo:

# Al crear nuevos recursos o actualizar los existentes
$ ssd apply -f archivo.yaml <opciones>

# Al eliminar los recursos que se crearon anteriormente
ssd delete -f archivo.yaml <opciones>

Utilización (Cómo Estructurar los Objetos)

apiVersion: nombre-de-la-api/version-de-la-api
kind: tipo de recurso (ej.: entorno, API, plan, etc.)

# La estructura de los metadatos consistirá en un conjunto de campos con clave y valor,
que sólo se utilizarán para la documentación del archivo.
# Esta información no se guardará así como tampoco se vinculará a ningún recurso en Sensedia API Platform.
metadata:
# Descripción de texto libre relacionada con cada recurso;
  # El campo "spec" puede variar según el objeto que se quiera crear;
# Consulte los esquemas de json para encontrar la información requerida y otras reglas relativas a cada "Kind".

spec:
  # Campos de identificación:
    # Consulte la sección de cada producto para conocer los requisitos específicos.
  # Otros campos:
    # Consulte la sección de cada producto para conocer los requisitos específicos.

Procesamiento de documentos

  • En primer lugar, Sensedia CLI comprobará si el tipo de archivo es .yaml y si contiene al menos un documento. Luego, utilizando el comando ssd apply, el archivo será procesado de acuerdo a su propio orden declarado.

  • Cuando se utiliza el comando ssd delete, los documentos se procesarán en el orden inverso al declarado en el archivo.

CLI informará si hay errores al procesar los archivos. Sin embargo, continuará procesando el archivo de entrada y realizando las demás operaciones. Cuando se utilizan los flags --fail-fast o -e, CLI interrumpe la ejecución en el primer documento que contenga un error. El flag --validate-file puede ser usado para validar la estructura del archivo, sólo con fines de verificación, pero sin aplicar ningún cambio a la plataforma.

Cuando la ejecución termina, Sensedia CLI deberá mostrar un listado con los recursos modificados:

Summary:

# Created Resources: X
# Updated Resources: Y
# Deleted Resources: Z
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]