Criando um Manual com o Visual Designer

Use o designer visual para projetar e criar runbooks personalizados no Fleet Application Management. O designer fornece uma interface de arrastar com uma opção para adicionar código para que você possa criar e editar runbooks com mais facilidade. O manual pode ser escrito em YAML ou JSON. No entanto, você pode criar um manual sem a necessidade de criá-lo em JSON nativo ou YAML usando o designer visual.

Com o designer visual, você pode executar as seguintes tarefas:

  • Projetar um runbook usando os componentes do runbook.
  • Simplifique a execução do runbook.
  • Configure instruções condicionais com o construtor de condições.
  • Configure execuções de tarefas condicionais com base em componentes do produto, variáveis de entrada e saída, ou ambos.
  • Configure o tratamento de erros.
  • Ilustre runbooks fornecidos pelo Fleet Application Management.
  • Clone runbooks ilustrados para ajudá-lo a criar runbooks personalizados em que você adiciona seu código no modo de origem ou designer.

À medida que você cria um manual, o designer visual valida seu trabalho e gera código automaticamente. Você pode revisar o código gerado ou exportá-lo para desenvolvimento local. Depois de criar o runbook, você pode salvá-lo, publicá-lo e examinar os resultados na Console.

O designer visual tem os seguintes componentes de interface na exibição Design:
  • O painel ações no lado direito contém as guias Componentes e Propriedades.
  • A tela no centro é um espaço reservado no qual você cria o manual. Você pode arrastar os componentes do painel de ações, como grupos de recursos paralelos ou contínuos, e arrastar tarefas para esses grupos. Você pode alterar a ordem dos componentes na tela colocando-os na ordem em que deseja que as tarefas sejam executadas ou selecionar ações para configurar propriedades ou tratar erros.

    A tela também contém o ícone de edição ao lado de cada componente de tarefa para exibir e modificar a tarefa do manual.

    Para exibir o código YAML ou JSON gerado automaticamente para o manual à medida que você estiver usando o designer visual, selecione View de código na tela. Quando você atualiza o YAML ou o JSON, as alterações são geradas automaticamente no modo de designer.

Painel Ações

No painel de ações, você pode selecionar componentes a serem arrastados para a área de trabalho na tela. O painel contém os seguintes itens:

Guia Componentes

A guia Componentes fornece um conjunto de componentes que você pode arrastar para a área de trabalho do manual na tela. Esses componentes são uma nova tarefa, um grupo de tarefas paralelo, um grupo de recursos paralelo e um grupo de recursos contínuo.
Importante

Para adicionar uma tarefa, primeiro você deve adicionar um grupo de recursos paralelo ou incremental. Uma tarefa deve estar dentro de um grupo. Para obter mais informações sobre o uso de tipos de grupo, consulte Criando um Manual.
  • Nova tarefa: Use este botão para criar tarefas para um runbook. Agora é possível adicionar uma tarefa que pode executar um script especificando o tipo de ação como um script.
  • Grupo de tarefas paralelas: Todas as tarefas que fazem parte de um grupo de tarefas paralelas são executadas paralelamente em um recurso (recursos de computação e banco de dados) que fazem parte de uma frota.

    Por exemplo, se uma frota tiver dois recursos e duas tarefas (task1 e task2) que fazem parte do grupo de tarefas paralelas, task1 e task2 serão executados paralelamente em resource1 e resource2.

  • Grupo de recursos paralelo: Todas as tarefas que fazem parte de um grupo de recursos paralelo são executadas paralelamente entre recursos (recursos de computação e banco de dados) que fazem parte de uma frota. Dentro de um recurso, as tarefas que fazem parte de um grupo de recursos paralelo são executadas sequencialmente.

    Por exemplo, se uma frota tiver dois recursos e duas tarefas (task1 e task2) que fazem parte do grupo de recursos paralelo, task1 e task2 serão executados sequencialmente em resource1 e resource2, e a execução em resource1 e resource2 ocorrerá em paralelo.

  • Grupo de recursos incremental: Todas as tarefas que fazem parte de um grupo de recursos incremental são executadas sequencialmente entre recursos (recursos de computação e banco de dados) que fazem parte de uma frota. Dentro de um recurso, as tarefas que fazem parte de um grupo de recursos incremental são executadas sequencialmente.

    Por exemplo, se uma frota tiver dois recursos e duas tarefas (task1 e task2) que fazem parte do grupo de recursos contínuos, task1 e task2 serão executados sequencialmente em resource1. Após a conclusão das tarefas resource1, task1 e task2 são executados sequencialmente em resource2.

