MAS DevOps Ansible Collection Ansible CLI
Home Ansible Automation Platform OCP Install Cloud Pak For Data Install Core Add AIBroker Add IoT Add Manage Add Monitor Add Optimizer Add Predict Add Visual Inspection Update Upgrade Uninstall Core Backup & Restore ocp_cluster_monitoring ocp_config ocp_deprovision ocp_efs ocp_github_oauth ocp_login ocp_node_config ocp_provision ocp_roks_upgrade_registry_storage ocp_upgrade ocp_verify appconnect aws_bucket_access_point aws_documentdb_user aws_policy aws_route53 aws_user_creation aws_vpc cert_manager cis common-services configure_manage_eventstreams cos cos_bucket cp4d_admin_pwd_update cp4d cp4d_service db2 dro eck grafana ibm_catalogs kafka nvidia_gpu mongodb ocs sls turbonomic uds mirror_case_prepare mirror_extras_prepare mirror_images mirror_ocp ocp_idms ocp_simulate_disconnected_network registry suite_app_config suite_app_install suite_app_uninstall suite_app_upgrade suite_app_rollback suite_app_backup_restore suite_certs suite_config suite_db2_setup_for_manage suite_dns suite_install suite_manage_attachments_config suite_manage_birt_report_config suite_manage_bim_config suite_manage_customer_files_config suite_manage_imagestitching_config suite_manage_import_certs_config suite_manage_load_dbc_scripts suite_manage_logging_config suite_manage_pvc_config suite_uninstall suite_upgrade suite_rollback suite_verify suite_backup_restore ansible_version_check entitlement_key_rotation gencfg_jdbc gencfg_watsonstudio gencfg_workspace gencfg_mongo
Home Roles: OCP Mgmt ocp_provision Role Variables Role Variables - GPU Node Support Role Variables - ROKS Role Variables - ROSA Role Variables - FYRE Role Variables - IPI Role Variables - AWS Role Variables - GCP Example Playbook License

ocp_provision¤

Provision OCP cluster on IBM Cloud ROKS, ROSA, or DevIT Fyre.

Fyre clusters will be automatically reconfigured to enable NFS storage. By default this is made available via the nfs-client storage class and supports both ReadWriteOnce and ReadWriteMany access modes. The image-registry-storage PVC used by the OpenShift image registry component will also be reconfigured to use this storage class.

Role Variables¤

cluster_type¤

Specify the cluster type, supported values are fyre, roks, rosa, and ipi.

cluster_name¤

Specify the name of the cluster

ocp_version¤

The version of OCP to use. A specific version can be set, minor and patch level versions can be used, e.g. 4.15, or 4.15.16. Additionally, two version aliases are available; default will auto-select the newest version of OCP currently supported by IBM Maximo Application Suite, rotate will auto-select a predetermined version of OCP currently supported by IBM Maximo Application Suite based on the day of the week. This latter option is primarily useful for testing purposes.

Note

When using the IBMCloud Red Hat OpenShift Service (ROKS) the version must be followed by _openshift, e.g. 4.15_openshift or 4.15.16_openshift

Role Variables - GPU Node Support¤

ocp_provision_gpu¤

Flag that determines if GPU worker nodes should be added during cluster creation (eg. needed for MVI application). This is currently only set up for ROKS clusters.

gpu_workerpool_name¤

The name of the gpu worker pool to added to or modify in the cluster. If already existing, use the existing name to avoid recreating another gpu worker pool unless that is the goal.

gpu_workers¤

The number of GPU worker nodes that will be deploy in the cluster. The node created will have mg4c.32x384.2xp100-GPU flavor. This variable depends on ocp_provision_gpu and is currently supported on ROKS clusters only.

compute_node_count¤

The number of compute nodes (i.e. worker nodes) allocate to the OCP cluster.

controlplane_node_count¤

The number of control plane nodes (i.e. master nodes) allocate to the OCP cluster.

gpu_workerpool_name¤

The name of the gpu worker pool to added to or modify in the cluster. If already existing, use the existing name to avoid recreating another gpu worker pool unless that is the goal.

Role Variables - ROKS¤

The following variables are only used when cluster_type = roks.

ibmcloud_apikey¤

The APIKey to be used by ibmcloud login comand.

ibmcloud_endpoint¤

Override the default IBMCloud API endpoint.

ibmcloud_resourcegroup¤

The resource group to create the cluster inside.

roks_zone¤

IBM Cloud zone where the cluster should be provisioned.

roks_flavor¤

Worker node flavor

roks_workers¤

Number of worker nodes for the roks cluster

roks_flags¤

Can be used to specify additional parameters for the cluster creation

