Installation Parameters
This section explains the important parameters that must be specified while installing the Crosswork cluster. Kindly ensure that you have relevant information to provide for each of the parameters mentioned in the table and that your environment meets all the requirements specified under Cisco Crosswork Installation Requirements.
Note |
Some of the below parameters may be named differently depending upon the destination platform (vCenter or Amazon EC2), the installation method (automated or manual), and IP stack (IPv4 or IPv6) you choose. |
Note |
Secure ZTP and Secure Syslog require the Crosswork cluster to be deployed with FQDN. |
Parameter Name |
Description |
||
---|---|---|---|
ClusterName |
Name of the cluster file |
||
ClusterIPStack |
The IP stack protocol: IPv4 or IPv6 |
||
ManagementIPAddress |
The Management IP address of the VM (IPv4 or IPv6). |
||
ManagementIPNetmask |
The Management IP subnet in dotted decimal format (IPv4 or IPv6). |
||
ManagementIPGateway |
The Gateway IP on the Management Network (IPv4 or IPv6). The address must be reachable, otherwise the installation will fail. |
||
ManagementVIP |
The Management Virtual IP for the cluster. |
||
ManagementVIPName |
Name of the Management Virtual IP for the cluster. This is an optional parameters used to reach Crosswork cluster Management VIP via DNS name. If this parameter is used, the corresponding DNS record must exist in the DNS server and must match the ManagementVIP and ManagementVIPName. |
||
DataIPAddress |
The Data IP address of the VM (IPv4 or IPv6). |
||
DataIPNetmask |
The Data IP subnet in dotted decimal format (IPv4 or IPv6). |
||
DataIPGateway |
The Gateway IP on the Data Network (IPv4 or IPv6). The address must be reachable, otherwise the installation will fail. |
||
DataVIP |
The Data Virtual IP for the cluster. |
||
DataVIPName |
Name of the Data Virtual IP for the cluster. This is an optional parameters used to reach Crosswork cluster Data VIP via DNS name. If this parameter is used, the corresponding DNS record must exist in the DNS server and must match the DataVIP and DataVIPName. |
||
DNS |
The IP address of the DNS server (IPv4 or IPv6). The address must be reachable, otherwise the installation will fail. |
||
NTP |
NTP server address or name. The address must be reachable, otherwise the installation will fail. |
||
DomainName |
The domain name used for the cluster. |
||
CWusername |
Username to log into Cisco Crosswork. This is an optional parameter. |
||
CWPassword |
Password to log into Cisco Crosswork. Use a strong VM Password (8 characters long, including upper & lower case letters, numbers, and one special character). Avoid using passwords similar to dictionary words (for example, "Pa55w0rd!") or relatable words (for example, C!sco123 or Cwork321!). While they satisfy the criteria, such passwords are weak and will result in the failure of VM setup. You are recommended to use a password with more characters and complex combinations. |
||
VMSize |
VM size for the cluster. Value is |
||
VMName |
Name of the VM You will require at least 3 unique names (one for each VM). |
||
VMType |
Indicates the type of VM. Choose either "Hybrid" or "Worker".
|
||
IsSeed |
Choose "True" if this is the first VM being built in a new cluster. Choose "False" for all other VMs, or when rebuilding a failed VM. This paramater is optional for installing using the cluster installer tool. |
||
InitNodeCount |
Total number of nodes in the cluster including Hybrid and Worker nodes. The default value is 3. This paramater is optional for installing using the cluster installer tool. |
||
InitMasterCount |
Total number of Hybrid nodes in the cluster. The default value is 3. This paramater is optional for installing using the cluster installer tool. |
||
BackupMinPercent |
Minimum percentage of the data disk space to be used for the size of the backup partition. The default value is 50 (valid range is from 1 to 80). Please use the default value unless recommended otherwise.
|
||
ManagerDataFsSize |
Refers to the data disk size for Hybrid nodes (in Giga Bytes). This is an optional parameter and the default value is 450 (valid range is from 450 to 8000), if not explicitly specified. Please use the default value unless recommended otherwise. |
||
WorkerDataFsSize |
Refers to the data disk size for Worker nodes (in Gigabytes). This is an optional parameter and the default value is 450 (valid range is from 450 to 8000), if not explicitly specified. Please use the default value unless recommended otherwise. |
||
ThinProvisioned |
Thin or thick provisioning for all disks. Set as "false" for live production deployments, and "true" for lab deployments. |
||
EnableHardReservations |
Determines the enforcement of VM CPU and Memory profile reservations (see VMware Resource Requirements for more information). This is an optional parameter and the default value is If set as If set as |
||
RamDiskSize |
Size of the Ram disk. This parameter is only used for lab installations (value must be at least 2). When a non-zero value is provided for |
||
OP_Status |
The state for this VM. To indicate a running status, the value must be 2 ( This is an optional parameter. This parameter is used (uncommented) only for manually importing the inventory without using the installer. |
||
SchemaVersion |
The configuration Manifest schema version |
||
LogFsSize |
Log partition size (in Giga Bytes). Minimum value is 10 GB and Maximum value is 1000 GB. |
Parameter Name |
Description |
---|---|
vCenterAddress |
The vCenter IP or host name. |
vCenterUser |
The username needed to log into vCenter. |
vCenterPassword |
The password needed to log into vCenter. |
DCname |
The name of the Data Center resource to use. |
MgmtNetworkName |
The name of the vCenter network to attach to the VM's Management interface. |
DataNetworkName |
The name of the vCenter network to attach to the VM's Data interface. |
Host |
The ESXi host or resource group name. |
Datastore |
The datastore name available to be used by this host or resource group. |
HSDatastore |
The high speed datastore available for this host or resource group. |
DCfolder |
The resource folder name on vCenter. Leave as empty if not used. |
Cw_VM_Image |
The name of Crosswork cluster VM image in vCenter. If left blank, the name is generated from the uploaded image. |
HostedCwVMs |
The IDs of the VMs to be hosted by the ESXi host or resource. These have to match to the Crosswork cluster VM. |
Parameter Name |
Description |
---|---|
ManagementPeerIPs |
The Management IP addresses of all the deployed VMs. |
DataPeerIPs |
The Data IP addresses of all the deployed VMs. |
AwsIamRole |
The Identity and Access Management (IAM) user id created for by your AWS account administrator to build the cluster virtual machines. |
K8sServiceNetwork |
The network address for the kubernetes service network. The CIDR range is fixed to '/16'. This is an optional parameter. |
K8sPodNetwork |
The network address for the kubernetes pod network. The CIDR range is fixed to '/16'. This is an optional parameter. |