Сведения о экспозиции параметров с помощью расширения ИНТЕРФЕЙСА командной строки диспетчера операторов Azure (AOSM)

Мақала
05/22/2024

В этом документе объясняется, как расширение Azure Operator Service Manager (AOSM) Azure CLI преобразует значения и параметры helm в шаблоны ARM в модель конфигурации, доступную оператору.

Общие сведения

AOSM позволяет издателю версии определения сетевой функции (NFDV) выбрать параметры, которые можно настроить при развертывании сетевой функции (NF). AOSM также позволяет конструктору версии конструктора сетевой службы (NSDV) выбрать параметры, которые можно настроить при развертывании сетевой службы сайта (SNS).

Выбор доступных параметров закодирован в одной или нескольких схемах. Издатель определяет схему в свойстве NFDV ( deployParameters свойство); конструктор определяет схему в отдельном ресурсе Azure — схему группы конфигурации (CGS). CGS и NSDV должны передавать набор параметров и значений NFDV, которые соответствуют схеме в NFDV.

Расширение AOSM Azure CLI содержит поддержку автоматического создания свойства NFDV deployParameters , CGS и сопоставлений, которые обеспечивают правильное передаче всех параметров NF во время развертывания.

Конфигурация входного файла

Команда расширения az aosm nfd generate-config AOSM Azure CLI создает входной файл. Входной файл зависит от --definition-type параметра. Все варианты содержат следующий параметр:

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

Этот параметр управляет поведением воздействия параметров в расширении интерфейса командной строки AOSM.

Предупреждение

Предоставляя все параметры, которые вы также представляете все значения по умолчанию. Убедитесь, что значения по умолчанию не содержат конфиденциальную информацию.

Поведение по умолчанию

expose_all_parameters значение по умолчанию всегда задано false . Интерфейс командной строки AOSM:

анализирует значения helm в контейнерной сетевой функции (CNF) или параметры шаблона виртуализированной сетевой функции (VNF) Azure Resource Manager (ARM)
создает схему deployParameters в NFDV, которая содержит все необходимые параметры, которые не имеют значения по умолчанию.

Например, этот фрагмент шаблона ARM VNF определяет два параметра. Один является обязательным, и один является необязательным.

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

Интерфейс командной строки AOSM создает NFDV, предоставляющий required параметр в свойстве deployParameters . Параметр optional не предоставляется. Во время развертывания VNF развертывается с optional заданным значением optionalпо умолчанию. Для пользователя, активировающего развертывание, необходимо указать значение required.

Поведение аналогично для CNFs. Интерфейс командной строки AOSM позволяет пользователю предоставить values.yaml файл, переопределяющий файл по умолчанию values.yaml на диаграмме helm. Этот файл переопределения values.yaml может содержать параметры с или без значений. В следующем фрагменте values.yaml файла переопределения отображается параметр со значением и параметром без значения.

optional: "optional"
required:

Интерфейс командной строки AOSM создает NFDV, предоставляющий required параметр в свойстве deployParameters . Параметр optional не предоставляется. Во время развертывания CNF развертывается с optional заданным значением optionalпо умолчанию. Для пользователя, активировающего развертывание, необходимо указать значение required.

Внимание

Интерфейс командной строки AOSM проверяет, соответствует ли файл по умолчанию values.yaml в диаграмме helm, выполнив команду helm template. Интерфейс командной строки вызывает ошибку, если эта helm template команда завершается ошибкой.

Предоставление всех параметров

Расширение ИНТЕРФЕЙСА командной строки Azure AOSM поддерживает настройку всех параметров. Необходимая конфигурация в входном файле, созданном следующим 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,

Расширение интерфейса командной строки AOSM, если expose_all_parameters задано значение true:

анализирует значения helm в контейнерной сетевой функции (CNF) или параметры шаблона виртуализированной сетевой функции (VNF) Azure Resource Manager (ARM)
создает схему deployParameters в NFDV, которая содержит все проанализированные параметры.
все значения по умолчанию в шаблоне ARM или значениях, настроенных в значениях helm, настраиваются в качестве значений по умолчанию в схеме NFDV deployParameters .

Строительство CGS

Во всех случаях все параметры, предоставляемые az aosm nfd build командой, добавляются в CGS во время az aosm nsd build команды. Расширение ИНТЕРФЕЙСА командной строки AOSM также добавляет некоторые дополнительные параметры в CGS, а не анализируется из шаблона ARM или значений helm, таких как customLocationId и managedIdentityId. Эти параметры необходимы для развертывания службы сети сайта в целевой среде.

Бөлісу құралы: