Compartilhar via

Integrar uma CNF (Função de rede em contêineres) ao AOSM (Gerenciador de Serviço do Operador do Azure)

  • Artigo

Neste guia de instruções, os Editores de funções de rede e Designers de serviço aprendem a usar a extensão do AOSM da CLI do Azure para integrar uma função de rede em contêineres ao AOSM. A CNF pode ser implantada posteriormente em um cluster Kubernetes conectado ao Azure Arc, incluindo um cluster Nexus do Operador do Azure.

A integração é um processo de várias etapas. Depois de cumprir os pré-requisitos, você usará a extensão do AOSM da CLI do Azure para:

  1. Gerar arquivos BICEP que definem um grupo e uma versão de NFD (Definição de função de rede) com base em seus gráficos do Helm e values.yaml.
  2. Publicar a NFD e carregar as imagens e gráficos da CNF em um Repositório de artefatos [ACR (Registro de Contêiner do Azure) gerenciado pelo AOSM].
  3. Adicionar a NFD publicada nos arquivos BICEP que definem um grupo e uma versão do NSD (Design do serviço de rede).
  4. Publicar o NSD.

Pré-requisitos

Observação

É altamente recomendável que você tenha testado que uma helm install do seu pacote do Helm tenha êxito em seu ambiente Kubernetes conectado ao Arc de destino.

Configurar permissões

  • Você precisa da função de Colaborador da sua assinatura para criar um Grupo de recursos ou de um Grupo de recursos existente no qual já tenha a função de Colaborador.
  • Você precisa das atribuições de função Reader/AcrPull no ACR de origem que contém suas imagens.
  • Você precisa das atribuições de função Contributor e AcrPush na assinatura que conterá o Repositório de Artefatos gerenciado pelo AOSM. Essas permissões permitem que a Extensão AOSM da CLI do Azure faça uma cópia direta de ACR para ACR. A cópia direta é o método mais rápido de transferir imagens de um ACR para outro.
    • A política da sua empresa talvez impeça que você tenha permissões no escopo da assinatura. O parâmetro --no-subscription-permissions, disponível nos comandos az aosm nfd publish e az aosm nsd publish, usa permissões com escopo rígido derivadas do serviço do AOSM para orquestrar uma cópia em duas etapas de e para o seu computador local. Essa cópia em duas etapas é mais lenta, mas não requer permissões no escopo da assinatura.

Pacotes do Helm

  • Os pacotes do Helm que você pretende integrar devem estar presentes no armazenamento local do computador a partir do qual você está executando a CLI.
    • A extensão do AOSM da CLI do Azure usará o arquivo values.yaml no pacote do helm por padrão. A CLI dá suporte à substituição desse comportamento com um values.yaml alternativo. Esse arquivo alternativo deve existir no armazenamento local do computador a partir do qual você está executando a CLI.

Observação

É altamente recomendável que o pacote do Helm contenha um esquema para os valores do helm e que o pacote do helm gere modelos conforme o esperado quando helm template for executado usando os values.yaml que você pretende usar ao integrar ao AOSM.

Imagens de contêiner

  • Suas imagens de contêiner estão presentes em um ACR existente ou em um registro de contêiner alternativo que dá suporte à API do Docker. As imagens de contêiner devem ser armazenadas no seu registro de origem em uma estrutura que corresponda ao local da imagem definido nos seus gráficos do helm. Esse requisito é explicado na descoberta e upload de imagens da CNF da CLI.
  • Use o comando docker login para entrar em um registro de contêiner não Azure que hospeda suas imagens de contêiner antes de executar qualquer comando az aosm. Essa etapa não será necessária se você estiver usando um ACR: a extensão do AOSM da CLI do Azure entrará automaticamente.

Mecanismo Helm e Docker

  • Instale a CLI do Helm no computador host. É necessário usar o Helm v3.8.0 ou posterior.
  • Instale o Docker no computador host.

Baixar e instalar a CLI do Azure

Para instalar a CLI do Azure localmente, consulte Como instalar a CLI do Azure.

Para entrar na CLI do Azure, use o comando az login e preencha os prompts exibidos no seu terminal para concluir a autenticação. Para ver mais opções de entrada, confira Entrar na CLI do Azure.

Observação

Para execuções no Windows ou no macOS, considere executar a CLI do Azure em um contêiner do Docker. Para obter mais informações, confira Como executar a CLI do Azure em um contêiner do Docker. Você também pode usar o ambiente Bash no Azure Cloud Shell. Para obter mais informações, consulte Iniciar o Cloud Shell para usar o ambiente Bash no Azure Cloud Shell.

