11. 自定义凭据类型¶

注意

创建新的凭据类型时，请勿对INPUT和INJECTOR名称和 ID 使用以ANSIBLE_开头的保留变量名，因为它们对自定义凭据类型无效。

3. 在输入配置字段中，指定一个输入模式，该模式定义了该类型的一组有序字段。格式可以是 YAML 或 JSON，如下所示

YAML

fields:
  - type: string
    id: username
    label: Username
  - type: string
    id: password
    label: Password
    secret: true
required:
  - username
  - password

在http://www.yaml.org/start.html查看更多 YAML 示例。

JSON

{
"fields": [
  {
  "type": "string",
  "id": "username",
  "label": "Username"
  },
  {
  "secret": true,
  "type": "string",
  "id": "password",
  "label": "Password"
   }
  ],
 "required": ["username", "password"]
}

在www.json.org查看更多 JSON 示例。

以下 JSON 格式的配置显示了每个字段及其使用方法

{
  "fields": [{
    "id": "api_token",               # required - a unique name used to
                                     # reference the field value

    "label": "API Token",            # required - a unique label for the
                                     # field

    "help_text": "User-facing short text describing the field.",

    "type": ("string" | "boolean")   # defaults to 'string'

    "choices": ["A", "B", "C"]       # (only applicable to `type=string`)

    "format": "ssh_private_key"      # optional, can be used to enforce data
                                     # format validity for SSH private key
                                     # data (only applicable to `type=string`)

    "secret": true,                  # if true, the field value will be encrypted

    "multiline": false               # if true, the field should be rendered
                                     # as multi-line for input entry
                                     # (only applicable to `type=string`)
},{
    # field 2...
},{
    # field 3...
}],

"required": ["api_token"]            # optional; one or more fields can be marked as required
},

当type=string时，字段可以选择指定多个选项

{
  "fields": [{
      "id": "api_token",          # required - a unique name used to reference the field value
      "label": "API Token",       # required - a unique label for the field
      "type": "string",
      "choices": ["A", "B", "C"]
  }]
},

4. 在注入器配置字段中，输入环境变量或指定凭据类型可以注入的值的额外变量。格式可以是 YAML 或 JSON（参见上一步中的示例）。以下 JSON 格式的配置显示了每个字段及其使用方法

{
  "file": {
      "template": "[mycloud]\ntoken={{ api_token }}"
  },
  "env": {
      "THIRD_PARTY_CLOUD_API_TOKEN": "{{ api_token }}"
  },
  "extra_vars": {
      "some_extra_var": "{{ username }}:{{ password }}"
  }
}

凭据类型还可以生成临时文件以支持 .ini 文件或证书/密钥数据

{
  "file": {
      "template": "[mycloud]\ntoken={{ api_token }}"
  },
  "env": {
      "MY_CLOUD_INI_FILE": "{{ tower.filename }}"
  }
}

在此示例中，Tower 将写入一个包含以下内容的临时文件：

[mycloud]\ntoken=SOME_TOKEN_VALUE

生成文件的绝对文件路径将存储在名为MY_CLOUD_INI_FILE的环境变量中。

在自定义凭据模板中引用多个文件的示例如下

输入

{
  "fields": [{
    "id": "cert",
    "label": "Certificate",
    "type": "string"
  },{
    "id": "key",
    "label": "Key",
    "type": "string"
  }]
}

注入器

  {
    "file": {
      "template.cert_file": "[mycert]\n{{ cert }}",
      "template.key_file": "[mykey]\n{{ key }}"
  },
  "env": {
      "MY_CERT_INI_FILE": "{{ tower.filename.cert_file }}",
      "MY_KEY_INI_FILE": "{{ tower.filename.key_file }}"
  }
}

5. 完成后，单击保存。

6. 向下滚动到屏幕底部，您新创建的凭据类型将出现在凭据类型列表中

单击 修改或 删除操作列下的凭据类型选项。

注意

如果要删除正在被凭据使用的凭据类型，则必须从使用该凭据类型的所有凭据中删除该凭据类型，然后才能删除它。以下是一个此类消息的示例

7. 验证在创建新凭据时，是否可以从凭据类型选择窗口中选择新创建的凭据类型

有关如何创建新凭据的详细信息，请参见凭据.