Planning for the procedure
Background knowledge
This procedure assumes that:
-
you are installing into an existing VMware vSphere deployment which has pre-configured networks and VLANs; this procedure does not cover setting up a VMware vSphere deployment from scratch
-
you have deployed a SIMPL VM, unpacked the CSAR, and prepared an SDF.
Method of procedure
Refer to the SIMPL VM Documentation for details on the commands mentioned in the procedure. |
Step 1 - Validate ShCM RVT configuration
Validate the configuration for the ShCM nodes to ensure that each ShCM node can properly self-configure.
To validate the configuration after creating the YAML files, run
rvtconfig validate -t shcm -i <yaml-config-file-directory>
on the SIMPL VM from the resources
subdirectory of the ShCM CSAR.
Step 2 - Upload ShCM RVT configuration
Upload the configuration for the ShCM nodes to the CDS. This will enable each ShCM node to self-configure when they are deployed in the next step.
To upload configuration after creating the YAML files and validating them as described above, run
rvtconfig upload-config -c <tsn-mgmt-addresses> -t shcm -i <yaml-config-file-directory> (--vm-version-source this-rvtconfig | --vm-version <version>)
on the SIMPL VM from the resources
subdirectory of the ShCM CSAR.
See Example configuration YAML files for example configuration files.
An in-depth description of RVT YAML configuration can be found in the Rhino VoLTE TAS Configuration and Management Guide.
Deployments using SIMPL 6.7.3
Step 3 - Deploy the OVA
Run csar deploy --vnf shcm --sdf <path to SDF>
.
This will validate the SDF, and generate the terraform template. After successful validation, this will upload the image, and deploy the number of ShCM nodes specified in the SDF.
Only one node type should be deployed at the same time. I.e. when deploying these ShCM nodes, don’t deploy other node types at the same time in parallel. |
Backout procedure
To delete the deployed VMs, run
csar delete --vnf shcm --sdf <path to SDF>
.
You must also delete the MDM state for each VM.
To do this, you must first SSH into one of the MDM VMs.
Get the instance IDs by running: mdmhelper --deployment-id <deployment ID> instance list
.
Then for each ShCM VM, run the following command:
curl -X DELETE -k \
--cert /etc/certs-agent/upload/mdm-cert.crt \
--cacert /etc/certs-agent/upload/mdm-cas.crt \
--key /etc/certs-agent/upload/mdm-key.key \
https://127.0.0.1:4000/api/v1/deployments/<deployment ID>/instances/<instance ID>
Verify that the deletion worked by running mdmhelper --deployment-id <deployment ID> instance list
again.
You may now log out of the MDM VM.
You must also delete state for this node type and version from the CDS prior to re-deploying the VMs.
To delete the state, run
rvtconfig delete-node-type --cassandra-contact-point <any TSN IP> --deployment-id <deployment ID>
.
--site-id <site ID> --node-type shcm
(--vm-version-source [this-vm | this-rvtconfig] | --vm-version <vm_version>)
Deployments using SIMPL 6.6.x
Backout procedure
To delete the deployed VMs, run
csar deploy --vnf shcm --delete
.
You must also delete the MDM state for each VM.
To do this, you must first SSH into one of the MDM VMs.
Get the instance IDs by running: mdmhelper --deployment-id <deployment ID> instance list
.
Then for each ShCM VM, run the following command:
curl -X DELETE -k \
--cert /etc/certs-agent/upload/mdm-cert.crt \
--cacert /etc/certs-agent/upload/mdm-cas.crt \
--key /etc/certs-agent/upload/mdm-key.key \
https://127.0.0.1:4000/api/v1/deployments/<deployment ID>/instances/<instance ID>
Verify that the deletion worked by running mdmhelper --deployment-id <deployment ID> instance list
again.
You may now log out of the MDM VM.
You must also delete state for this node type and version from the CDS prior to re-deploying the VMs.
To delete the state, run
rvtconfig delete-node-type --cassandra-contact-point <any TSN IP> --deployment-id <deployment ID>
.
--site-id <site ID> --node-type shcm
(--vm-version-source [this-vm | this-rvtconfig] | --vm-version <vm_version>)
Next Step
If you are upgrading a full set of VMs, go to Deploy MAG nodes on VMware vSphere, otherwise follow the verification instructions here: Verify the state of the nodes and processes