azure.azcollection.azure_rm_openshiftmanagedcluster – Manage Azure Red Hat OpenShift Managed Cluster instance

Note

This plugin is part of the azure.azcollection collection (version 1.5.0).

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_openshiftmanagedcluster.

New in version 1.2.0: of azure.azcollection

Synopsis

• Create, update and delete instance of Azure Red Hat OpenShift Managed Cluster instance.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• azure >= 2.0.0

Parameters

Parameter		Choices/Defaults	Comments
ad_user string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 0.0.1 of azure.azcollection			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 0.0.1 of azure.azcollection		Default: "latest"	Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.
api_server_profile dictionary			API server configuration.
	ip string		IP address of api server (immutable), only appears in response.
	url string		Url of api server (immutable), only appears in response.
	visibility string	Choices: Public ← Private	API server visibility.
append_tags boolean		Choices: no yes ←	Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_source string added in 0.0.1 of azure.azcollection		Choices: auto ← cli credential_file env msi	Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The msi was added in Ansible 2.6.
cert_validation_mode string added in 0.0.1 of azure.azcollection		Choices: ignore validate	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.
client_id string			Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 0.0.1 of azure.azcollection		Default: "AzureCloud"	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
cluster_profile dictionary		Default: {}	Configuration for OpenShift cluster.
	cluster_resource_group_id string		The ID of the cluster resource group (immutable).
	domain string		The domain for the cluster (immutable).
	pull_secret string	Default: ""	Pull secret for the cluster (immutable).
	version string		The Openshift version (immutable).
ingress_profiles list / elements=string			Ingress profiles configuration. only one profile is supported at the current API version.
	ip string		IP of the ingress (immutable), only appears in response.
	name string	Choices: default ←	Name of the ingress (immutable).
	visibility string	Choices: Public ← Private	Ingress visibility.
location string / required			Resource location.
master_profile dictionary			Configuration for OpenShift master VMs.
	subnet_id string / required		The Azure resource ID of the master subnet (immutable).
	vm_size string	Choices: Standard_D2s_v3 Standard_D4s_v3 Standard_D8s_v3	Size of agent VMs (immutable).
name string / required			Resource name.
network_profile dictionary		Default: {"pod_cidr": "10.128.0.0/14", "service_cidr": "172.30.0.0/16"}	Configuration for OpenShift networking (immutable).
	pod_cidr string		CIDR for the OpenShift Pods (immutable).
	service_cidr string		CIDR for OpenShift Services (immutable).
password string			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string			Security profile found in ~/.azure/credentials file.
provisioning_state string			The current deployment or provisioning state, which only appears in the response.
resource_group string / required			The name of the resource group.
secret string			Azure client secret. Use when authenticating with a Service Principal.
service_principal_profile dictionary			service principal.
	client_id string / required		Client ID of the service principal (immutable).
	client_secret string / required		Client secret of the service principal (immutable).
state string		Choices: absent present ←	Assert the state of the OpenShiftManagedCluster. Use present to create or update an OpenShiftManagedCluster and absent to delete it.
subscription_id string			Your Azure subscription Id.
tags dictionary			Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. Azure Front Door doesn't support the use of Azure Automation and Azure CDN only support 15 tags on resources.
tenant string			Azure tenant ID. Use when authenticating with a Service Principal.
worker_profiles list / elements=string			Configuration for OpenShift worker Vms.
	count integer		The number of worker VMs. Must be between 3 and 20 (immutable).
	disk_size integer		The disk size of the worker VMs in GB. Must be 128 or greater (immutable).
	name string / required	Choices: worker	name of the worker profile (immutable).
	subnet_id string / required		The Azure resource ID of the worker subnet (immutable).
	vm_size string	Choices: Standard_D2s_v3 Standard_D4s_v3 Standard_D8s_v3	The size of the worker Vms (immutable).

Notes

Note

• For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

• Authentication is also possible using a service principal or Active Directory user.

• To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

• To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

• Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- 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:
      - 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: Delete OpenShift Managed Cluster
  azure_rm_openshiftmanagedcluster:
    resource_group: myResourceGroup
    name: myCluster
    location: eastus
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
id string			always	Resource ID. Sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.RedHatOpenShift/openShiftClusters/mycluster
location string			always	Resource location. Sample: eatus
name string			always	Resource name. Sample: mycluster
properties complex			always	Properties of a OpenShift managed cluster.
	apiserverProfile complex		always	API server configuration.
		visibility string	always	api server visibility. Sample: Public
	clusterProfile complex		always	Configuration for Openshift cluster.
		domain string	always	Domain for the cluster. Sample: mycluster
		resourceGroupId string	always	The ID of the cluster resource group. Sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus-cluster
		version string	always	Openshift version. Sample: 4.4.17
	ingressProfiles list / elements=string		always	Ingress configruation. Sample: [{'name': 'default', 'visibility': 'Public'}]
	masterProfile complex		always	Configuration for OpenShift master VMs.
		subnetId string	always	The Azure resource ID of the master subnet (immutable). Sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker
		vmSize string	always	Size of agent VMs (immutable). Sample: Standard_D8s_v3
	networkProfile complex		always	Configuration for OpenShift networking.
		podCidr string	always	CIDR for the OpenShift Pods. Sample: 10.128.0.0/14
		serviceCidr string	always	CIDR for OpenShift Services. Sample: 172.30.0.0/16
	provisioningState string		always	The current deployment or provisioning state, which only appears in the response. Sample: Creating
	servicePrincipalProfile complex		always	Service principal.
		clientId string	always	Client ID of the service principal. Sample: xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
	workerProfiles complex		always	Configuration of OpenShift cluster VMs.
		count integer	always	Number of agents (VMs) to host docker containers. Sample: 3
		diskSizeGB integer	always	disk size in GB. Sample: 128
		name string	always	Unique name of the pool profile in the context of the subscription and resource group. Sample: worker
		subnetId string	always	Subnet ID for worker pool. Sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker
		vmSize string	always	Size of agent VMs. Sample: Standard_D4s_v3
type string			always	Resource type. Sample: Microsoft.RedHatOpenShift/openShiftClusters

Authors

• Haiyuan Zhang (@haiyuazhang)