Planning for the procedure
Background knowledge
This procedure assumes that:
-
you are installing into an existing OpenStack deployment
-
The OpenStack deployment must be set up with support for Heat templates.
-
-
you are using an OpenStack version from Newton through to Wallaby inclusive
-
you are thoroughly familiar with working with OpenStack machines and know how to set up tenants, users, roles, client environment scripts, and so on.
(For more information, refer to the appropriate OpenStack installation guide for the version that you are using here.)
-
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 OpenStack 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 - Check OpenStack quotas
The SIMPL VM creates one server group per VM, and one security group per interface on each VM. OpenStack sets limits on the number of server groups and security groups through quotas.
View the quota by running openstack quota show <project id> on OpenStack Controller node.
This shows the maximum number of various resources.
You can view the existing server groups by running openstack server group list.
Similarly, you can find the security groups by running openstack security group list
If the quota is too small to accommodate the new VMs that will be deployed,
increase it by running
openstack quota set --<quota field to increase> <new quota value> <project ID>. For example:
openstack quota set --server-groups 100 125610b8bf424e61ad2aa5be27ad73bb
Step 2 - Validate SGC RVT configuration
Validate the configuration for the SGC nodes to ensure that each SGC node can properly self-configure.
To validate the configuration after creating the YAML files, run
rvtconfig validate -t sgc -i <yaml-config-file-directory>
on the SIMPL VM from the resources subdirectory of the SGC CSAR.
Step 3 - Upload SGC RVT configuration
Upload the configuration for the SGC nodes to the CDS. This will enable each SGC 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 sgc -i <yaml-config-file-directory> (--vm-version-source this-rvtconfig | --vm-version <vm version>)
on the SIMPL VM from the resources subdirectory of the SGC CSAR.
See Example configuration YAML files for example configuration files.
Step 4 - Deploy the OVA
Run csar deploy --vnf sgc --sdf <path to SDF>.
This will validate the SDF, and generate the heat template. After successful validation, this will upload the image, and deploy the number of SGC nodes specified in the SDF.
|
Only one node type should be deployed at the same time. I.e. when deploying these SGC nodes, don’t deploy other node types at the same time in parallel. |
Backout procedure
To delete the deployed VMs, run
csar delete --vnf sgc --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 SGC 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 sgc (--ssh-key SSH_KEY | --ssh-key-secret-id SSH_KEY_SECRET_ID)
(--vm-version-source [this-vm | this-rvtconfig] | --vm-version <vm version>)
