docs.intersystems.com
InterSystems IRIS Data Platform 2019.2  /  InterSystems Cloud Manager Guide  /  ICM Reference  /  ICM Configuration Parameters

InterSystems: The power behind what matters   
Search:  


Provider-Specific Parameters
This tables in this section list parameters used by ICM that are specific to each provider, as follows:
Note:
Some of the parameters listed are used with more than one provider.
Selecting Machine Images
Cloud providers operate data centers in various regions of the world, so one of the important things to customize for your deployment is the region in which your cluster will be deployed. Another choice is which virtual machine images to use for the computes nodes in your cluster. Although the sample configuration files define valid regions and machine images for all cloud providers, you will generally want to change the region to match your own location. Because machine images are often specific to a region, both must be selected.
At this release, ICM supports provisioning of and deployment on compute nodes running Red Hat Enterprise Linux, version 7.2 or later, so the machine images you select must run this operating system.
Amazon Web Services (AWS) Parameters
Parameter Meaning
Credentials Path to a file containing Amazon AWS credentials in the following format. Download from https://console.aws.amazon.com/iam/home?#/users.
[default]
aws_access_key_id = access_key_id
aws_secret_access_key = secret_access_key
aws_session_token = session_token
aws_security_token = security_token
SSHUser Nonroot account with sudo access used by ICM for access to provisioned nodes (see Security-Related Parameters). Root of SSHUser’s home directory can be specified using the Home field. Required value is determined by the selected AMI; for Red Hat Enterprise Linux images, the required value of SSHUser is usually ec2-user.
AMI AMI to use for a node or nodes to be provisioned; see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html. Example: ami-a540a5e1.
Region Region to use for a node or nodes to be provisioned; see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html. Example: us-west-1.
Zone Availability zone to use for a node or nodes to be provisioned; see link in previous entry. Example: us-west-1c. For information on using this field with multiple zones, see Deploying Across Multiple Zones.
ElasticIP Enables the Elastic IP feature to preserve IP address and domain name across compute node restart; for more information, see AWS Elastic IP Feature. Default: False.
InstanceType Instance Type to use for a node or nodes to be provisioned; see https://aws.amazon.com/ec2/instance-types/. Example: m4.large.
VPCId
Existing Virtual Private Cloud (VPC) to be used in the deployment, instead of allocating a new one; the specified VPC is not deallocated during unprovision. If not specified, a new VPC is allocated for the deployment and deallocated during unprovision.
Internal parameter net_subnet_cidr must be provided if the VPC is not created in the default address space 10.0.0.0/16; for example, for a VPC in the range 172.17.0.0/16, you would need to specify net_subnet_cidr as 172.17.%d.0/24.
OSVolumeType Determines maximum OSVolumeSize. See http://docs.aws.amazon.com/cli/latest/reference/ec2/create-volume.html. Default: standard.
OSVolumeIOPS
IOPS count for OSVolume. Must be nonzero for volumes of type iops. Default: 0.
DockerVolumeType
Determines maximum DockerVolumeSize (see OSVolumeType). Default: standard.
DockerVolumeIOPS
IOPS count for DockerVolume. Must be nonzero for volumes of type iops. Default: 0.
DataVolumeType Determines maximum DataVolumeSize (see OSVolumeType). Default: standard.
DataVolumeIOPS
IOPS count for DataVolume. Must be nonzero for volumes of type iops. Default: 0.
WIJVolumeType Determines maximum WIJVolumeSize (see OSVolumeType). Default: standard.
WIJVolumeIOPS
IOPS count for WIJVolume. Must be nonzero for volumes of type iops. Default: 0.
Journal1VolumeType Determines maximum Journal1VolumeSize (see OSVolumeType). Default: standard.
Journal1VolumeIOPS
IOPS count for Journal1Volume. Must be nonzero for volumes of type iops. Default: 0.
Journal2VolumeType Determines maximum Journal2VolumeSize (see OSVolumeType). Default: standard.
Journal2VolumeIOPS
IOPS count for Journal2Volume. Must be nonzero for volumes of type iops. Default: 0.
Google Cloud Platform (GCP) Parameters
Parameter Meaning
Credentials JSON file containing account credentials. Download from https://console.developers.google.com/
Project Google project ID.
MachineType Machine type resource to use for a node or nodes to be provisioned. See https://cloud.google.com/compute/docs/machine-types. Example: n1-standard-1.
Region Region to use for a node or nodes to be provisioned; see https://cloud.google.com/compute/docs/regions-zones/regions-zones. Example: us-east1.
Zone Zone in which to locate a node or nodes to be provisioned. Example: us-east1-b. For information on using this field with multiple zones, see Deploying Across Multiple Zones.
Image The source image from which to create this disk. See https://cloud.google.com/compute/docs/images. Example: centos-cloud/centos-7-v20160803.
OSVolumeType Determines disk type for the OS volume. See https://cloud.google.com/compute/docs/reference/beta/instances/attachDisk. Default: pd-standard.
DockerVolumeType
Determines disk type for the Docker block storage device (see OSVolumeType). Default: pd-standard.
DataVolumeType Determines disk type for the persistent Data volume (see OSVolumeType). Default: pd-standard.
WIJVolumeType Determines disk type for the persistent WIJ volume (see OSVolumeType). Default: pd-standard.
Journal1VolumeType Determines disk type for the persistent Journal1 volume (see OSVolumeType). Default: pd-standard.
Journal2VolumeType Determines disk type for the persistent Journal1 volume (see OSVolumeType). Default: pd-standard.
Microsoft Azure (Azure) Parameters
Parameter Meaning
Size The size of a node or nodes to be provisioned; see https://docs.microsoft.com/en-us/azure/virtual-machines/virtual-machines-windows-sizes. Example: Standard_DS1.
Location Location in which to provision a node or nodes; see https://azure.microsoft.com/en-us/regions/. Example: Central US.
Zone Zone in which to locate a node or nodes to be provisioned. Possible values are 1, 2, and 3.
SubscriptionId Credentials which uniquely identify the Microsoft Azure subscription.
ClientId Azure application identifier.
ClientSecret Provides access to an Azure application.
TenantId Azure Active Directory tenant identifier.
PublisherName Entity providing a given Azure image. Example: OpenLogic.
Offer Operating system of a given Azure image. Example: Centos.
Sku Major version of the operating system of a given Azure image. Example: 7.2.
Version Build version of a given Azure image. Example: 7.2.20170105.
AccountTier
Account tier, either HDD (Standard) or SSD (Premium).
AccountReplicationType
Account storage type: locally-redundant storage (LRS), geo-redundant storage (GRS), zone-redundant storage (ZRS), or read access geo-redundant storage (RAGRS).
ResourceGroupName
Existing Resource Group to be used in the deployment, instead of allocating a new one; the specified group is not deallocated during unprovision. If not specified, a new Resource Group is allocated for the deployment and deallocated during unprovision.
VirtualNetworkName
Existing Virtual Network to be used in the deployment, instead of allocating a new one; the specified network is not deallocated during unprovision. If not specified, a new Virtual Network is allocated for the deployment and deallocated during unprovision.
Internal parameter net_subnet_cidr must be provided if the network is not created in the default address space 10.0.%d.0/24.
SubnetId
Existing Subnet to be used in the deployment, instead of allocating a new one; the specified subnet is not deallocated during unprovision. If not specified, a new Subnet is allocated for the deployment and deallocated during unprovision. Value is an Azure URI of the form:
/subscriptions/subscription/resourceGroups/resource_group/providers /Microsoft.Network/virtualNetworks/virtual_network/subnets/subnet_name
UseMSI
When True, authenticates using a Managed Service Identity in place of ClientId and ClientSecret. Requires that ICM be run from a machine in Azure.
Default: false
CustomImage
Image to be used to create the OS disk, in place of the marketplace image described by the PublisherName, Offer, Sku, and Version fields. Value is an Azure URI of the form:
/subscriptions/subscription/resourceGroups/resource_group/providers /Microsoft.Compute/images/image_name
VMware vSphere (vSphere) Parameters
Parameter Meaning
Server Name of the vCenter server. Example: tbdvcenter.iscinternal.com.
Datacenter Name of the datacenter.
VsphereUser Username for vSphere operations.
VspherePassword Password for vSphere operations.
VCPU Number of CPUs in a node or nodes to be provisioned. Example: 2.
Memory Amount of memory (in MB) in a node or nodes to be provisioned. Example: 4096.
DatastoreCluster
Collection of datastores where virtual machine files will be stored. Example: DatastoreCluster1.
DNSServers List of DNS servers for the virtual network. Example: 172.16.96.1,172.17.15.53
DNSSuffixes List of name resolution suffixes for the virtual network adapter. Example: iscinternal.com
Domain FQDN for a node to be provisioned. Example: iscinternal.com
NetworkInterface Label to assign to a network interface. Example: VM Network
Template Virtual machine master copy. Example: centos-7
GuestID
Guest ID for the operating system type. See Enum - VirtualMachineGuestOsIdentifier on the VMware support website. Default: centos64Guest.
WaitForGuestNetTimeout
Time (in minutes) to wait for an available IP address on a virtual machine. Default: 5.
ShutdownWaitTimeout
Time (in minutes) to wait for graceful guest shutdown when making necessary updates to a virtual machine. Default: 3.
MigrateWaitTimeout
Time (in minutes) to wait for virtual machine migration to complete. Default: 10.
CloneTimeout
Time (in minutes) to wait for virtual machine cloning to complete. Default: 30.
CustomizeTimeout
Time (in minutes) that Terraform waits for customization to complete. Default: 10.
DiskPolicy
Disk provisioning policy for the deployment (see About Virtual Disk Provisioning Policies in the VMware documentation). Values are:
  • thin — Thin Provision
  • lazy — Thick Provision Lazy Zeroed
  • eagerZeroedThick — Thick Provision Eager Zeroed
