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.
Reserve maintenance period
This procedure does not require a maintenance period. However, if you are integrating into a live network, we recommend that you implement measures to mitigate any unforeseen events.
Tools and access
You must have access to the SIMPL VM, and the SIMPL VM must have the right permissions on the VMware vSphere deployment.
Determine Parameter Values
In the below steps, replace parameters marked with angle brackets (such as <deployment ID>)
with values as follows.
(Replace the angle brackets as well, so that they are not included in the final command to be run.)
-
<path to SDF>: The path to the SDF file on SIMPL VM. For example,/home/admin/current-config/sdf-rvt.yaml. -
<yaml-config-file-directory>: The path to the directory file where config is located on SIMPL VM. For example,/home/admin/current-config/ -
<vm version>: The version of the VM that is deployed. For example,3.2-3-1.0.0. -
<CDS address>: The management IP address of the first CDS node. -
<CDS auth args>(authentication arguments): If your CDS has Cassandra authentication enabled, replace this with the parameters-u <username> -k <secret ID>to specify the configured Cassandra username and the secret ID of a secret containing the password for that Cassandra user. For example,./rvtconfig -c 1.2.3.4 -u cassandra-user -k cassandra-password-secret-id ….If your CDS is not using Cassandra authentication, omit these arguments.
-
<deployment ID>: The deployment ID. You can find this at the top of the SDF. -
<site ID>: A number for the site in the formDC1throughDC32. You can find this at the top of the SDF. -
<any CDS IP>: The management IP address of any TSN node.
Method of procedure
|
Refer to the SIMPL VM Documentation for details on the commands mentioned in the procedure. |
Step 1 - Validate custom RVT configuration
Validate the configuration for the custom nodes to ensure that each custom node can properly self-configure.
To validate the configuration after creating the YAML files, run
rvtconfig validate -t custom -i <yaml-config-file-directory>
on the SIMPL VM from the resources subdirectory of the custom CSAR.
Step 2 - Upload custom RVT configuration
Upload the configuration for the custom nodes to the CDS. This will enable each custom 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 <CDS address> <CDS auth args> -t custom -i <yaml-config-file-directory> (--vm-version-source this-rvtconfig | --vm-version <vm version>)
on the SIMPL VM from the resources subdirectory of the custom CSAR.
See Example configuration YAML files for example configuration files.
Step 3 - Deploy the OVA
Run csar deploy --vnf .
|
|
image-name you specified in the node-parameters.yaml file that was provided to the VM Build Container.
|
This will validate the SDF, and generate the terraform template. After successful validation, this will upload the image, and deploy the number of custom nodes specified in the SDF.
|
Only one node type should be deployed at the same time. I.e. when deploying these custom nodes, don’t deploy other node types at the same time in parallel. |
Backout procedure
To delete the deployed VMs, run
csar delete --vnf .
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 custom 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 deploying the VMs again.
To delete the state, run
rvtconfig delete-node-type-version --cassandra-contact-point <any CDS IP> --deployment-id <deployment ID>.
--site-id <site ID> --t custom (--ssh-key SSH_KEY | --ssh-key-secret-id SSH_KEY_SECRET_ID)
(--vm-version-source [this-vm | this-rvtconfig] | --vm-version <vm version>)
