azure.azcollection.azure_rm_openshiftmanagedcluster 模块 – 管理 Azure Red Hat OpenShift 托管集群实例

注意

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

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

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

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

azure.azcollection 1.2.0 中的新增功能

概要

• 创建、更新和删除 Azure Red Hat OpenShift 托管集群实例。

要求

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

• python >= 2.7

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

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

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

参数

参数	注释
ad_user 字符串	Active Directory 用户名。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
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"
api_server_profile 字典	API 服务器配置。
ip 字符串	api 服务器的 IP 地址（不可变），仅出现在响应中。
url 字符串	api 服务器的 URL（不可变），仅出现在响应中。
visibility 字符串	API 服务器可见性。 选项 "Public" ← (默认) "Private"
append_tags 布尔值	用于控制标签字段是规范的还是只追加到现有标签。 当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项 false true ← (默认)
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（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。 Ansible 2.6 中添加了 msi。 选项 "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_profile 字典	OpenShift 集群配置。 默认值： {}
cluster_resource_group_id 字符串	集群资源组的 ID（不可变）。
domain 字符串	集群的域名（不可变）。
fips_validated_modules 字符串	是否使用 FIPS 验证的加密模块 选项 "已禁用" "已启用" ← (默认)
pull_secret 字符串	集群的拉取密钥（不可变）。
version 字符串	OpenShift 版本（不可变）。
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索权限元数据以验证权限。通过将其设置为 **True**，将禁用权限的验证。因此，务必确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或环境变量 AZURE_DISABLE_INSTANCE_DISCOVERY 设置。 选项 false ← (默认) true
ingress_profiles 列表 / 元素=字典	入口配置文件配置。当前 API 版本仅支持一个配置文件。
ip 字符串	入口的 IP 地址（不可变），仅出现在响应中。
name 字符串	入口的名称（不可变）。 选项 "default" ← (默认)
visibility 字符串	入口可见性。 选项 "Public" ← (默认) "Private"
location 字符串 / 必需	资源位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
master_profile 字典	OpenShift 主节点 VM 配置。
disk_encryption_set_id 字符串	相关 DiskEncryptionSet 的资源 ID（如果适用）。
encryption_at_host 字符串	主虚拟机是否在主机上加密。 选项 "已禁用" ← (默认) "已启用"
subnet_id 字符串 / 必需	主子网的 Azure 资源 ID（不可变）。
vm_size 字符串	代理 VM 的大小（不可变）。
name 字符串 / 必需	资源名称。
network_profile 字典	OpenShift 网络配置（不可变）。 默认值： {"pod_cidr": "10.128.0.0/14", "service_cidr": "172.30.0.0/16"}
outbound_type 字符串	用于出站流量的 OutboundType。 选项 "Loadbalancer" "UserDefinedRouting"
pod_cidr 字符串	OpenShift Pod 的 CIDR（不可变）。
preconfigured_nsg 字符串	指定子网是否预先附加了 NSG 选项 "已禁用" ← (默认) "已启用"
service_cidr 字符串	OpenShift 服务的 CIDR（不可变）。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
provisioning_state 字符串	当前部署或配置状态，仅出现在响应中。
resource_group 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
service_principal_profile 字典	服务主体。
client_id 字符串 / 必需	服务主体的客户端 ID（不可变）。
client_secret 字符串 / 必需	服务主体的客户端密钥（不可变）。
state 字符串	声明 OpenShiftManagedCluster 的状态。 使用 present 创建或更新 OpenShiftManagedCluster，使用 absent 删除它。 选项 "absent" "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	字符串：字符串对的字典，作为元数据分配给对象。 对象上的元数据标签将使用任何提供的数值进行更新。 要移除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。
tenant 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	在 *x509_certificate_path* 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则需要。
worker_profiles 列表 / 元素=字典	OpenShift 工作节点 VM 配置。
count 整数	工作节点 VM 的数量。必须在 3 到 20 之间（不可变）。
disk_encryption_set_id 字符串	相关 DiskEncryptionSet 的资源 ID（如果适用）。
disk_size 整数	工作节点 VM 的磁盘大小（以 GB 为单位）。必须大于或等于 128（不可变）。
encryption_at_host 字符串	工作虚拟机是否在主机上加密。 选项 "已禁用" ← (默认) "已启用"
name 字符串 / 必需	工作程序配置文件的名称（不可变）。 选项 "worker"
subnet_id 字符串 / 必需	工作子网的 Azure 资源 ID（不可变）。
vm_size 字符串	工作节点 VM 的大小（不可变）。
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: Create openshift cluster
  azure_rm_openshiftmanagedcluster:
    resource_group: "myResourceGroup"
    name: "myCluster"
    location: "eastus"
    cluster_profile:
      cluster_resource_group_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/clusterResourceGroup"
      domain: "mydomain"
    service_principal_profile:
      client_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      client_secret: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    network_profile:
      pod_cidr: "10.128.0.0/14"
      service_cidr: "172.30.0.0/16"
    worker_profiles:
      - name: worker
        vm_size: "Standard_D4s_v3"
        subnet_id: "/subscriptions/xx-xx-xx-xx-xx/resourceGroups/myResourceGroup/Microsoft.Network/virtualNetworks/myVnet/subnets/worker"
        disk_size: 128
        count: 3
    master_profile:
      vm_size: "Standard_D8s_v3"
      subnet_id: "/subscriptions/xx-xx-xx-xx-xx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/master"
