Validação e correção de dados de configuração

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 5 min. de leitura

    • Para cada mudança em um ambiente, pode haver dezenas ou centenas de regras (políticas) que precisam ser verificadas. CDM permite que você valide automaticamente os dados de configuração para garantir que as mudanças de configuração estejam sem erros e em conformidade com a política antes que os dados de configuração sejam consumidos.

    Importante:
    A partir da versão Washington DC, o Configuração de DevOps está sendo preparado para descontinuação futura. Ele ficará oculto e não será mais instalado em novas instâncias, mas continuará sendo compatível. Para obter detalhes, consulte o artigo Deprecation Process (Processo de descontinuação) [KB0867184] na Base de conhecimento do Now Support.

    CDM automatiza grande parte do processo de validação

    Quando as equipes implantam uma aplicação, elas normalmente precisam garantir que nenhum erro seja introduzido no nível de código e configuração e que as políticas de conformidade sejam respeitadas. Para cada mudança em um ambiente, pode haver dezenas ou centenas de regras (políticas) que precisam ser verificadas. Um processo de validação manual está sujeito a erros.

    DevOps fornece aos desenvolvedores, administradores de TI, Configuração de DevOps engenheiros ou líderes de equipe uma maneira de garantir que as mudanças de configuração sejam livres de erros e estejam em conformidade com as políticas. Além disso, o após a validação fornece aos desenvolvedores ou administradores de TI informações contextuais suficientes para identificar e corrigir problemas. Isso significa que depois que um usuário confirma quaisquer mudanças nos dados de configuração, todas as políticas relevantes são aplicadas, os resultados são avaliados e as ações apropriadas são acionadas (por exemplo, implantar ou não implantar).

    Aqui está o processo CDM que valida automaticamente os dados de configuração antes que eles sejam consumidos.

    1. Você cria uma versão de política com base em uma política existente e, em seguida, ativa e publica a nova versão.
    2. Para mapeamento dinâmico de políticas para implantáveis, crie uma condição na tabela Implantável do CDM [sn_cdm_deployable]. Associe a condição a uma ou mais políticas. No tempo de execução, essas políticas são executadas para validar implantáveis que atendem às condições definidas.
    3. Você mapeia a política para um implantável usando mapeamento estático ou mapeamento dinâmico para garantir que a política seja executada em qualquer snapshot do implantável quando solicitado (solicitação manual ou automatizada).

      Para obter mais informações sobre mapeamentos de políticas, consulte PaCE Static and Dynamic Mapping.

    4. Quando você confirma um changeset para o implantável, o sistema deve validar o snapshot resultante. Para acionar automaticamente a execução das políticas mapeadas sempre que um conjunto de mudanças for confirmado, selecione a opção Validar ao confirmar o conjunto de mudanças. Você também tem a opção de validar o snapshot manualmente.

      Em ambos os casos, as políticas mapeadas usando mapeamento estático e mapeamento dinâmico são executadas.

      • Se você configurou o processo automatizado para ser integrado ao pipeline, as políticas retornarão os resultados do processo de validação para o pipeline em arquivos JSON. O pipeline decide se continua com base na decisão de validação: Em conformidade, Não conforme.
      • Se o processo não estiver integrado ao pipeline ou se a validação tiver falhado ou não tiver sido concluída, revise a decisão de validação e tome as medidas apropriadas.

    Use políticas predefinidas como modelos para suas políticas personalizadas

    CDM inclui políticas que você pode usar como modelos para políticas personalizadas que atendem a necessidades específicas. Observe os seguintes padrões importantes nas políticas predefinidas;
    • Todas as políticas usam a inclusão de script CdmQuery para recuperar dados de configuração.
    • Use CdmQuery with Secrets para garantir que todos os dados sejam incluídos.
    • A inclusão de script CdmPolicyUtil adiciona avisos e falhas.
    • Quando todas as políticas tiverem sido executadas e uma falha tiver sido preenchida na saída, a decisão será non_ Compliance.
    • Use o agente de log para depuração. Remova os logs quando a política estiver pronta para ser publicada.
    • Use parâmetros de entrada de mapeamento para fornecer valores de entrada dinâmica.

    Diretrizes para validar snapshots

    • Não valide manualmente snapshots que já foram validados e publicados.
    • Se você selecionar a opção Validar snapshots ou Validar e publicar snapshots ao confirmar um changeset, o sistema validará automaticamente cada snapshot quando ele for gerado pela primeira vez.
    • Para exibir as falhas ou avisos de validação atuais de um snapshot, abra o snapshot e selecione a guia Resultados de validação. Para obter detalhes, consulte Exibir os resultados da validação de snapshot.
    • Use o recurso Playground de teste de política para revalidar snapshots enquanto desenvolve uma política. Os resultados de validação resultantes são sinalizados como resultados de testes e não afetam as operações.
    • Se houver um requisito para revalidar todos os snapshots de um implantável, revalide somente depois de testar e publicar as políticas.

    Práticas a serem evitadas

    • Não use GlideRecord para recuperar registros de dados de configuração.
    • Para exibir decisões de política na IU, CDM requer dados de aviso e falha em uma estrutura específica. Use CdmPolicyUtil para adicionar avisos ou falhas (não inserções manuais). (Pelo menos entenda a estrutura que CdmPolicyUtil insere em falhas e avisos.)
    • Nas políticas, não tente recuperar dados que não sejam provenientes de CDM dados. Esta prática pode resultar em problemas de acesso entre escopos.
    • Não grave políticas "sempre em conformidade" ou "sempre fora de conformidade".
    • Não codifique nomes ou valores nas políticas. Em vez disso, use parâmetros de entrada de mapeamento para fornecer valores de entrada dinâmica.

    Status do snapshot

    • Não validado: este é o estado do snapshot inicial em que nenhuma política foi executada no snapshot.
    • Solicitado: o fluxo de validação foi iniciado.
    • Em andamento: o fluxo de validação está em execução e as políticas estão em execução no momento.
    • Aprovado: o snapshot foi aprovado em todas as políticas.
    • Falha: o snapshot falhou em uma ou mais políticas.
    • Erro de execução: falha na execução de uma política devido a um erro inesperado, principalmente quando a inclusão de script CdmPolicyUtil não é usada para fornecer mensagens de aviso e falha..

    Fluxo de exemplo

    Um usuário confirma mudanças nos dados de configuração antes de uma implantação.

    Os dados são validados em relação a todas as políticas atribuídas.

    Se a validação falhar, a implantação será interrompida. Uma lista de erros que aponta para sua localização nos dados de configuração é fornecida ao usuário. As ações disponíveis devem ser determinadas no contexto da própria aplicação e do ambiente em que a aplicação está implantada. Por exemplo:
    • Permita a implantação em um ambiente de TESTE, independentemente do número de erros ou avisos.
    • Interrompa a implantação em PROD se houver erro.
    • Interrompa a implantação no PROD se houver algum aviso e se a aplicação for crítica.
    • Permita a implantação no PROD, independentemente do número de avisos, se não forem críticos.

    O usuário corrige erros e confirma novamente a mudança.

    Os dados foram validados novamente e os resultados estão OK.

    Um snapshot é obtido.

    A implantação foi executada.