Guia Propriedades

A guia Propriedades fornece definições para controlar as instruções condicionais e configurar o tratamento de erros dos componentes que você adiciona à tela. Depois de adicionar um componente à área de trabalho na tela em Tarefas ou Tarefas de Rollback, configure-o para atender ao seu caso de uso. Selecione o ícone de propriedades (ícone de definições) do componente para configurar suas propriedades e opções. Você também pode ver o código YAML ou JSON selecionando View de código. As propriedades estão disponíveis para um manual, grupos e tarefas.

Propriedades do Manual

Veja a seguir as duas propriedades de um manual:

  • Em caso de falha de tarefas: A opção selecionada para essa propriedade é o valor padrão para todos os grupos e tarefas dentro de um runbook.
  • Executar em: A opção selecionada descreve onde e como as tarefas são executadas. Pode envolver instâncias programadas, ambientes auto-hospedados ou instâncias selecionadas com base nos resultados de tarefas anteriores. Estas são as subpropriedades de Run on:
    • Instâncias especificadas pela programação: Essa propriedade é usada para execução condicional de um manual em um destino quando a condição é avaliada como verdadeira. É mais adequado para gerenciar fluxos de trabalho de pilha de produtos em um manual.
    • Instância auto-hospedada: Esta propriedade ajuda a localizar e selecionar uma instância auto-hospedada para tarefas de pós-provisionamento
    • Instância especificada pela tarefa anterior: Essa propriedade indica que a execução de uma tarefa depende da conclusão de uma tarefa anterior.

Propriedades do grupo

Veja a seguir as cinco propriedades de um grupo:

  • Em caso de falha: A opção selecionada para essa propriedade decidirá o próximo conjunto de ações se uma das tarefas de um grupo falhar. A execução do runbook no destino continuará se você selecionar Continuar, a execução do runbook do produto no destino for interrompida e a execução do runbook da pilha do produto no grupo de ações for interrompida se você selecionar Abortar e a execução do runbook for movida para a etapa de rollback se você selecionar Rollback. Com base no escopo de rollback, a ação de rollback pode estar no nível do alvo ou do grupo de ações.
  • Pré-condição: Especifica a condição usando variáveis de entrada da tarefa atual e variáveis de saída de todas as tarefas anteriores. Uma tarefa será executada no destino somente se a condição for avaliada como verdadeira.
  • Executar em: Especifica a condição usando o nome do produto de destino (para runbook de pilha de produtos), as propriedades do produto e o nome do componente e as propriedades do componente de um destino. Uma tarefa só será executada no destino se a condição for avaliada como verdadeira.

    Por exemplo, no runbook da pilha de produtos do Oracle WebLogic Server e do Java Patching, para executar uma tarefa somente no destino do Oracle WebLogic Server se o valor da propriedade java_version for 1.8.0_391 e quando o componente ADMIN_SERVER estiver disponível, informe a condição a seguir.

    target.product.name == "Oracle Weblogic Server" AND target.product.properties.java_home == "1.8.0_391" AND target.product.components.ADMIN_SERVER.properties.Server == "AdminServer"
    
  • Pausar execução: Uma opção que interrompe a execução do runbook até que você intervenha ou a duração definida expire. A pausa acontece antes da execução de uma tarefa.
  • Notificação: Notifica você usando o serviço OCI Notification sobre o status da tarefa.

Propriedades da tarefa

As tarefas incluem uma propriedade extra em comparação com um grupo. A seguir está a descrição da propriedade:

