Modo Declarativo do Sensedia CLI

Visão geral

Com o Modo Declarativo do Sensedia CLI é possível gerenciar recursos utilizando arquivos .yaml, em vez de passar comandos seguidos por flags ou responder perguntas no modo interativo. Nosso Modo Declarativo foca mais no resultado que se deseja alcançar, do que nas etapas para se chegar nele. Isso também significa que é possível descrever os recursos que deseja criar, modificar ou excluir em apenas um arquivo. O que proporciona um resultado mais rápido. No entanto, se preferir seguir passo a passo, basta voltar para as páginas anteriores. Lá descrevemos como gerenciar os recursos da API Platform e do Adaptive Governance por meio de perguntas, com o modo interativo, ou utilizando flags.

Comandos Necessários

Basicamente, apenas dois comandos serão usados no suporte ao Modo Declarativo:

# Ao criar novos recursos ou atualizar os existentes
$ ssd apply -f archivo.yaml <opções>

# Ao excluir os recursos que foram criados anteriormente
ssd delete -f archivo.yaml <opções>

Utilização (Como Estruturar os Objetos)

apiVersion: nome-da-api/versao-da-api
kind: tipo de recurso (ex.: ambiente, API, plano, etc.)

# A estrutura dos metadados consiste em um conjunto de campos com chave e valor,
que só deve ser utilizada para fins de documentação do arquivo.
# Estas informações não serão salvas e nem vinculadas a nenhum recurso da Sensedia API Platform.
metadata:
# Descrição em texto livre relacionada a cada recurso;
  # O campo "spec" pode variar de acordo com o objeto a ser criado;
# Consulte os esquemas de json para encontrar as informações necessárias e outras regras relacionadas a cada "Kind".

spec:
  # Campos de identificação:
    # Consulte a seção de cada produto para verificar as exigências específicas de cada um.
  # Outros campos:
    # Consulte a seção de cada produto para verificar as exigências específicas de cada um.

Processamento de documentos

Primeiramente, o Sensedia CLI verificará se o tipo de arquivo é .yaml e se contém pelo menos um documento. Então, ao utilizar o comando ssd apply, o arquivo será processado conforme a ordem declarada nele.
Quando o comando ssd delete é utilizado, os documentos são processados na ordem oposta àquela declarada no arquivo.

O CLI reportará caso haja erros durante o processamento dos arquivos. Entretanto, ele continuará processando o arquivo de entrada e realizando as outras operações. Quando as flags --fail-fast ou -e são informadas, o CLI interrompe a execução no primeiro documento que contenha algum erro. A flag --dry-run pode ser utilizada para validar a estrutura do arquivo apenas para fins de verificação, mas sem aplicar nenhuma mudança na plataforma.

Quando a execução estiver concluída, o Sensedia CLI mostrará uma lista com os 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]