Instalar a extensão AOSM da CLI

A Extensão AOSM da CLI do Az requer a versão 2.54.0 ou posterior da CLI do Azure.

  1. Execute az version para ver a versão e as bibliotecas dependentes que estão instaladas.
  2. Execute az upgrade para atualizar para a versão mais recente da CLI do Azure.

Instale a extensão AOSM da CLI usando este comando:

az extension add --name aosm

Criar o grupo e versão da Definição de função de rede

Esta etapa cria uma pasta no diretório de trabalho chamada cnf-cli-output com os modelos BICEP dos recursos do AOSM que definem o grupo e a versão da Definição de função de rede e o Repositório de artefatos. Esses recursos serão incluídos no seu Design do serviço de rede.

  1. Gere o arquivo de entrada de extensão do AOSM da CLI do Azure para uma CNF.

    az aosm nfd generate-config --definition-type cnf --output-file <filename.jsonc>

  2. Abra o arquivo de entrada gerado na etapa anterior e use os comentários embutidos para inserir os valores necessários. Esse exemplo mostra o arquivo de entrada da extensão do AOSM da CLI do Az para uma CNF da Contoso fictícia.

    Observação

    Por padrão, a extensão do AOSM da CLI do Azure expõe apenas os parâmetros necessários sem valores padrão na entrada values.yaml. Você pode definir expose_all_parameters como true para expor todos os valores do helm na NFDV (Versão de definição de função de rede) e no CGS (Esquema de grupo de configuração). Para obter mais informações, consulte Exposição de parâmetros usando a extensão da CLI do AOSM.

    {
  // Azure location to use when creating resources e.g uksouth
  "location": "eastus",
  // Name of the Publisher resource you want your definition published to.
  // Will be created if it does not exist.
  "publisher_name": "contoso",
  // Resource group for the Publisher resource.
  // You should create this before running the publish command
  "publisher_resource_group_name": "contoso",
  // Name of the ACR Artifact Store resource.
  // Will be created if it does not exist.
  "acr_artifact_store_name": "contoso-artifact-store",
  // Name of NF definition.
  "nf_name": "contoso-cnf-nfd",
  // Version of the NF definition in 1.1.1 format (three integers separated by dots).
  "version": "1.0.0",
  // 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,
  // List of registries from which to pull the image(s).
  // For example ["sourceacr.azurecr.io/test", "myacr2.azurecr.io", "ghcr.io/path"].
  // For non Azure Container Registries, ensure you have run a docker login command before running build.
  "image_sources": ["contoso.azuercr.io/contoso", "docker.io"],
  // List of Helm packages to be included in the CNF.
  "helm_packages": [
      {
          // The name of the Helm package.
          "name": "contoso-helm-package",
          // The file path to the helm chart on the local disk, relative to the directory from which the command is run.
          // Accepts .tgz, .tar or .tar.gz, or an unpacked directory. Use Linux slash (/) file separator even if running on Windows.
          "path_to_chart": "/home/cnf-onboard/contoso-cnf-helm-chart-0-1-0.tgz",
          // The file path (absolute or relative to this configuration file) of YAML values file on the local disk which will be used instead of the values.yaml file present in the helm chart.
          // Accepts .yaml or .yml. Use Linux slash (/) file separator even if running on Windows.
          "default_values": "",
      }
  ]
}

  3. Execute o comando a seguir para criar os modelos BICEP do grupo e da versão da Definição de função de rede.

az aosm nfd build --definition-type cnf --config-file <filename.jsonc>

Você pode analisar a estrutura de pastas e arquivos e fazer modificações se necessário.

Publicar o grupo a versão de Definição de função de rede

Essa etapa cria os recursos do AOSM que definem a Definição de função de rede e o Repositório de artefatos que serão usados para armazenar as imagens de contêiner da Função de rede. Ela também carrega as imagens e os gráficos para o Repositório de artefatos copiando-os diretamente do ACR de origem ou, se você não tiver as funções Contributor e AcrPush do escopo de assinatura, marcando novamente as imagens do Docker localmente e carregando para o Repositório de artefatos usando credenciais com escopo rígido geradas do serviço do AOSM.

  1. Execute o comando a seguir para publicar o grupo e a versão de Definição de função de rede. Se você não tiver as funções Contributor e AcrPush no escopo da assinatura, inclua --no-subscription-permissions no comando.

Observação

