Trabalhos

Trabalhos são usados para executar tarefas de execução remota, aplicar estados e iniciar executores Salt. O espaço Trabalhos é onde você pode criar, configurar e salvar configurações de trabalho para reutilização. Trabalhos são geralmente destinados a operações do sistema que precisam ser automatizadas e executadas várias vezes, poupando tempo de configuração.

Por exemplo, você pode ter um trabalho que cria e implanta uma máquina virtual e instala um conjunto base de aplicativos. Esse trabalho pode ser executado sempre que uma nova máquina virtual precisa ser implantada, para garantir que o mesmo conjunto de aplicativos e configurações sejam aplicados a cada implantação.

Consulte Fluxo de trabalho de trabalhos do SaltStack Config para obter uma visão geral de como usar o espaço Trabalhos junto com os outros espaços de trabalho no SaltStack Config para criar e usar trabalhos para gerenciamento de configuração.

É possível executar trabalhos no espaço Trabalhos, no espaço de trabalho Subordinados ou em outras telas na interface do usuário do SaltStack Config, dependendo da natureza do trabalho. Também é possível executar trabalhos em um agendamento regular ou executá-los somente conforme necessário. Normalmente, os trabalhos que são executados somente quando necessário são chamados de trabalhos assistemáticos.

Para obter mais informações sobre a execução de trabalhos, consulte:

• Executando um trabalho para obter informações sobre a execução de trabalhos no espaço Trabalhos
• Subordinados para obter informações sobre a execução de trabalhos no espaço de trabalho Subordinados
• Agendamentos para informações sobre a execução de trabalhos com base em um cronograma

Observação: Como parte da iniciativa da VMware de remover entradas de terminologia problemáticas, o termo mestre Salt será substituído por um termo melhor no SaltStack Config e em produtos e tópicos de documentação relacionados. Essa atualização de terminologia pode demorar alguns ciclos de lançamento antes de ser totalmente concluída.

Requisitos de trabalhos

Cada trabalho no espaço Trabalhos tem configurações predefinidas. Você pode editar configurações em trabalhos existentes ou criar um novo trabalho com as suas próprias configurações exclusivas.

Para que um trabalho seja executado, ele deve incluir:

• Uma função (a tarefa que o trabalho deve realizar)
• Um destino, um mestre Salt ou vários mestres Salt
• Permissões baseadas em funções

Você pode definir um destino nas configurações de um trabalho ou deixar o destino indefinido para selecioná-lo sempre que o trabalho for executado. Definir o destino de um trabalho também impede que o trabalho seja executado em nós nos quais isso não deve acontecer. Consulte Subordinados para obter mais informações.

O espaço Trabalhos permite que você defina o acesso baseado em função para cada trabalho. Além de definir o acesso à função no trabalho, você também deve atribuir permissão de funções para executar trabalhos correspondentes no editor de Funções. Consulte Funções e permissões para obter mais informações.

É possível criar novos trabalhos e editar os existentes no espaço Trabalhos. Depois que as configurações de trabalhos estiverem definidas, você poderá executar trabalhos assistemáticos ou criar agendamentos para executar trabalhos no futuro. Consulte Agendamentos para obter mais informações.

O SaltStack Config inclui um controle Executar Comando que permite executar um único comando sem definir um trabalho reutilizável. Isso é útil para executar comandos rapidamente ou para executar trabalhos únicos que não fazem parte do seu fluxo de trabalho diário, por exemplo, ao solucionar problemas ou durante a configuração inicial. Consulte Executando um comando para obter mais informações.

Você também pode definir quais funções podem visualizar, editar, executar e excluir trabalhos diferentes.

Acessando o espaço Trabalhos

Para usar o espaço Trabalhos, clique em Configuração > Trabalhos no menu lateral.

Criando um trabalho

Para criar um novo trabalho:

1. No espaço Trabalhos, clique em Criar trabalho.
2. Insira detalhes para o novo trabalho. Os detalhes a serem inseridos dependem do tipo de trabalho que você deseja criar. Consulte Configurações de trabalhos para obter mais informações.
3. Clique em Salvar. O trabalho agora está disponível para execução.

Executando um trabalho

Para executar um trabalho assistemático:

1. No espaço Trabalhos, clique no menu ao lado do trabalho que você deseja executar.
2. Clique em Executar Agora.
3. No pop-up, selecione um destino no qual executar o trabalho.
   Observação: Se o trabalho estiver configurado para incluir um destino ou mestre Salt, isso será exibido para confirmação.
4. Selecione opções adicionais conforme necessário.
   • Definir preferências de notificação
   • Selecione Executar como Teste (simulado) para executar o trabalho como um teste, conforme necessário.
