Bagikan melalui

Tentang paparan parameter menggunakan ekstensi CLI Azure Operator Service Manager (AOSM)

  • Artikel

Dokumen ini menjelaskan bagaimana ekstensi Azure Operator Service Manager (AOSM) Azure CLI menerjemahkan nilai dan parameter helm dalam templat ARM ke dalam model konfigurasi yang diekspos ke operator.

Latar belakang

AOSM memungkinkan penerbit Versi Definisi Fungsi Jaringan (NFDV) untuk memilih parameter mana yang dapat dikonfigurasi saat menyebarkan Fungsi Jaringan (NF). AOSM juga memungkinkan perancang Versi Desain Layanan Jaringan (NSDV) untuk memilih parameter mana yang dapat dikonfigurasi saat menyebarkan Layanan Jaringan Situs (SNS).

Pilihan parameter mana yang diekspos dikodekan dalam satu atau beberapa skema. Penerbit mendefinisikan skema dalam properti NFDV ( deployParameters properti); perancang menentukan skema dalam sumber daya Azure terpisah - Skema Grup Konfigurasi (CGS). CGS dan NSDV harus meneruskan sekumpulan parameter dan nilai ke NFDV yang cocok dengan skema di NFDV.

Ekstensi Azure CLI AOSM berisi dukungan untuk pembuatan otomatis properti NFDV deployParameters , CGS, dan pemetaan yang memastikan semua parameter diteruskan dengan benar ke NF pada waktu penyebaran.

Konfigurasi file input

Perintah ekstensi az aosm nfd generate-config Azure CLI AOSM menghasilkan file input. File input bervariasi berdasarkan --definition-type parameter . Semua varian berisi parameter berikut:

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

Parameter ini mengontrol perilaku paparan parameter di ekstensi AOSM CLI.

Peringatan

Dengan mengekspos semua parameter, Anda juga mengekspos semua default Anda. Pastikan default Anda tidak berisi informasi sensitif apa pun.

Perilaku default

expose_all_parameters selalu diatur ke false secara default. The AOSM CLI:

  • mengurai nilai helm Containerized Network Function (CNF) atau parameter templat Azure Resource Manager (ARM) Virtualized Network Function (VNF)
  • deployParameters menghasilkan skema di NFDV yang berisi parameter yang diperlukan yang tidak memiliki nilai default

Misalnya, kutipan templat ARM VNF ini mendefinisikan dua parameter. Satu diperlukan dan satu bersifat opsional.

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

AOSM CLI membangun NFDV yang mengekspos required parameter dalam deployParameters properti . Parameter optional tidak diekspos. Pada waktu penyebaran, VNF menyebarkan dengan optional diatur ke nilai optionaldefault . Pengguna yang memicu penyebaran harus memberikan nilai untuk required.

Perilaku ini mirip untuk CNF. AOSM CLI memungkinkan pengguna untuk menyediakan values.yaml file yang mengambil alih file default values.yaml di bagan helm. File penimpaan values.yaml ini dapat berisi parameter dengan atau tanpa nilai. Kutipan values.yaml file pengambilalihan berikut menunjukkan parameter dengan nilai dan parameter tanpa nilai.

optional: "optional"
required:

AOSM CLI membangun NFDV yang mengekspos required parameter dalam deployParameters properti . Parameter optional tidak diekspos. Pada waktu penyebaran, CNF menyebarkan dengan optional diatur ke nilai optionaldefault . Pengguna yang memicu penyebaran harus memberikan nilai untuk required.

Penting

AOSM CLI memvalidasi bahwa file default values.yaml dalam bagan helm konsisten dengan bagan dengan menjalankan helm template. CLI menimbulkan kesalahan jika perintah ini helm template gagal.

Mengekspos semua parameter

Ekstensi Azure AOSM CLI mendukung pembuatan semua parameter dapat dikonfigurasi. Konfigurasi yang diperlukan dalam file input yang dihasilkan adalah 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,

Ekstensi CLI AOSM, jika expose_all_parameters diatur ke true:

  • mengurai nilai helm Containerized Network Function (CNF) atau parameter templat Azure Resource Manager (ARM) Virtualized Network Function (VNF)
  • deployParameters menghasilkan skema di NFDV yang berisi semua parameter yang diurai
  • default apa pun dalam templat ARM atau nilai yang dikonfigurasi dalam nilai helm dikonfigurasi sebagai default dalam skema NFDV deployParameters .

Konstruksi CGS

Dalam semua kasus, semua parameter yang diekspos oleh az aosm nfd build perintah ditambahkan ke CGS selama az aosm nsd build perintah. Ekstensi AOSM CLI juga menambahkan beberapa parameter tambahan ke CGS, tidak diurai dari templat ARM atau nilai helm, seperti customLocationId dan managedIdentityId. Parameter ini diperlukan untuk menyebarkan Layanan Jaringan Situs pada lingkungan target.

Langkah berikutnya