Documentação do Oracle Cloud Infrastructure

Criando um Manual

Crie um manual personalizado no Fleet Application Management usando o designer visual.

O Fleet Application Management fornece vários runbooks com etapas predefinidas que você pode usar para executar tarefas comuns de gerenciamento do ciclo de vida, como verificações de integridade de pré-execução, descoberta do servidor Oracle HTTP. Esses runbooks estão disponíveis na biblioteca de runbooks. Você também pode criar seus runbooks personalizados e publicá-los para todos os usuários.

  • Na página da lista Runbooks, selecione Criar runbook. Se precisar de ajuda para localizar a página da lista, consulte Listando Runbooks.

    A criação de um manual consiste nas seguintes páginas:

    Execute cada um dos seguintes workflows pela ordem. Você pode retornar a uma página anterior, selecionando Anterior.

    1. Informações básicas

    A página Informações básicas é onde você fornece as informações básicas do manual.

    Digite as seguintes informações:

    • Nome: Digite um nome amigável para o runbook. Não é necessário que o nome seja exclusivo, mas não pode ser alterado na Console. No entanto, você pode alterá-lo com a API. Evite digitar informações confidenciais.
    • Descrição: Informe uma descrição adequada para o manual.
    • Criar no compartimento: Selecione o compartimento para o qual você deseja criar o manual.
    • Compartimento da operação do ciclo de vida: Selecione um compartimento no qual exista a operação do ciclo de vida específica. Para saber mais sobre várias operações do ciclo de vida, consulte Operação do Ciclo de Vida no Fleet Application Management.
    • Operação de ciclo de vida: Selecione uma operação de ciclo de vida — por exemplo, patch, descoberta, provisionamento ou personalizado.
    • Para operações de ciclo de vida de patch ou descoberta, especifique as seguintes informações:
      • Compartimento da pilha de Produtos/Produtos: Selecione o compartimento no qual a pilha de produtos ou produtos está.
      • Pilha de Produtos/Produtos: Selecione no compartimento uma pilha de produtos ou produtos à qual a tarefa pertence.
    • Tipo de SO: Selecione uma plataforma suportada entre as opções nas quais o manual é executado.
    • Tempo estimado (Horas): Selecione o tempo estimado em horas para concluir a execução do manual.
    • Definir como runbook padrão: Ative a alternância para permitir que o Fleet Application Management use esse runbook como o runbook padrão para executar operações de ciclo de vida.
      Observação

      Você pode definir apenas um runbook para uma operação de ciclo de vida específica e uma combinação de produto ou pilha de produtos como o runbook padrão. O Fleet Application Management usa o manual de descoberta padrão de um produto ou pilha de produtos para descobrir o inventário de software do produto e o manual de aplicação de patches padrão para selecionar automaticamente um manual durante as tarefas de criação de programação e correção de conformidade.
    • Esse manual precisa de acesso SUDO: Ative a alternância se o tipo de SO for Oracle Linux para descobrir e aplicar patches ao software em execução nas instâncias do serviço Compute.

      O acesso ao sudo é necessário quando o suporte ao produto é necessário para o Oracle WebLogic Server, o Oracle HTTP Server (OHS) e o Oracle Java, que não são específicos do OCI.

      Observação

      Quando o runbook tem o acesso sudo ativado, o plug-in do Fleet Application Management executa as tarefas com o privilégio sudo. O plug-in Fleet Application Management usa um privilégio sudo incorporado, mas é totalmente controlado por meio da propriedade runbook isSudoAccessNeeded. Consulte Referência do Manual.

    Selecione Próxima para prosseguir para a próxima etapa.

    2. Simplifique (Design Runbook)

    A página Simplificar (Criar runbook) é onde você cria um workflow de runbook usando o designer visual ou o código do runbook.

    Com o designer visual, você pode arrastar uma ação do painel ações para a tela, colocando-a onde quiser no workflow do seu manual. Também é possível reordenar ações no fluxo de trabalho arrastando-as para um local diferente.

    1. Selecione uma das seguintes opções:
      • View de design: Use o designer visual arrastando os componentes e configurando-os. Etapa 2.
      • View de código: Faça upload do código do manual em um arquivo YAML ou JSON. Etapa 3.
    2. Se você selecionou Exibição de design para criação de manual, execute as seguintes etapas:
      Importante

      Para adicionar uma tarefa, primeiro adicione um grupo de recursos paralelo ou incremental. Uma tarefa deve estar dentro de um grupo. Para saber mais sobre como usar o designer visual, consulte Criando um Manual com o Visual Designer.
      1. Na guia Componentes do painel de ações, selecione um grupo de recursos paralelo ou um grupo de recursos incremental e arraste-o para a tela. Adicione quantos grupos forem necessários.
        • Para a execução paralela de tarefas de runbook entre recursos, selecione um grupo paralelo. Um grupo de recursos paralelo é um espaço reservado para uma ou mais tarefas dentro dele, ou outro grupo de tarefas paralelo que executa várias tarefas em um recurso de destino em paralelo. Para cada tarefa adicionada a um grupo de recursos paralelo, a lista de tarefas é executada uma após a outra em um recurso específico, mas simultaneamente em uma lista de recursos.
        • Para execução sequencial de tarefas de runbook, selecione um grupo de recursos incremental. Um grupo de recursos contínuos é um espaço reservado para uma ou mais tarefas em que a lista de tarefas é executada uma após a outra em um recurso específico. Depois que as tarefas forem executadas com sucesso no recurso, a próxima tarefa será executada em outro recurso.
        Dica

        É possível reordenar componentes usando o ícone de alça de arrastar (arrastar e soltar) no canto direito de um componente e arrastá-lo para outro local na área de trabalho do manual. Depois que você coloca um componente na tela, seu código é gerado automaticamente e adicionado ao código do manual.
      2. Selecione uma nova tarefa e arraste-a para um grupo de recursos que você adicionou. Informe os detalhes na página Criar tarefa. Para obter instruções, consulte as etapas de 4 a 17 em Criando uma tarefa usando a Console. Você também pode adicionar uma tarefa predefinida arrastando-a para um grupo de recursos.
        • As tarefas criadas dentro do runbook são locais para o runbook e não podem ser reutilizadas por outros runbooks.
        • A biblioteca de tarefas fornece uma lista de tarefas reutilizáveis que existem ou que você criou. Você pode usar o ícone arrastar alça ( ícone de arrastar e soltar) no canto direito de uma tarefa para arrastá-la para o grupo de recursos.
          Dica

          Você pode primeiro criar tarefas de runbook conforme necessário e depois adicioná-las a um ou mais runbooks posteriormente.
        • Para criar uma cópia da tarefa na biblioteca de tarefas, selecione Fazer uma cópia desta tarefa na biblioteca. Esta tarefa é, então, uma parte do manual e da biblioteca de tarefas. No entanto, você pode reutilizar e atualizar a tarefa da biblioteca independentemente da tarefa do runbook.
      3. Para atualizar as propriedades de uma tarefa, selecione o ícone de edição ao lado da tarefa e atualize os valores de campo na página Editar tarefa.
      4. Depois de adicionar os componentes necessários ao runbook, selecione o ícone de propriedades (ícone de definições) do componente para configurá-lo usando a guia Propriedades.
      5. Informe um nome de etapa exclusivo, de preferência com base em sua finalidade. Evite digitar informações confidenciais.
      6. Selecione uma das seguintes ações na lista Em caso de falha para configurar como a automação pode tratar erros no workflow do runbook:
        Observação

        Por padrão, quando um componente de runbook reporta um erro, a automação do Fleet Application Management interrompe totalmente o workflow do runbook. Isso ocorre porque o valor padrão da propriedade Em Caso de Falha para todos os componentes é Abortar.
        • Abortar: Interrompa o workflow do runbook inteiramente quando a execução do componente falhar. Esta ação é definida por padrão.
        • Continuar: prossiga para a próxima etapa no workflow do runbook quando a execução do componente falhar.
        • Rollback: Desfaça a alteração e retorne ao nível em que o componente do runbook foi inicialmente.

          Para fazer rollback, certifique-se de selecionar a propriedade Em Caso de Falha como Rollback. Você pode especificar a função de rollback nos níveis de destino ou grupo (grupo de ações). Para fazer rollback no nível de destino, selecione Em caso de falha de tarefas ou selecione Em caso de falha de tarefas de rollback para fazer rollback no nível do grupo.

      7. Para criar instruções condicionais para cada componente do manual usando a opção Condição,
        Informe uma variável na caixa de condição, selecione um dos operadores aritméticos, como AND, NOT ou outros, e informe um valor para a condição. Veja a seguir um exemplo de instrução condicional:
        Para a condição a seguir, se a variável backuptype de uma tarefa for igual ao valor hot, a tarefa será executada ou o construtor de condições ignorará e avançará para a próxima tarefa. 
        backuptype=hot
      8. Configure Executar em para selecionar uma das seguintes opções para executar uma tarefa:
        • Instâncias especificadas por programação: Para permitir que uma tarefa seja executada condicionalmente apenas em determinados componentes aplicáveis ao produto (conforme definido nos metadados do produto) no recurso, selecione Filtrar instâncias. Para obter instruções sobre como adicionar condições de filtro, consulte a subetapa i.
        • Instância auto-hospedada: Para verificar a atividade de pós-provisionamento, se necessário, selecione uma instância auto-hospedada apropriada que você criou em Gerenciamento de metadados na seção Administração.
          Observação

          A seleção de uma instância garante que a tarefa seja executada somente neste host (instância).

          Por exemplo, pode haver duas tarefas em que o tipo de ação da primeira tarefa é Executar um Terraform que provisiona os recursos. A segunda tarefa pode ser com o tipo de ação Executar um script, em que o script inclui a instância auto-hospedada (host central) que verifica se os recursos estão provisionados e em execução.

          Importante

          Certifique-se de ativar o plug-in Fleet Application Management na sua instância auto-hospedada e na instância associada. Esta etapa garante que o Fleet Application Management possa considerar efetivamente essas instâncias para operações de ciclo de vida.
        • Instância especificada pela tarefa anterior: Para verificar se os recursos provisionados são criados e executados quando você não configura um host central.
          Por exemplo, pode haver duas tarefas que executam as seguintes operações:
          1. Crie uma primeira tarefa com o tipo de ação como Executar um Terraform que provisione as instâncias do serviço Compute e retorne o OCID dos recursos provisionados como uma variável de saída.
          2. Crie uma segunda tarefa com o tipo de ação Executar um script.
          3. Selecione Variável de saída da tarefa anterior para fornecer as variáveis da tarefa.
          4. Informe o OCID do recurso que a subetapa i retorna ou um tipo de recurso opcional. Adicione mais informações do host conforme criadas pela primeira tarefa. Os OCIDs ou tipos de recursos servem como uma entrada para a segunda tarefa.
            Dica

            As informações do host podem ser fornecidas como um arquivo JSON com OCIDs de recurso descritos como array.

          O Fleet Application Management agora analisa as variáveis de saída e executa o script nos recursos.

      9. Se você tiver selecionado Instâncias especificadas por programação na subetapa h, selecione instâncias para abrir a caixa de diálogo Filtrar instâncias.
        • Selecione as propriedades do produto ou componente na caixa no lado esquerdo para adicioná-lo à caixa de filtro no lado direito.
        • Selecione um dos operadores aritméticos, como AND, NOT ou outros.
        • Informe um valor para a condição na caixa de condições.
          Observação

          À medida que você seleciona propriedades de produto ou componente, a caixa de filtro é preenchida com uma condição gramatical relevante.
          Um exemplo da condição de gramática Run on é o seguinte: 
          target.product.name = <product_name>