Default: lazy.
ResourcePool
Name of a vSphere resource pool. Example: ResourcePool1.
SDRSEnabled
If specified, determines whether Storage DRS is enabled for a virtual machine; otherwise, use current datastore cluster settings. Default: Current datastore cluster settings.
SDRSAutomationLevel
If specified, determines Storage DRS automation level for a virtual machine; otherwise, use current datastore cluster settings. V;ues are automated or manual. Default: Current datastore cluster settings.
SDRSIntraVMAffinity
If provided, determines Intra-VM affinity setting for a virtual machine; otherwise, use current datastore cluster settings. Values include:
  • True — All disks for this virtual machine will be kept on the same datastore.
  • False — Storage DRS may locate individual disks on different datastores if it helps satisfy cluster requirements.
Default: Current datastore cluster settings.
SCSIControllerCount
Number of SCSI controllers for a given compute instance; must be between 1 and 4. The OS volume is always be placed on the first SCSI controller. vSphere may not be able to create more SCSI controllers than were present in the template specified by the Template field.
Default: 1
DockerVolumeSCSIController
SCSI controller on which to place the Docker volume. Must be between 1 and 4 and may not exceed SCSIControllerCount.
Default: 1
DataVolumeSCSIController
SCSI controller on which to place the Data volume. Must be between 1 and 4 and may not exceed SCSIControllerCount.
Default: 1
WIJVolumeSCSIController
SCSI controller on which to place the WIJ volume. Must be between 1 and 4 and may not exceed SCSIControllerCount.
Default: 1
Journal1VolumeSCSIController
SCSI controller on which to place the Journal1 volume. Must be between 1 and 4 and may not exceed SCSIControllerCount.
Default: 1
Journal2VolumeSCSIController
SCSI controller on which to place the Journal2 volume. Must be between 1 and 4 and may not exceed SCSIControllerCount.
Default: 1
Note:
The requirements for the VMware vSphere template are similar to those described in Compute Node Requirements for preexisting clusters (for example, passwordless sudo access).
To address the needs of the many users who rely on VMware vSphere, it is supported by this release of ICM. Depending on your particular vSphere configuration and underlying hardware platform, the use of ICM to provision virtual machines may entail additional extensions and adjustments not covered in this guide, especially for larger and more complex deployments, and may not be suitable for production use. Full support is expected in a later release.
PreExisting Cluster (PreExisting) Parameters
Parameter Meaning
IPAddress This is a required field (in the definitions file) for provider PreExisting and is a generated field for all other providers.
DNSName FQDN of the compute instance, or its IP Address if unavailable. Deployments of type PreExisting may populate this field (in the definitions file) to provide names for display by the icm inventory command. This is a generated field for all other providers.


Send us comments on this page
View this book as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-09-19 06:44:29