- name: Create openshift cluster with multi parameters
  azure_rm_openshiftmanagedcluster:
    resource_group: "myResourceGroup"
    name: "myCluster"
    location: "eastus"
    cluster_profile:
      cluster_resource_group_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/clusterResourceGroup"
      domain: "mydomain"
      fips_validated_modules: Enabled
    service_principal_profile:
      client_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      client_secret: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    network_profile:
      pod_cidr: "10.128.0.0/14"
      service_cidr: "172.30.0.0/16"
      outbound_type: Loadbalancer
      preconfigured_nsg: Disabled
    worker_profiles:
      - name: worker
        vm_size: "Standard_D4s_v3"
        subnet_id: "/subscriptions/xx-xx-xx-xx-xx/resourceGroups/myResourceGroup/Microsoft.Network/virtualNetworks/myVnet/subnets/worker"
        disk_size: 128
        count: 3
        encryption_at_host: Disabled
    master_profile:
      vm_size: "Standard_D8s_v3"
      subnet_id: "/subscriptions/xx-xx-xx-xx-xx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/master"
      encryption_at_host: Disabled
- name: Delete OpenShift Managed Cluster
  azure_rm_openshiftmanagedcluster:
    resource_group: myResourceGroup
    name: myCluster
    location: eastus
    state: absent

返回值

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

键	描述
id 字符串	资源 ID。 返回： 始终 示例： "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.RedHatOpenShift/openShiftClusters/mycluster"
location 字符串	资源位置。 返回： 始终 示例： "eatus"
name 字符串	资源名称。 返回： 始终 示例： "mycluster"
properties 复杂	OpenShift 托管集群的属性。 返回： 始终
apiserverProfile 复杂	API 服务器配置。 返回： 始终
visibility 字符串	API 服务器可见性。 返回： 始终 示例： "Public"
clusterProfile 复杂	Openshift 集群配置。 返回： 始终
domain 字符串	集群的域名。 返回： 始终 示例： "mycluster"
fipsValidatedModules 字符串	是否使用 FIPS 验证的加密模块 返回： 始终 示例： "Enabled"
resourceGroupId 字符串	集群资源组的 ID。 返回： 始终 示例： "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus-cluster"
version 字符串	Openshift 版本。 返回： 始终 示例： "4.4.17"
ingressProfiles 列表 / 元素=字符串	入口配置。 返回： 始终 示例： [{"name": "default", "visibility": "Public"}]
masterProfile 复杂	OpenShift 主节点 VM 配置。 返回： 始终
disk_encryption_set_id 字符串	相关 DiskEncryptionSet 的资源 ID（如果适用）。 返回： 成功
encryptionAtHost 字符串	主虚拟机是否在主机上加密。 返回： 始终 示例： "Disabled"
subnetId 字符串	主子网的 Azure 资源 ID（不可变）。 返回： 始终 示例： "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker"
vmSize 字符串	代理 VM 的大小（不可变）。 返回： 始终 示例： "Standard_D8s_v3"
networkProfile 复杂	OpenShift 网络配置。 返回： 始终
outboundType 字符串	用于出站流量的 OutboundType。 返回： 始终 示例： "Loadbalancer"
podCidr 字符串	OpenShift Pod 的 CIDR。 返回： 始终 示例： "10.128.0.0/14"
preconfiguredNSG 字符串	指定子网是否预先附加了 NSG 返回： 始终 示例： "Disabled"
serviceCidr 字符串	OpenShift 服务的 CIDR。 返回： 始终 示例： "172.30.0.0/16"
provisioningState 字符串	当前部署或配置状态，仅出现在响应中。 返回： 始终 示例： "Creating"
servicePrincipalProfile 复杂	服务主体。 返回： 始终
clientId 字符串	服务主体的客户端 ID。 返回： 始终 示例： "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx"
workerProfiles 复杂	OpenShift 集群虚拟机的配置。 返回： 始终
count 整数	承载 Docker 容器的代理（虚拟机）数量。 返回： 始终 示例： 3
diskSizeGB 整数	磁盘大小（GB）。 返回： 始终 示例： 128
encryptionAtHost 字符串	工作虚拟机是否在主机上加密。 返回： 始终 示例： "Disabled"
name 字符串	在订阅和资源组上下文中池配置文件的唯一名称。 返回： 始终 示例： "worker"
subnetId 字符串	工作程序池的子网 ID。 返回： 始终 示例： "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker"
vmSize 字符串	代理虚拟机的大小。 返回： 始终 示例： "Standard_D4s_v3"
type 字符串	资源类型。 返回： 始终 示例： "Microsoft.RedHatOpenShift/openShiftClusters"

作者

• 张海源 (@haiyuazhang)

资源链接

• 问题追踪器
• 主页
• 代码仓库