Se você estiver usando o Windows, deverá ter o Docker Desktop em execução durante a etapa de publicação.

az aosm nfd publish --build-output-folder cnf-cli-output --definition-type cnf

Criar a o grupo e a versão de Design do serviço de rede

Esta seção cria uma pasta no diretório de trabalho chamado nsd-cli-output. Essa pasta contém os modelos BICEP dos recursos do AOSM que definem um grupo e uma versão do Design do serviço de rede. Esse Design do serviço de rede é um modelo usado no recurso Serviço de rede do site que implantará a Função de rede que você integrou nas seções anteriores.

  1. Gere o arquivo de entrada do NSD da Extensão do AOSM da CLI do Azure.

    az aosm nsd generate-config --output-file <nsd-output-filename.jsonc>

  2. Abra o arquivo de entrada gerado na etapa anterior e use os comentários embutidos para inserir os valores necessários. O arquivo de entrada gerado contém um resource_element_typeadicional do tipo ArmTemplate. Isso não é necessário ao integrar uma CNF; você pode excluí-lo. O resultado deve ser semelhante a este exemplo. O exemplo mostra o arquivo de entrada da extensão AOSM da CLI do Az para um NSD da Contoso fictícia, que pode ser usada para implantar uma CNF fictícia da Contoso em um cluster do Kubernetes do Nexus conectado ao Arc.

    {
    // Azure location to use when creating resources e.g uksouth
    "location": "eastus",
    // Name of the Publisher resource you want your definition published to.
    // Will be created if it does not exist.
    "publisher_name": "contoso",
    // Resource group for the Publisher resource.
    // Will be created if it does not exist.
    "publisher_resource_group_name": "contoso",
    // Name of the ACR Artifact Store resource.
    // Will be created if it does not exist.
    "acr_artifact_store_name": "contoso-artifact-store",
    // Network Service Design (NSD) name. This is the collection of Network Service Design Versions. Will be created if it does not exist.
    "nsd_name": "contoso-nsd",
    // Version of the NSD to be created. This should be in the format A.B.C
    "nsd_version": "1.0.0",
    // Optional. Description of the Network Service Design Version (NSDV).
    "nsdv_description": "An NSD that deploys the onboarded contoso-cnf NFD",
    // List of Resource Element Templates (RETs).
    // There must be at least one NF RET.
    // ArmTemplate RETs are optional. Delete if not required.
    "resource_element_templates": [
        {
            // Type of Resource Element. Either NF or ArmTemplate
            "resource_element_type": "NF",
            "properties": {
                // The name of the existing publisher for the NSD.
                "publisher": "contoso",
                // The resource group that the publisher is hosted in.
                "publisher_resource_group": "contoso",
                // The name of the existing Network Function Definition Group to deploy using this NSD.
                // This will be the same as the NF name if you published your NFDV using the CLI.
                "name": "contoso-cnf-nfd",
                // The version of the existing Network Function Definition to base this NSD on.
                // This NSD will be able to deploy any NFDV with deployment parameters compatible with this version.
                "version": "1.0.0",
                // The region that the NFDV is published to.
                "publisher_offering_location": "eastus",
                // Type of Network Function. Valid values are 'cnf' or 'vnf'.
                "type": "cnf"
            }
        }
    ]
}

    Observação

    A seção de modelo do elemento do recurso define qual NFD está incluído no NSD. As propriedades devem corresponder às usadas no arquivo de entrada repassado para o comando az aosm nfd build. Isso ocorre porque a Extensão do AOSM da CLI do Azure valida se o NFD foi integrado corretamente ao compilar o NSD.

  3. Execute o comando a seguir para criar os modelos BICEP do grupo e da versão do Design do serviço de rede.

az aosm nsd build --config-file <nsd-output-filename.jsonc>

Você pode analisar a estrutura de pastas e arquivos e fazer modificações se necessário.

Publicar o grupo e a versão de Design do serviço de rede

Essa etapa cria os recursos do AOSM que definem o grupo e a versão de Design do serviço de rede. Também carrega artefatos exigidos pelo NSD para o Repositório de artefatos (modelo do ARM da Função de rede).

  1. Execute o comando a seguir para publicar o grupo e a versão de Design do serviço de rede. Se você não tiver as funções Contributor e AcrPush no escopo da assinatura, inclua --no-subscription-permissions no comando.
az aosm nsd publish --build-output-folder nsd-cli-output

Agora você tem um conjunto completo de recursos de distribuidor do AOSM e está pronto para executar o fluxo do operador.

Próximas etapas