5. Clique em Executar Agora.
   Observação: Você também pode executar trabalhos no espaço de trabalho Subordinados. Consulte Subordinados.

Procurando um trabalho

Para visualizar uma lista dos trabalhos disponíveis que foram criados até agora, acesse o espaço Trabalhos.

Por padrão, apenas 20 trabalhos são exibidos em uma página de cada vez. Para visualizar mais trabalhos, clique no menu Itens por página na parte inferior da tabela de trabalhos e selecione o número desejado de trabalhos que você deseja visualizar.

Para localizar um trabalho específico:

1. No espaço Trabalhos, clique no botão de filtro da coluna que você deseja pesquisar.
2. Comece a digitar os critérios de pesquisa para ver as linhas serem filtradas instantaneamente. Por exemplo, você pode procurar um trabalho por módulo Salt envolvido filtrando a coluna Função.
   Observação: Também pode clicar em qualquer nome de coluna uma vez para classificar as linhas em ordem decrescente. Clique novamente para reverter a ordem. Para obter mais informações sobre filtragem, consulte Filtrando e classificando colunas de tabelas.

Filtrando e classificando colunas de tabelas

Você pode filtrar cada coluna selecionando seu ícone de filtro e selecionando ou digitando seus critérios de filtro. Para limpar um filtro, clique no botão Limpar Filtros acima da tabela de trabalhos.

Você também pode classificar uma coluna selecionando o nome dela. Para personalizar quais colunas são exibidas na tabela, clique no botão Mostrar colunas no canto inferior esquerdo da tabela.

Observação: As configurações de filtros, a classificação de colunas e a visibilidade das coluna são persistentes para um determinado usuário, independentemente do dispositivo usado para fazer login. Isso significa que, quando um usuário específico faz login, ele verá as mesmas configurações de filtragem, classificação e visibilidade da próxima vez em que fizer login, até que os filtros sejam limpos ou as configurações de classificação e visibilidade sejam alteradas.

Visualizando retornos de trabalhos

Para visualizar retornos de trabalhos:

1. No menu lateral, clique em Atividade e, em seguida, Concluídos para ver uma lista de trabalhos concluídos.
2. Selecione um ID de trabalho na coluna JID para visualizar os detalhes do retorno do trabalho. Consulte Retornos de trabalho para obter mais informações.

Editando um trabalho

Para atualizar ou alterar um trabalho:

1. No espaço Trabalhos, selecione um trabalho.
2. Edite detalhes do trabalho conforme necessário e clique em Salvar quando terminar.

Definindo permissões de trabalhos

Como administrador, você pode restringir quais usuários podem executar trabalhos específicos. Para definir essas permissões:

1. No espaço Trabalhos, selecione um trabalho para abrir seus detalhes.
2. Na página de detalhes do trabalho, clique em Acesso de Funções.
3. Na caixa de diálogo, selecione o nível de acesso a ser ativado para diferentes funções e clique em Salvar.
4. Na página de detalhes do trabalho, clique em Salvar.
   Observação: Além de definir o acesso à função no trabalho, você também deve atribuir permissão de funções para executar trabalhos correspondentes no editor de Funções. Consulte Funções e permissões para obter mais informações.

Configurações de trabalhos

Defina configurações de trabalhos com base nas seguintes opções.

• Nome: insira um nome para o trabalho. Ele será exibido nos espaços de trabalho Trabalhos, Subordinados e Atividade, bem como no editor de Funções.
• Descrição: insira uma descrição para o trabalho (opcional). Essa descrição será exibida na sua lista de trabalhos no espaço Trabalhos.
• Comando: especifique o comando a ser executado, escolhendo entre:
  • salt: defina um trabalho a ser executado em um grupo de destino de subordinados.
  • salt-run: defina um trabalho a ser executado em um mestre Salt ou grupo de mestres Salt.
  Observação: O SaltStack Config inclui um controle Executar Comando que permite executar um único comando sem definir um trabalho reutilizável. Isso é útil para executar comandos rapidamente ou para executar trabalhos únicos que não fazem parte do seu fluxo de trabalho diário, por exemplo, ao solucionar problemas ou durante a configuração inicial. Para obter mais informações, consulte Executando um comando.
