應用 Basic 認證組

目錄結構

|-- basic_auth_groups/
  |-- groups.yaml

每個 yaml 檔案包含一個或者多個應用基本認證組的配置。

配置說明

每個基本認證組配置是一個包含以下引數的物件:

引數名資料型別是否必選描述
namestring認證組的名稱,也是該組的唯一標識
labelstring認證組的標籤,用於描述該組
usersarray該組中的使用者列表

users 配置

引數名資料型別是否必選描述
usernamestring使用者名稱
passwordstring使用者密碼

配置示例

---
- name: hello
  label: 'world.'
  users:
  - username: 'username1'
    password: 'password1'
  - username: 'username2'
    password: 'password2'
  - username: 'username3'
    password: 'password3'

此配置定義了一個名為 “hello” 的基本認證組,包含三個使用者。

使用示例

更新配置到 OpenResty Edge 中:

edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l basic_auth_groups -i /root/oredge-configs -d test.com

從 OpenResty Edge 中匯出配置:

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -E -l basic_auth_groups -d test.com

清理 OpenResty Edge 中的配置:

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -c -l basic_auth_groups -d test.com

示例中均使用 -l basic_auth_groups 來指定只操作應用基本認證組相關的配置。

注意事項

  1. 每個基本認證組必須有一個唯一的名稱。

  2. 使用者名稱和密碼不能為空或空字串。

  3. 標籤欄位是可選的,但可以用來為基本認證組新增描述資訊。

  4. 在匯入配置時,工具會先檢查配置的有效性,然後再執行新增或更新操作。

  5. 如果配置中刪除了某個使用者,工具會自動從認證組中移除該使用者。

  6. 如果配置中刪除了某個認證組,工具會自動從應用中移除該認證組。

  7. 在匯出配置時,預設不會匯出使用者資訊。如果需要匯出使用者資訊,需要設定 export_users 引數為 True

  8. 出於安全考慮,匯出的配置中不會包含實際的密碼資訊。

相關文件