azure.azcollection.azure_rm_akscredentials_info 模块 – 列出 Azure Kubernetes 服务凭据事实

注意

此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。

如果您正在使用 ansible 包，则您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_akscredentials_info。

azure.azcollection 2.3.0 中的新增功能

概要

  • 列出 Azure Kubernetes 服务凭据事实。

要求

执行此模块的主机需要以下要求。

  • python >= 2.7

  • 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

  • 集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 中模块的主机上

  • 完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数

注释

ad_user

字符串

活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。

adfs_authority_url

字符串

azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。

api_profile

字符串

azure.azcollection 0.0.1 中添加

选择在与 Azure 服务通信时使用的 API 配置文件。latest 的默认值适用于公共云；未来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

auth_source

字符串

azure.azcollection 0.0.1 中添加

控制用于身份验证的凭据来源。

也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。

设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。

设置为 env 时，凭据将从环境变量中读取。

设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。

设置为 cli 时，凭据将来自 Azure CLI 配置文件。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于识别订阅 ID（如果存在多个），否则使用默认的 az cli 订阅。

设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于识别订阅 ID（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。

msi 已在 Ansible 2.6 中添加。

选项

  • "auto" ← (默认值)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

字符串

azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选项

  • "ignore"

  • "validate"

client_id

字符串

Azure 客户端 ID。在使用服务主体或托管身份 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

字符串

azure.azcollection 0.0.1 中添加

对于美国公有云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现端点 URL（Azure Stack 必须）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

集群名称 (cluster_name)

字符串 / 必需

Azure Kubernetes 服务或所有 Azure Kubernetes 服务。

禁用实例发现 (disable_instance_discovery)

布尔值

azure.azcollection 2.3.0 版本中新增

确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能适用于无法访问元数据端点的情况，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保已配置的权限主机有效且值得信赖。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选项

  • false ← (默认)

  • true

日志模式 (log_mode)

字符串

父参数。

日志路径 (log_path)

字符串

父参数。

密码 (password)

字符串

Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。

配置文件 (profile)

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

资源组 (resource_group)

字符串 / 必需

搜索所需 Azure Kubernetes 服务的资源组。

密钥 (secret)

字符串

Azure 客户端密钥。在使用服务主体进行身份验证时使用。

显示管理员凭据 (show_admin_credentials)

布尔值

是否列出集群管理员凭据。

选项

  • false ← (默认)

  • true

显示监控凭据 (show_monitor_credentials)

布尔值

是否列出集群监控用户凭据。

选项

  • false ← (默认)

  • true

显示用户凭据 (show_user_credentials)

布尔值

是否列出集群用户凭据。

选项

  • false ← (默认)

  • true

订阅 ID (subscription_id)

字符串

您的 Azure 订阅 ID。

租户 (tenant)

字符串

Azure 租户 ID。在使用服务主体进行身份验证时使用。

指纹 (thumbprint)

字符串

azure.azcollection 1.14.0 版本中新增

在 *x509_certificate_path* 中指定的私钥的指纹。

在使用服务主体进行身份验证时使用。

如果定义了 *x509_certificate_path*，则为必需。

X509 证书路径 (x509_certificate_path)

路径

azure.azcollection 1.14.0 版本中新增

PEM 格式的服务主体使用的 X509 证书的路径。

证书必须附加到私钥。

在使用服务主体进行身份验证时使用。

备注

注意

  • 对于 Azure 的身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用 az login 登录。

  • 也可以使用服务主体或 Active Directory 用户进行身份验证。

  • 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

  • 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

  • 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个包含 [default] 部分和以下密钥的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Get managecluster admin credentials
  azure_rm_akscredentials_info:
    resource_group: "{{ resource_group }}"
    cluster_name: cluter_name
    show_admin_credentials: true

- name: Get managecluster user credentials
  azure_rm_akscredentials_info:
    resource_group: "{{ resource_group }}"
    cluster_name: cluster_name
    show_user_credentials: true

- name: Get managecluster monitor user credentials
  azure_rm_akscredentials_info:
    resource_group: "{{ resource_group }}"
    cluster_name: cluster_name
    show_monitor_credentials: true

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

集群凭据 (cluster_credentials)

复杂类型

列出托管集群的集群用户、管理员或监控用户的凭据

返回： 始终

集群名称 (cluster_name)

字符串

Azure Kubernetes 服务或所有 Azure Kubernetes 服务。

返回： 始终

示例： "testcluster01"

名称 (name)

字符串

凭据的名称。

返回： 始终

资源组 (resource_group)

字符串

搜索所需 Azure Kubernetes 服务的资源组。

返回： 始终

值 (value)

字符串

Base64 编码的 Kubernetes 配置文件。

返回： 始终

示例： "apiVersion: ************************"

作者

  • xuzhang3 (@xuzhang3)

  • Fred Sun (@Fred-sun)