• Destinos: um destino é o grupo de subordinados, em um ou muitos mestres Salt, ao qual o comando Salt de um trabalho se aplica. Um mestre Salt também pode ser gerenciado como um subordinado, podendo ser um destino se estiver executando o serviço de subordinados. Quando salt estiver selecionado em Comandos, você poderá especificar opcionalmente o grupo de destino de subordinados no qual executar o trabalho. Se o campo ficar em branco, você será solicitado a selecionar um destino todas as vezes que o trabalho for executado.
• Todos os Mestres: o mestre Salt é um nó central usado para emitir comandos para subordinados. Quando salt-run estiver selecionado em Comandos, você poderá especificar com base em qual mestre Salt deve executar o trabalho. Por padrão, a opção Todos os Mestres está selecionada. Se você desativá-la, o menu Mestre será exibido.

  Trabalhos salt-run também são conhecidos como executores Salt. Executores Salt são módulos usados para executar funções de conveniência no mestre Salt. Para obter mais informações sobre como usar salt-run, consulte Configurações de trabalhos.

• Mestres Salt: quando salt-run está selecionado em Comandos e a opção Todos os Mestres está desativada, o menu Mestre é exibido. Clique nesse menu e selecione o mestre Salt específico com base no qual você deseja executar o trabalho. É possível selecionar vários mestres Salt, se necessário.
• Função: insira uma função para definir o que acontece quando o trabalho é executado. É possível definir um único trabalho de execução remota, um trabalho de arquivo de estado ou um trabalho de executor Salt. Para obter uma lista de funções Salt, consulte a Referência de módulos Salt.
  • Trabalhos de execução remota únicos: para definir um único trabalho de execução remota, inclua uma função e quaisquer argumentos necessários nas configurações do trabalho.
  • Trabalhos de arquivo de estado: um trabalho de arquivo de estado aplica estados a um destino e pode ser baseado em pelo menos um comando. Uma função de estado é uma função contida dentro de um módulo de estado que pode gerenciar a aplicação de um determinado estado a um sistema. Funções de estado frequentemente exigem um ou mais módulos de execução para realizar uma determinada tarefa. Um highstate aplica todos os estados definidos no arquivo “top”. Você pode exibir e adicionar arquivos de estado no Servidor de Arquivos. Consulte Servidor de Arquivos.

    Para aplicar um arquivo de estado a um trabalho, use a função state.apply. Para executar um highstate, use a função state.apply ou state.highstate nas configurações do trabalho.

    Quando você adiciona uma chamada de estado a um trabalho, são exibidos campos adicionais nos quais é possível selecionar os arquivos de estado que você deseja aplicar. Também é possível transmitir substituições de pilares opcionais no formato JSON.

    Observação: Os dados de pilares fornecidos na página do trabalho são enviados juntamente com o trabalho, e outros subordinados autenticados podem ser capazes de vê-los. Para maior proteção de dados, é melhor atribuir dados confidenciais no pilar padrão. Consulte Pilares.

    Para obter mais informações sobre Estados Salt, consulte a documentação do Salt: Como usar Estados Salt?.

  • Executores Salt: um trabalho salt-run aplica-se a um mestre Salt ou a um grupo de mestres Salt. Trabalhos salt-run também são conhecidos como executores Salt. Executores Salt são módulos usados para executar funções de conveniência no mestre Salt. Você pode usar executores Salt para executar orquestração, acionar subordinados remotamente, chamar webhooks e muito mais. Eles são úteis para executar trabalhos centralmente ou de um ponto de partida central. Por exemplo, você pode aplicar um highstate a todos os subordinados associados a um determinado mestre Salt.

    Para configurar um trabalho de executor de orquestração, use a função state.orchestrate. Quando você adiciona uma chamada de orquestração a um trabalho, são exibidos campos adicionais nos quais é possível listar os arquivos de orquestração que você deseja aplicar. Também é possível transmitir substituições de pilares opcionais no formato JSON.

    Observação: Os dados de pilares fornecidos na página do trabalho são enviados juntamente com o trabalho, e outros subordinados autenticados podem ser capazes de vê-los. Para maior proteção de dados, é melhor atribuir dados confidenciais no pilar padrão. Consulte Pilares.

    Para obter mais informações sobre executores Salt, consulte a Referência de executores Salt.

• Ambientes: selecione o ambiente em que o arquivo de estado ou orquestração está localizado. Este é um subdiretório do diretório raiz no Servidor de Arquivos. Consulte Servidor de Arquivos.
• Teste (simulado): execute um trabalho de teste e gere um retorno de trabalho simulado. Se você selecionar Teste, o trabalho não será executado, e nenhuma alteração será feita. Se essa opção for deixada desmarcada, você poderá optar por executar o trabalho como um teste mais tarde quando executar o trabalho. A opção Teste (simulado) está disponível apenas para determinadas funções. Para obter mais informações, entre em contato com o administrador.