Visão geral do console de Orquestração

O console do Orchestrator é um Aplicativo de Página Única que ajuda você a monitorar e executar a implantação do Orchestrator. Este artigo detalha os recursos com suporte no console do Orchestrator 2022.

Painel de navegação

O painel Navegação à esquerda mostra a árvore Runbook e Pastas, como a mostrada no runbook Designer. Ao contrário do console em versões anteriores, você não pode selecionar as Pastas, mas seleciona os Runbooks e exibe seus trabalhos e os executa.

O painel Navegação é sempre visível em todas as telas para permitir a navegação rápida para outros runbooks e pastas enquanto permanece na mesma tela.

À direita do painel de navegação, você pode ver a tela escolhida. A tela Painel é mostrada por padrão.

Observação

Atualmente, a atualização automática não tem suporte para nenhuma das telas. Recarregue a página manualmente.

Painel

O Painel mostra trabalhos ativos na parte superior seguido por uma tabela de todos os trabalhos concluídos (histórico). O painel Trabalhos concluídos (histórico) é recolhido por padrão, permitindo o foco nos trabalhos ativos.

Cada linha em ambos os painéis corresponde a um trabalho exclusivo. Um trabalho pode ter uma ou mais instâncias de runbook. Cada linha mostra:

• ID do trabalho: vincular ao Runbook
• Carimbos de data/hora: o número de instâncias bem-sucedidas e com falha é mostrado em uma das colunas de todas as linhas.
• Botões de ação: Parar trabalho ou exibir detalhes do trabalho

Você pode selecionar e expandir cada uma das linhas de trabalho e exibir as instâncias do trabalho.

Runbooks

Quando você seleciona um runbook na árvore de navegação ou seleciona um link de runbook, o aplicativo navega até a tela Runbook. O painel superior lista os metadados do runbook (editando status, carimbos de data/hora e assim por diante). O botão Executar disponível na tela permite enfileirar o runbook para execução no subconjunto desejado de servidores runbook. O botão Executar está desabilitado para runbooks que não estão no estado Publicado .

Abaixo deste painel há uma exibição com guias:

• Exibição: para a imagem gráfica do Runbook.
• Trabalhos: para a lista de trabalhos ativos e concluídos do runbook (veja abaixo).
• Instâncias: para obter a lista de instâncias ativas e concluídas do runbook em todos os seus Trabalhos (veja abaixo).

Você pode selecionar as linhas na exibição Trabalhos, assim como as da tela Painel. Trabalhos em execução podem ser interrompidos usando os botões à direita da linha em execução.

Enquanto essa tela estiver ativa, você pode escolher um runbook diferente na árvore de navegação. Isso não alterará a guia selecionada. Você pode examinar rapidamente trabalhos de runbooks diferentes selecionando a guia trabalhos e navegando até os runbooks desejados na árvore de navegação.

Trabalhos