target.product.properties.<property_name> = <property_value>
target.product.components.has(<component_name>)
target.product.components.<component_name>.properties.<property_name> = <property_value>
          Observação

          As condições baseadas em propriedades dependem da sua compreensão da descoberta do produto.
        Adicione mais instâncias de filtro conforme necessário. Essas instâncias são adicionadas à próxima linha na caixa de filtro.
      10. Alterne a opção Pausar execução para interromper ou atrasar a execução de tarefas por um tempo específico até que determinadas condições sejam atendidas. Por exemplo, você pode optar por pausar a execução de uma tarefa indefinidamente ou até retomar a tarefa ou por um tempo específico selecionado.
      11. Para ser notificado quando o status da tarefa for alterado, ative a opção Notificação e, em seguida, marque a caixa de seleção da atividade da tarefa para a qual você deseja ser notificado, por exemplo, em caso de falha da tarefa, em pausa ou quando a tarefa for bem-sucedida.
      12. Configure as propriedades das tarefas que você adicionar. Para obter a descrição do campo de propriedades da tarefa, consulte as etapas de 4 a 17 em Criando uma Tarefa usando a Console.
    3. Se você selecionou View de código para criação de runbook na etapa 1, selecione se você está usando JSON ou YAML e, em seguida, selecione Fazer upload do código do runbook para adicionar o arquivo apropriado.
    Selecione Próxima para prosseguir para a próxima etapa.

    3. Verificação

    Verifique o conteúdo do manual na página Revisar. Edite as configurações ou retorne às telas anteriores para adicionar informações.

    Selecione Salvar como rascunho para salvar o manual inicialmente até ter certeza de todos os componentes.
    Observação

    Esta versão de rascunho do manual não está ativa, não pode ser usada e está marcada como Rascunho.

    Para tornar o manual utilizável depois de ter certeza de todas as suas tarefas e agilizar (sequência de execução), selecione Publicar versão mais recente na página de detalhes do manual.

    O runbook publicado está disponível para uso em provisionamento, descoberta, aplicação de patches ou rollback e tem um status ativo.
    Observação

    O runbook é criado com a versão 1 como a versão inicial e tem um status ativo.

  • Use o comando oci fleet-apps-management fleet-apps-management-runbooks runbook create e os parâmetros necessários a seguir para criar um runbook personalizado:

    oci fleet-apps-management fleet-apps-management-runbooks runbook create --compartment-id <compartment_OCID> --display-name <text> --operation <text> --runbook-version <json_file_or_string> [OPTIONS]

    Para obter uma lista completa de flags e opções de variáveis para comandos da CLI do Fleet Application Management, consulte a CLI para Gerenciamento de Aplicativos de Frota.

  • Execute a operação CreateRunbook para criar um runbook personalizado.