Try SpotterManage Azure Red Hat OpenShift Managed Cluster instance
| "added in version" 1.2.0 of azure.azcollection"
Authors: Haiyuan Zhang (@haiyuazhang)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete instance of Azure Red Hat OpenShift Managed Cluster instance.
- 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
name:
description:
- Resource name.
required: true
type: str
tags:
description:
- 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.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the OpenShiftManagedCluster.
- Use C(present) to create or update an OpenShiftManagedCluster and C(absent) to delete
it.
type: str
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
location:
description:
- Resource location.
required: true
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- 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.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
master_profile:
description:
- Configuration for OpenShift master VMs.
suboptions:
subnet_id:
description:
- The Azure resource ID of the master subnet (immutable).
required: true
type: str
vm_size:
choices:
- Standard_D8s_v3
- Standard_D16s_v3
- Standard_D32s_v3
description:
- Size of agent VMs (immutable).
type: str
type: dict
resource_group:
description:
- The name of the resource group.
required: true
type: str
cluster_profile:
default: {}
description:
- Configuration for OpenShift cluster.
suboptions:
cluster_resource_group_id:
description:
- The ID of the cluster resource group (immutable).
type: str
domain:
description:
- The domain for the cluster (immutable).
type: str
pull_secret:
description:
- Pull secret for the cluster (immutable).
type: str
version:
description:
- The Openshift version (immutable).
type: str
type: dict
network_profile:
default:
pod_cidr: 10.128.0.0/14
service_cidr: 172.30.0.0/16
description:
- Configuration for OpenShift networking (immutable).
suboptions:
pod_cidr:
description:
- CIDR for the OpenShift Pods (immutable).
type: str
service_cidr:
description:
- CIDR for OpenShift Services (immutable).
type: str
type: dict
subscription_id:
description:
- Your Azure subscription Id.
type: str
worker_profiles:
description:
- Configuration for OpenShift worker Vms.
elements: dict
suboptions:
count:
description:
- The number of worker VMs. Must be between 3 and 20 (immutable).
type: int
disk_size:
description:
- The disk size of the worker VMs in GB. Must be 128 or greater (immutable).
type: int
name:
choices:
- worker
description: name of the worker profile (immutable).
required: true
type: str
subnet_id:
description:
- The Azure resource ID of the worker subnet (immutable).
required: true
type: str
vm_size:
choices:
- Standard_D4s_v3
- Standard_D8s_v3
description:
- The size of the worker Vms (immutable).
type: str
type: list
ingress_profiles:
description:
- Ingress profiles configuration. only one profile is supported at the current API
version.
elements: dict
suboptions:
ip:
description:
- IP of the ingress (immutable), only appears in response.
type: str
name:
choices:
- default
default: default
description:
- Name of the ingress (immutable).
type: str
visibility:
choices:
- Public
- Private
default: Public
description:
- Ingress visibility.
type: str
type: list
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
api_server_profile:
description:
- API server configuration.
suboptions:
ip:
description:
- IP address of api server (immutable), only appears in response.
type: str
url:
description:
- Url of api server (immutable), only appears in response.
type: str
visibility:
choices:
- Public
- Private
default: Public
description:
- API server visibility.
type: str
type: dict
provisioning_state:
description:
- The current deployment or provisioning state, which only appears in the response.
type: str
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
x509_certificate_path:
description:
- Path to the X509 certificate used to create the service principal in PEM format.
- The certificate must be appended to the private key.
- Use when authenticating with a Service Principal.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
service_principal_profile:
description:
- service principal.
suboptions:
client_id:
description:
- Client ID of the service principal (immutable).
required: true
type: str
client_secret:
description:
- Client secret of the service principal (immutable).
required: true
type: str
type: dict
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.RedHatOpenShift/openShiftClusters/mycluster
type: str
location:
description:
- Resource location.
returned: always
sample: eatus
type: str
name:
description:
- Resource name.
returned: always
sample: mycluster
type: str
properties:
contains:
apiserverProfile:
contains:
visibility:
description:
- api server visibility.
returned: always
sample: Public
type: str
description:
- API server configuration.
returned: always
type: complex
clusterProfile:
contains:
domain:
description:
- Domain for the cluster.
returned: always
sample: mycluster
type: str
resourceGroupId:
description:
- The ID of the cluster resource group.
returned: always
sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus-cluster
type: str
version:
description:
- Openshift version.
returned: always
sample: 4.4.17
type: str
description:
- Configuration for Openshift cluster.
returned: always
type: complex
ingressProfiles:
description:
- Ingress configruation.
returned: always
sample:
- name: default
visibility: Public
type: list
masterProfile:
contains:
subnetId:
description:
- The Azure resource ID of the master subnet (immutable).
returned: always
sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/
virtualNetworks/mycluster-vnet/subnets/mycluster-worker
type: str
vmSize:
description:
- Size of agent VMs (immutable).
returned: always
sample: Standard_D8s_v3
type: str
description:
- Configuration for OpenShift master VMs.
returned: always
type: complex
networkProfile:
contains:
podCidr:
description:
- CIDR for the OpenShift Pods.
returned: always
sample: 10.128.0.0/14
type: str
serviceCidr:
description:
- CIDR for OpenShift Services.
returned: always
sample: 172.30.0.0/16
type: str
description:
- Configuration for OpenShift networking.
returned: always
type: complex
provisioningState:
description:
- The current deployment or provisioning state, which only appears in the response.
returned: always
sample: Creating
type: str
servicePrincipalProfile:
contains:
clientId:
description: Client ID of the service principal.
returned: always
sample: xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
type: str
description:
- Service principal.
returned: always
type: complex
workerProfiles:
contains:
count:
description:
- Number of agents (VMs) to host docker containers.
returned: always
sample: 3
type: int
diskSizeGB:
description:
- disk size in GB.
returned: always
sample: 128
type: int
name:
description:
- Unique name of the pool profile in the context of the subscription and
resource group.
returned: always
sample: worker
type: str
subnetId:
description:
- Subnet ID for worker pool.
returned: always
sample: /subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/
virtualNetworks/mycluster-vnet/subnets/mycluster-worker
type: str
vmSize:
description:
- Size of agent VMs.
returned: always
sample: Standard_D4s_v3
type: str
description:
- Configuration of OpenShift cluster VMs.
returned: always
type: complex
description:
- Properties of a OpenShift managed cluster.
returned: always
sample: null
type: complex
type:
description:
- Resource type.
returned: always
sample: Microsoft.RedHatOpenShift/openShiftClusters
type: str