Quando você seleciona um trabalho (usando o botão (i), o aplicativo navega até essa tela. O painel superior mostra os metadados do trabalho (carimbos de data/hora, parâmetros).

Uma tabela que mostra as Instâncias desse trabalho segue o painel.

A maioria dos trabalhos tem uma única Instância. Se o runbook tiver uma atividade de gatilho Monitor/Evento, cada gatilho iniciará uma instância de trabalho exclusiva. A captura de tela abaixo mostra um trabalho com mais de uma instância.

Observação

Um trabalho pode ter no máximo uma instância em execução a qualquer momento. No entanto, como um Runbook pode ter muitos trabalhos em execução simultânea, um Runbook pode ter mais de uma instância em execução.

O status do trabalho é mostrado visualmente com os ícones:

• Três pontos: o trabalho está na fila
• Ampulheta: o trabalho está em execução
• Círculo com barra: o trabalho foi cancelado
• Escala: Trabalho concluído com êxito
• Exclamação vermelha: Trabalho concluído, mas com falha
• Aviso: trabalho concluído com avisos

Instâncias

Quando você seleciona uma Instância (usando o botão (i), o aplicativo navega até essa tela. O painel superior mostra os metadados da Instância (ID do trabalho, carimbos de data/hora, parâmetros, servidor que executa essa instância).

O painel superior também tem três botões de navegação:

• Anterior: Exibir Instância que foi executada antes desta.
• Em seguida: Exiba a Instância que foi executada após esta.
• Mais recente: exibir a instância mais atual

Observação

A ID do trabalho é a mesma e, como a segunda instância ainda está em execução, o trabalho também ainda está em execução.

Abaixo do painel, você verá o diagrama de runbook. Você pode selecionar cada atividade de runbook para exibir saídas de atividade. Um ícone dedicado para cada atividade indica o status dessa atividade. Quando você seleciona qualquer atividade, uma sobreposição é mostrada à direita que lista as saídas da atividade.

Como uma atividade pode ser executada mais de uma vez dentro de uma instância (devido ao loop), cada execução da Atividade tem um número de sequência exclusivo. A sobreposição permite que você escolha a Sequência # usando a lista suspensa na parte superior.

Observação

Para garantir o tempo de carregamento rápido, somente as primeiras 10 saídas de atividade são carregadas para a atividade. O botão Carregar mais mostra quantas vezes essa atividade foi executada e você pode selecioná-la para carregar mais saídas.

As status de Instância e Atividade seguem o mesmo formato que o Status do Trabalho.

Executar runbooks

Navegue até a tela Runbook do Runbook desejado e selecione Executar. Um formulário de sobreposição é aberto à direita em que você é solicitado a:

• Definir valores para todos os parâmetros de entrada (obrigatório)
• Escolha o conjunto de servidores Runbook nos quais este trabalho pode ser agendado.

Apenas um desses servidores realmente executará esse trabalho. Para executar um Runbook em muitos servidores, você precisará executar esses muitos trabalhos e definir explicitamente os servidores um por um.

Observação

Insira os parâmetros no formulário, caso contrário, o formulário não será considerado.

Quando o formulário é enviado, um pop-up que desaparece é mostrado no canto superior direito para notificar se o trabalho foi enfileirado com êxito ou não.

Parar de executar trabalhos

O botão Parar é mostrado no Painel e na tela Trabalho. Você encontrará um pop-up desaparecendo no canto superior direito da página para confirmar se um trabalho ainda está em execução ou se ele foi interrompido.

Perguntas frequentes

O Console não carrega; erro "Uh oh! Problemas ao se conectar ao WebApi [status 0]" é exibido

1. Verifique o console do desenvolvedor do navegador (guia Console), procure erros cors (bloqueados pela política cors).

   

2. Se não houver erros de CORS, marcar os logs de Visualizador de Eventos (Aplicativo) no computador da API Web.

Para corrigir erros de CORS, você deve garantir que o arquivo da web.config API deve ter uma configuração de CORS adequada. O erro do navegador mostra o valor de origem esperado na API Web web.config. Embora os nomes de domínio não diferenciam maiúsculas de minúsculas, o IIS CORS usa um teste de comparação que diferencia maiúsculas de minúsculas. Verifique se o origin valor está em letras minúsculas na configuração do CORS do IIS.

Dica

Uma configuração típica do IIS CORS da API Web:

<add allowCredentials="true" maxAge="7200" origin="http://{domain}[:{port}]">
  <allowMethods>
    <add method="GET"/>
    <add method="PUT"/>
    <add method="POST"/>
    <add method="PATCH"/>
    <add method="DELETE"/>
  </allowMethods>
  <allowHeaders allowAllRequestedHeaders="true"/>
</add>

Para obter detalhes sobre como configurar o CORS no web.config, consulte este artigo sobre a Configuração do Módulo CORS.

Como fazer atualizar a URL da API Web?

O Console carrega {install_dir}\assets\configuration.json para localizar a URL da API. Você pode editá-lo usando um editor de texto sem formatação. Verifique se não há nenhum /à direita no final da URL.

Próximas etapas

Para saber mais sobre como implantar runbooks, consulte Implantar runbooks.