Udostępnij za pośrednictwem

Informacje o ekspozycji parametrów przy użyciu rozszerzenia interfejsu wiersza polecenia programu Azure Operator Service Manager (AOSM)

  • Artykuł

W tym dokumencie wyjaśniono, jak rozszerzenie interfejsu wiersza polecenia platformy Azure (AOSM) usługi Azure Operator Service Manager (AOSM) tłumaczy wartości i parametry helm w szablonach usługi ARM na model konfiguracji uwidoczniony dla operatora.

Tło

Program AOSM umożliwia wydawcy wersji definicji funkcji sieciowej (NFDV) wybór parametrów, które można konfigurować podczas wdrażania funkcji sieciowej (NF). Usługa AOSM umożliwia również projektantowi wersji projektu usługi sieciowej (NSDV) wybór parametrów, które można konfigurować podczas wdrażania usługi sieciowej lokacji (SNS).

Wybór, które parametry są uwidocznione, jest zakodowany w co najmniej jednym schemacie. Wydawca definiuje schemat we właściwości NFDV ( deployParameters właściwość); projektant definiuje schemat w osobnym zasobie platformy Azure — schemat grupy konfiguracji (CGS). CGS i NSDV muszą przekazać zestaw parametrów i wartości do NFDV, które są zgodne ze schematem w systemie plików NFDV.

Rozszerzenie AOSM interfejsu wiersza polecenia platformy Azure zawiera obsługę automatycznego generowania właściwości NFDV deployParameters , usługi CGS i mapowań, które zapewniają prawidłowe przekazywanie wszystkich parametrów do systemu plików NF w czasie wdrażania.

Konfiguracja pliku wejściowego

Polecenie rozszerzenia az aosm nfd generate-config AOSM interfejsu wiersza polecenia platformy Azure generuje plik wejściowy. Plik wejściowy różni się w zależności od parametru --definition-type . Wszystkie warianty zawierają następujący 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,

Ten parametr steruje zachowaniem ekspozycji parametrów w rozszerzeniu interfejsu wiersza polecenia usługi AOSM.

Ostrzeżenie

Uwidaczniając wszystkie parametry, które również uwidaczniają wszystkie ustawienia domyślne. Upewnij się, że wartości domyślne nie zawierają żadnych poufnych informacji.

Zachowanie domyślne

expose_all_parameters jest zawsze ustawiana na false wartość domyślną. Interfejs wiersza polecenia AOSM:

  • Analizuje wartości narzędzia Helm funkcji sieci konteneryzowanej (CNF) lub parametry szablonu funkcji sieci wirtualnej (VNF) usługi Azure Resource Manager (ARM)
  • Generuje deployParameters schemat w systemie plików NFDV, który zawiera wszystkie wymagane parametry, które nie mają wartości domyślnej

Na przykład ten fragment szablonu arm systemu plików VNF definiuje dwa parametry. Jeden jest wymagany, a drugi jest opcjonalny.

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

Interfejs wiersza polecenia AOSM tworzy NFDV, który uwidacznia required parametr we deployParameters właściwości . Parametr optional nie jest uwidoczniony. W czasie wdrażania system plików VNF jest wdrażany z optional ustawioną wartością optionaldomyślną . Użytkownik wyzwalający wdrożenie musi podać wartość .required

Zachowanie jest podobne w przypadku CNN. Interfejs wiersza polecenia AOSM umożliwia użytkownikowi podanie values.yaml pliku, który zastępuje domyślny values.yaml plik na wykresie helm. Ten przesłonięć values.yaml plik może zawierać parametry z wartościami lub bez tych wartości. Poniższy fragment values.yaml przesłonięcia pliku przedstawia parametr z wartością i parametrem bez wartości.

optional: "optional"
required:

Interfejs wiersza polecenia AOSM tworzy NFDV, który uwidacznia required parametr we deployParameters właściwości . Parametr optional nie jest uwidoczniony. W czasie wdrażania system plików CNF jest wdrażany z optional ustawioną wartością optionaldomyślną . Użytkownik wyzwalający wdrożenie musi podać wartość .required

Ważne

Interfejs wiersza polecenia AOSM sprawdza, czy domyślny values.yaml plik na wykresie helm jest zgodny z wykresem, uruchamiając polecenie helm template. Interfejs wiersza polecenia zgłasza błąd, jeśli to helm template polecenie zakończy się niepowodzeniem.

Uwidocznij wszystkie parametry

Rozszerzenie interfejsu wiersza polecenia usługi Azure AOSM obsługuje konfigurowanie wszystkich parametrów. Wymagana konfiguracja w pliku wejściowym wygenerowany przez az aosm nfd generate-config program to:

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

Rozszerzenie interfejsu wiersza polecenia AOSM, jeśli expose_all_parameters jest ustawione na true:

  • Analizuje wartości narzędzia Helm funkcji sieci konteneryzowanej (CNF) lub parametry szablonu funkcji sieci wirtualnej (VNF) usługi Azure Resource Manager (ARM)
  • generuje deployParameters schemat w systemie plików NFDV, który zawiera wszystkie przeanalizowane parametry
  • wszystkie wartości domyślne w szablonie usługi ARM lub wartości skonfigurowane w wartościach programu Helm są konfigurowane jako wartości domyślne w schemacie NFDV deployParameters .

Konstrukcja CGS

We wszystkich przypadkach wszystkie parametry uwidocznione przez az aosm nfd build polecenie są dodawane do usługi konfiguracji konfiguracji podczas az aosm nsd build wykonywania polecenia. Rozszerzenie interfejsu wiersza polecenia AOSM dodaje również kilka dodatkowych parametrów do usługi CGS, a nie analizowanych z szablonu usługi ARM lub wartości helm, takich jak customLocationId i managedIdentityId. Te parametry są wymagane do wdrożenia usługi sieciowej lokacji w środowisku docelowym.

Następne kroki