Sobre a exposição de parâmetros usando a extensão da CLI do Azure Operator Service Manager (AOSM)

Artigo
06/21/2024

Este documento explica como a extensão da CLI do Azure Operator Service Manager (AOSM) do Azure traduz valores e parâmetros de leme em modelos ARM em um modelo de configuração exposto a um operador.

Fundo

O AOSM permite que o editor de uma Versão de Definição de Função de Rede (NFDV) escolha quais parâmetros são configuráveis ao implantar a Função de Rede (NF). O AOSM também permite que o designer de um NSDV (Network Service Design Version) escolha quais parâmetros são configuráveis ao implantar o SNS (Site Network Service).

A escolha de quais parâmetros são expostos é codificada em um ou mais esquemas. O editor define o esquema em uma propriedade do NFDV (a deployParameters propriedade), o designer define o esquema em um recurso separado do Azure - o Esquema do Grupo de Configuração (CGS). O CGS e o NSDV devem passar um conjunto de parâmetros e valores para o NFDV que correspondam ao esquema no NFDV.

A extensão AOSM da CLI do Azure contém suporte para geração automática da propriedade NFDV deployParameters , do CGS e dos mapeamentos que garantem que todos os parâmetros sejam passados corretamente para a NF no momento da implantação.

Configuração do arquivo de entrada

O comando Azure CLI AOSM extension az aosm nfd generate-config gera um arquivo de entrada. O arquivo de entrada varia com base no --definition-type parâmetro. Todas as variantes contêm o seguinte parâmetro:

  // If set to true, all NFD configuration parameters are made available to the designer, including optional parameters and those with defaults.
  // If not set or set to false, only required parameters without defaults will be exposed.
  "expose_all_parameters": false,

Este parâmetro controla o comportamento de exposição de parâmetros na extensão AOSM CLI.

Aviso

Ao expor todos os parâmetros, você também está expondo todos os seus padrões. Verifique se os padrões não contêm informações confidenciais.

Comportamento predefinido

expose_all_parameters é sempre definido como false por padrão. A CLI AOSM:

analisa os valores do leme CNF (Função de Rede Conteinerizada) ou os parâmetros de modelo do Azure Resource Manager (ARM) da Função de Rede Virtualizada (VNF)
gera um deployParameters esquema no NFDV que contém todos os parâmetros necessários que não têm um valor padrão

Por exemplo, este trecho de um modelo VNF ARM define dois parâmetros. Um é obrigatório e outro é opcional.

  "parameters": {
    "required": {
      "type": "string",
      "metadata": {
        "description": "A required parameter."
      }
    },
    "optional": {
      "type": "string",
      "defaultValue": "optional"
      "metadata": {
        "description": "An optional parameter."
      }
    },
  }

A CLI do AOSM cria um NFDV que expõe o required parâmetro na deployParameters propriedade. O optional parâmetro não é exposto. No momento da implantação, a VNF é implantada com optional o valor padrão definido de optional. O usuário que aciona a implantação deve fornecer um valor para required.

O comportamento é semelhante para CNFs. A CLI do AOSM permite que o usuário forneça um values.yaml arquivo que substitui o arquivo padrão values.yaml no gráfico de leme. Esse arquivo de substituição values.yaml pode conter parâmetros com ou sem valores. O trecho a seguir de um values.yaml arquivo de substituição mostra um parâmetro com um valor e um parâmetro sem um valor.

optional: "optional"
required:

A CLI do AOSM cria um NFDV que expõe o required parâmetro na deployParameters propriedade. O optional parâmetro não é exposto. No momento da implantação, o CNF é implantado com optional o valor padrão definido optionalde . O usuário que aciona a implantação deve fornecer um valor para required.

Importante

A CLI AOSM valida que o arquivo padrão values.yaml no gráfico de leme é consistente com o gráfico executando helm template. A CLI gera um erro se esse helm template comando falhar.

Expor todos os parâmetros

A Extensão da CLI do Azure AOSM dá suporte para tornar todos os parâmetros configuráveis. A configuração necessária no arquivo de entrada gerado por az aosm nfd generate-config é:

  // If set to true, all NFD configuration parameters are made available to the designer, including optional parameters and those with defaults.
  // If not set or set to false, only required parameters without defaults will be exposed.
  "expose_all_parameters": true,

A extensão da CLI do AOSM, se expose_all_parameters estiver definida como true:

analisa os valores do leme CNF (Função de Rede Conteinerizada) ou os parâmetros de modelo do Azure Resource Manager (ARM) da Função de Rede Virtualizada (VNF)
gera um deployParameters esquema no NFDV que contém todos os parâmetros analisados
quaisquer padrões no modelo ARM ou valores configurados nos valores helm são configurados como padrões no esquema NFDV deployParameters .

Construção CGS

Em todos os casos, todos os az aosm nfd build parâmetros expostos pelo comando são adicionados ao CGS durante o az aosm nsd build comando. A extensão AOSM CLI também adiciona alguns parâmetros extras ao CGS, não analisados a partir do modelo ARM ou valores de leme, como customLocationId e managedIdentityId. Esses parâmetros são necessários para implantar o Serviço de Rede de Site no ambiente de destino.

Partilhar via