Role Variables - ROSA¤

The following variables are only used when cluster_type = rosa.

rosa_token¤

Token to authenticate to the ROSA service. To obtain your API token login to the OpenShift cluster manager.

rosa_cluster_admin_password¤

Password to set up for the cluster-admin user account on the OCP instance. You will need this to log onto the cluster after it is provisioned. If this is not set then a password is auto-generated.

rosa_compute_nodes¤

Number of compute nodes to deploy in the cluster.

rosa_compute_machine_type¤

Worker nodes machine

rosa_config_dir¤

Config directory to hold the rosa-{{cluster_name}}-details.yaml file that contains the api endpoint and cluster-admin details

Role Variables - FYRE¤

The following variables are only used when cluster_type = fyre.

fyre_username¤

Username to authenticate with Fyre API.

fyre_apikey¤

API key to authenticate with Fyre API.

fyre_quota_type¤

Type of quota to draw from when provisioning the cluster, valid options are quick_burn and product_group.

fyre_product_id¤

The Product ID that the cluster will be associated with for accounting purposes.

fyre_site¤

Provide a site in Fyre where cluster will be provisioned

fyre_cluster_description¤

Provide a description for the cluster.

ocp_fips_enabled¤

Set to true to provision a FIPS enabled cluster.

fyre_cluster_size¤

The name of one of Fyre's pre-defined cluster sizes to use for the new cluster.

fyre_worker_count¤

The number of worker nodes to provision in the cluster.

fyre_worker_cpu¤

The amount of CPU to assign to each worker node (maximum value supported by FYRE 16).

fyre_worker_memory¤

The amount of memory to assign to each worker node (maximum value supported by FYRE 64).

fyre_worker_additional_disks¤

The size of additional disks in Gb added to each worker node, defined in a comma-seperated list, e.g. 400,400 will add two 400gb disks to each worker node. By default no additional disks will be attached.

fyre_nfs_setup¤

Enables the use of NFS storage classes in the Fyre cluster. When enabled, the existing image registry PVC will be deleted and recreated configured to use the newly available NFS storage class.

fyre_nfs_image_registry_size¤

Defines the image registry storage size when configured to use NFS. The size allocated cannot be superior of storage available in the Fyre Infrastructure node.

enable_ipv6¤

Enable IPv6. This is for Fyre at RTP site only.

Role Variables - IPI¤

These variables are only used when cluster_type = ipi.

Note

IPI stands for Installer Provisioned Infrastructure. OpenShift offers two possible deployment methods: IPI and UPI (User Provisioned Infrastructure). The difference is the degree of automation and customization. IPI will not only deploy OpenShift but also all infrastructure components and configurations.

ipi_platform¤

Platform to create the cluster on. Technically, any platform supported by openshift-install should work here, but currently we have only specifically tested on aws and gcp , where aws is the default value.

ipi_region¤

Platform region where OCP cluster will be created.

ipi_base_domain¤

Specify the base domain of the cluster that will be provisioned.

ipi_pull_secret_file¤

Location of the file containing your Redhat OpenShift pull secret. This file can be obtained from the Red Hat Hybrid Cloud Console

ipi_dir¤

The working directory that is used to perform the installation, it will contain the openshift-install executable, its configuration files, & any generated logs.

sshKey¤

Public SSH key value. It will be set in the OCP cluster nodes. Can be used to SSH into the OCP cluster nodes using a bastion.

ipi_controlplane_type¤

Control plane node type.

ipi_controlplane_replicas¤

The number of master nodes to provision to form the control plane of your cluster.

ipi_compute_type¤

Compute node type.

ipi_compute_replicas¤

The number of worker nodes to provsision in the cluster, providing your compute resource.

ipi_rootvolume_size¤

The size of root volume in GiB.

Role Variables - AWS¤

The following variables are only used when cluster_type = ipi and ipi_platform = aws.

aws_access_key_id¤

AWS access key associated with an IAM user or role. Make sure the access key has permissions to create instances.

aws_secret_access_key¤

AWS secret access key associated with an IAM user or role.

Role Variables - GCP¤

The following variables are only used when cluster_type = ipi and ipi_platform = gcp.

gcp_service_account_file¤

GCP service account file path. Make sure the service account has permissions to create instances.

ipi_gcp_projectid¤

GCP project id in which the cluster will be deployed.

Example Playbook¤

- hosts: localhost
  vars:
    cluster_type: roks
    cluster_name: mycluster
    ocp_version: 4.10

    ibmcloud_apikey: xxxxx
  roles:
    - ibm.mas_devops.ocp_provision

License¤

EPL-2.0