O vystavení parametru pomocí rozšíření Rozhraní příkazového řádku Azure Operator Service Manageru (AOSM)

Článek
05/22/2024

Tento dokument vysvětluje, jak rozšíření Azure CLI (AOSM) Azure Operator Service Manager (AOSM) překládá hodnoty a parametry helmu v šablonách ARM na konfigurační model vystavený operátorovi.

Pozadí

AOSM umožňuje vydavateli verze definice síťové funkce (NFDV) zvolit, které parametry lze konfigurovat při nasazování síťové funkce (NF). AOSM také umožňuje návrháři verze návrhu síťové služby (NSDV) zvolit, které parametry je možné konfigurovat při nasazování služby SNS (Site Network Service).

Volba, které parametry jsou vystaveny, je kódována v jednom nebo více schématech. Vydavatel definuje schéma ve vlastnosti NFDV (vlastnost deployParameters ); návrhář definuje schéma v samostatném prostředku Azure – schématu skupiny konfigurace (CGS). CGS a NSDV musí předat sadu parametrů a hodnot NFDV, které odpovídají schématu v NFDV.

Rozšíření Azure CLI AOSM obsahuje podporu automatického generování vlastnosti NFDV deployParameters , CGS a mapování, které zajišťují správné předávání všech parametrů do NF v době nasazení.

Konfigurace vstupního souboru

Příkaz rozšíření az aosm nfd generate-config Azure CLI AOSM vygeneruje vstupní soubor. Vstupní soubor se liší podle parametru --definition-type . Všechny varianty obsahují následující parametr:

  // 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,

Tento parametr řídí chování vystavení parametru v rozšíření rozhraní příkazového řádku AOSM.

Upozorňující

Zveřejněním všech parametrů zobrazíte také všechny výchozí hodnoty. Ujistěte se, že výchozí hodnoty neobsahují žádné citlivé informace.

Výchozí chování

expose_all_parameters je ve výchozím nastavení vždy nastavená false . Rozhraní příkazového řádku AOSM:

parsuje hodnoty helmu containerizované síťové funkce (CNF) nebo parametry šablony Virtualized Network Function (VNF) Azure Resource Manageru (ARM).
vygeneruje deployParameters schéma v NFDV obsahující všechny požadované parametry, které nemají výchozí hodnotu.

Tento výňatek ze šablony ARM VNF například definuje dva parametry. Jedna je povinná a jedna je volitelná.

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

Rozhraní příkazového řádku AOSM vytvoří NFDV, který zveřejňuje required parametr ve deployParameters vlastnosti. Parametr optional není vystavený. V době nasazení se VNF nasadí s optional nastavenou výchozí hodnotou optional. Uživatel, který aktivuje nasazení, musí zadat hodnotu pro required.

Chování je podobné pro soubory CNF. Rozhraní příkazového řádku AOSM umožňuje uživateli zadat values.yaml soubor, který přepíše výchozí values.yaml soubor v chartu Helm. Tento soubor přepsání values.yaml může obsahovat parametry s hodnotami nebo bez nich. Následující výňatek přepsání values.yaml souboru ukazuje parametr s hodnotou a parametrem bez hodnoty.

optional: "optional"
required:

Rozhraní příkazového řádku AOSM vytvoří NFDV, který zveřejňuje required parametr ve deployParameters vlastnosti. Parametr optional není vystavený. V době nasazení se CNF nasadí s optional nastavenou výchozí hodnotou optional. Uživatel, který aktivuje nasazení, musí zadat hodnotu pro required.

Důležité

Rozhraní příkazového řádku AOSM ověří, že výchozí values.yaml soubor v chartu Helm je konzistentní s grafem spuštěním helm template. Pokud tento helm template příkaz selže, rozhraní příkazového řádku vyvolá chybu.

Zveřejnění všech parametrů

Rozšíření Azure AOSM CLI podporuje konfiguraci všech parametrů. Požadovaná konfigurace ve vstupním souboru vygenerovaném az aosm nfd generate-config pomocí:

  // 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,

Pokud je rozšíření expose_all_parameters rozhraní příkazového řádku AOSM nastavené na true:

parsuje hodnoty helmu containerizované síťové funkce (CNF) nebo parametry šablony Virtualized Network Function (VNF) Azure Resource Manageru (ARM).
vygeneruje deployParameters schéma v NFDV, které obsahuje všechny parsované parametry.
všechny výchozí hodnoty v šabloně ARM nebo hodnotách nakonfigurovaných v hodnotách helmu jsou nakonfigurované jako výchozí hodnoty ve schématu NFDV deployParameters .

Konstrukce CGS

Ve všech případech se do CGS během příkazu přidají všechny parametry vystavené příkazem az aosm nfd buildaz aosm nsd build . Rozšíření rozhraní příkazového řádku AOSM také přidá některé další parametry do CGS, nikoli parsované ze šablony ARM nebo hodnot helmu, například customLocationId a managedIdentityId. Tyto parametry jsou potřeba k nasazení síťové služby lokality v cílovém prostředí.

Sdílet prostřednictvím