Before creating and deploying a cluster, configure one environment and one deployer. A cluster has an environment field to
reference to its corresponding environment.
clusters:
<SMI cluster name>
type: "smartphy"
# optional cluster `size` field. Support `small` or `normal`.Default value is `small` if not specified.
size: small
environment: <environment of vCenter hosting the SMI cluster>
gateway: <gateway IP address>
username: <user name for the SMI cluster>
# SSH private-key-file with path relative to the staging directory
# If the line is missing, ssh private key will be auto-generated and saved inside .sec/
private-key-file: <path and filename for ssh private key>
# The following two fields are for multi-node cluster only
master-vip: <virtual IP address for the management network in CIDR format>
vrouter-id: <VRRP ID for the management network>
# ingress-hostname only supports '.' and alphanumeric characters
ingress-hostname: "smartphy.example.com"
# For Multi-Node cluster only
nodes:
- host: <ESXi host 1 IP address>
addresses: [ <CONTROL-PLANE 1 IP>, <ETCD 1 IP>, <INTRA 1 IP>, <OPS 1 IP> ]
datastore: <vCenter datastore for host 1>
ops:
interfaces:
- vip: [ <LIST of virtual IP for CIN network in CIDR format> ]
vrouter-id: <VRRP ID for CIN network>
addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]
nics: <vCenter network for CIN>
# CIN routing table (optional)
routes:
- { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }
- { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }
- host: <ESXi host 2 IP address>
addresses: [ <CONTROL-PLANE 2 IP>, <ETCD 2 IP>, <INTRA 2 IP>, <OPS 2 IP> ]
datastore: <vCenter datastore for host 2>
ops:
interfaces:
- addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]
- host: <ESXi host 3 IP address>
addresses: [ <CONTROL-PLANE 3 IP>, <ETCD 3 IP>, <INTRA 3 IP>, <OPS 3 IP> ]
datastore: <vCenter datastore for host 3>
ops:
interfaces:
- addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]
# For Single-Node cluster only
nodes:
- host: <ESXi host IP address>
addresses: [ <AIO VM IP address> ]
datastore: <vCenter datastore for host>
ops:
interfaces:
- addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]
nics: <vCenter network for CIN>
routes:
- { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }
- { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }
Command
|
Description
|
<cluster name>
|
Cluster name.
|
type
|
Use smartphy for Cisco Smart PHY cluster.
|
size
|
Small or normal. When the sizee is not specified, the default value is small.
|
environment
|
Reference to vCenter environment.
|
gateway
|
Gateway for the cluster nodes.
|
username
|
Username of the cluster.
|
private-key-file
|
SSH private-key-file with the path relative to the staging directory.
If the line is missing, the SSH private key will be auto-generated and saved inside .sec/ .
|
master-vip
|
Primary virtual IP address in CIDR format (multinode only).
|
vrouter-id
|
VRRP ID for management network (multinode only).
|
ingress-hostname
|
Fully Qualified Domain Name (FQDN) assigned to the cluster. Only alphanumeric characters and period (.) are allowed. Your authoritative DNS server must be configured to resolve the specified FQDN and the following subdomains:
-
cli.smartphy-data-ops-center.<fqdn>
-
restconf.smartphy-data-ops-center.<fqdn>
-
cli.opshub-data-ops-center.<fqdn>
-
restconf.opshub-data-ops-center.<fqdn>
-
cli.cee-data-ops-center.<fqdn>
-
restconf.cee-data-ops-center.<fqdn>
Alternatively, if your authoritative DNS server supports wildcards, you must configure the DNS to resolve the specified FQDN
and a wildcard record covering the subdomains listed here.
If you do not specify an FQDN:
-
The cluster IP address is used to generate an FQDN leveraging nip.io as the domain and top-level domain (TLD). For example, if the IP address of the cluster is 10.0.0.2, the generated FQDN is
10.0.0.2.nip.io . The subdomains listed here are also leveraged.
-
Your DNS servers must allow the resolution of the nip.io domain. If resolution of nip.io is blocked, you cannot access the cluster.
|
- host
|
ESXi IP address where VMs are hosted
|
addresses
|
IP addresses assigned to control-plane, etcd, infra and docsis or operations nodes respectively
|
CIN Configuration
|
- vip
|
Virtual IP address in CIDR format.
|
vrouter-id
|
VRRP ID for CIN.
|
addresses
|
CIN IP addresses in CIDR format.
|
nics
|
vCenter NICs for CIN.
|
For Single-Node cluster
|
- host
|
ESXi IP address where VM is hosted.
|
ops
|
Cisco Smart PHY CIN configuration.
|
Guidelines for configuring a cluster:
-
The name of the cluster can have only lowercase letters, digits, and hyphens (-).
-
The private-key-file
field, when present, should refer to the SSH private key file. This file must be in the staging directory and must not be
accessible (read/write/execute) to other users.
If the private-key-file line is missing, the deployer
script generates an SSH private key for the cluster and places it in the .sec
subdirectory under the staging directory. The filename is <cluster-name>_auto.pem
.
-
Configure the virtual IP address of the Smart PHY cluster and VRRP ID (vrouter-id
at cluster level) for the management network for multinode clusters. The management network supports only IPv4. The vrouter-id
can take values 1–254.
-
If multiple clusters share the same management subnet, the VRRP ID for each cluster must be unique in the management subnet.