Mapeamento de variáveis de saída: Para o tipo de tarefa Executar um script, a saída dos logs de script é analisada para avaliar o valor da variável de entrada com uma correspondência padrão de $$VARIABLE=VALUE$$.

Por exemplo, se uma tarefa depender da saída da tarefa anterior, execute as seguintes etapas para mapear a variável de entrada:
  1. Marque a caixa de seleção da variável de saída e adicione uma variável de saída. A execução do script do Fleet Application Management garante que a variável de saída seja preenchida.
  2. Na próxima tarefa, marque a caixa de seleção da variável de entrada e adicione uma variável de entrada.
  3. Mapeie o nome da variável de entrada para o nome da variável de saída das tarefas anteriores usando Mapeamento de variável de saída.

    O script Fleet Application Management agora analisa os logs de saída para identificar um padrão como $$VARIABLE=VALUE$$.

Guia da Biblioteca

A guia Biblioteca de tarefas fornece uma lista de tarefas reutilizáveis prontas para uso que existem no Gerenciamento de Aplicativos de Frota ou que você criou. Você pode usar o ícone de alça de arrastar (ícone de arrastar e soltar) no canto direito de uma tarefa para arrastá-lo para a área de trabalho do manual na tela. A biblioteca exibe apenas as tarefas relevantes para um manual com base no produto ou na pilha de produtos e no tipo de sistema operacional.

Reverter Tarefas

Para reverter uma tarefa definida se ela falhar, você pode adicionar um grupo e, em seguida, adicionar as tarefas a serem revertidas dentro do espaço reservado Reverter tarefas na área de trabalho da tela. Para fazer rollback, certifique-se de selecionar a propriedade da tarefa Em Caso de Falha como Rollback em Tarefas para a tarefa específica.

Observação

Você pode definir o escopo do rollback para um destino ou níveis de grupo de ações. Esse escopo significa que o Fleet Application Management executa as tarefas de rollback em um destino específico ou em todos os grupos de destinos. As tarefas de rollback executadas no destino que falharão se você fizer o escopo de um destino, enquanto as tarefas de rollback serão executadas em todo o grupo de destinos se você fizer o escopo de um grupo de ações.

Canvas

Depois de determinar uma ação a ser adicionada ao designer visual, arraste um componente para a área de trabalho da tela. Para alterar a ordem dos componentes, use o ícone de alça de arrastar (ícone de arrastar e soltar) no canto direito de um componente para arrastá-lo para outro local na área de trabalho do manual. Essa nova ação é adicionada à área de trabalho e seu código é gerado automaticamente.

Atalhos de Teclado para Navegação

O designer visual suporta os seguintes atalhos de teclado ao projetar runbooks.
Atalhos do Teclado Ação
Tab Navegar no foco para o próximo elemento de runbook.
Shift+Tab Navegue no foco para o elemento de runbook anterior.
Teclas de seta Mova um componente depois disso na tela. Por exemplo:
  • Mova um novo componente de tarefa dentro de um grupo na tela pressionando a tecla de seta para a esquerda.
  • Reorganize tarefas ou grupos na tela após a seleção quando o foco estiver no ícone de controle de arrastar dos elementos ( alça para arrastar).
Barra de espaço ou Enter/Return Selecione um componente na guia Componentes, Propriedades ou um elemento de runbook.
Esc Cancele a movimentação de um componente para a tela ou qualquer ação antes de ela ser acionada.
Barra de espaço ou Enter Acionar uma atividade apropriada quando o foco estiver em qualquer um dos componentes, propriedades ou elementos do manual. Por exemplo:
  • Coloque um componente na posição atual depois de selecioná-lo.
  • Ative a alternância para configuração de tarefas de rollback.
  • Coloque o grupo selecionado na tela depois que ele for movido usando as teclas de seta para o recurso paralelo ou os componentes do grupo de tarefas paralelos.
  • Coloque um novo componente de tarefa dentro de um grupo na tela depois de movê-lo usando as respectivas teclas de seta. Após essa ação, pressione o atalho de teclado (Barra de espaço ou Enter) para abrir a caixa de diálogo Criar tarefa para a tarefa.