Installing on RHOSP

The Red Hat Openstack Platform Director is the supported and recommended method to deploy and maintain any RHOSP installation.
TrilioVault is integrating natively into the RHOSP Director.
Manual deployment methods are not supported for RHOSP.
1. Prepare for deployment
1.1] Select 'backup target' type
 Backup target storage is used to store backup images taken by TrilioVault and details needed for configuration: 
Following backup target types are supported by TrilioVault
a) NFS
Need NFS share path 
b) Amazon S3
- S3 Access Key
- Secret Key
- Region
- Bucket name
c) Other S3 compatible  storage (Like, Ceph based S3)
- S3 Access Key
- Secret Key
- Region
- Endpoint URL (Valid for S3 other than Amazon S3)
- Bucket name
1.2] Clone triliovault-cfg-scripts repository
The following steps are to be done on 'undercloud' node on an already installed RHOSP environment.
The overcloud-deploy command has to be run successfully already and the overcloud should be available.
All commands need to be run as user 'stack' on undercloud node
The following command clones the triliovault-cfg-scripts github repository.
1
cd /home/stack
2
git clone -b stable/4.2 https://github.com/trilioData/triliovault-cfg-scripts.git
3
cd triliovault-cfg-scripts/redhat-director-scripts/<RHOSP_RELEASE_DIRECTORY>/
Copied!
Next access the Red Hat Director scripts according to the used RHOSP version.
RHOSP 13
1
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp13/
Copied!
RHOSP 16.1
1
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/
Copied!
RHOSP 16.2
1
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp16.2/
Copied!
The remaining documentation will use the following path for examples:
1
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/
Copied!
1.3] If backup target type is 'Ceph based S3'   with SSL:
If your backup target is ceph S3 with SSL and SSL certificates are self signed or authorized by private CA, then user needs to provide CA chain certificate to validate the SSL requests. For that, user needs to rename his ca chain cert file to 's3-cert.pem' and copy it into directory - 'triliovault-cfg-scripts/redhat-director-scripts/redhat-director-scripts/<RHOSP_RELEASE_Directory/puppet/trilio/files'
1
cp s3-cert.pem /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/puppet/trilio/files/
Copied!
1.4] If no Barbican is installed
If the RHOSP environment doesn't contain barbican a small change to one of the puppet modules is required.
This will be part of an upcoming 4.2 hotfix release.
1.Edit file 'triliovault-cfg-scripts/redhat-director-scripts/<RHOSP_RELEASE_DIRECTORY>/puppet/trilio/manifests/horizon.pp'
2.replace line number 3 with the following line
1
$barbican_api_enabled               = hiera('barbican_api_enabled', false),
Copied!
2] Upload trilio puppet module
The following commands upload the Trilio puppet module to the overcloud registry. The actual upload happens upon the next deployment.
​
1
cd /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/scripts/
2
./upload_puppet_module.sh
3
​
4
## Output of above command looks like following.
5
Creating tarball...
6
Tarball created.
7
Creating heat environment file: /home/stack/.tripleo/environments/puppet-modules-url.yaml
8
Uploading file to swift: /tmp/puppet-modules-8Qjya2X/puppet-modules.tar.gz
9
+-----------------------+---------------------+----------------------------------+
10
| object                | container           | etag                             |
11
+-----------------------+---------------------+----------------------------------+
12
| puppet-modules.tar.gz | overcloud-artifacts | 368951f6a4d39cfe53b5781797b133ad |
13
+-----------------------+---------------------+----------------------------------+
14
​
15
## Above command creates following file.
16
ls -ll /home/stack/.tripleo/environments/puppet-modules-url.yaml
Copied!
Trilio puppet module is uploaded to overcloud as a swift deploy artifact with heat resource name 'DeployArtifactURLs'. If you check trilio's puppet module artifact file it looks like following.
1
(undercloud) [[email protected] ~]$ cat /home/stack/.tripleo/environments/puppet-modules-url.yaml
2
# Heat environment to deploy artifacts via Swift Temp URL(s)
3
parameter_defaults:
4
    DeployArtifactURLs:
5
    - 'http://172.25.0.103:8080/v1/AUTH_46ba596219d143c8b076e9fcc4139fed/overcloud-artifacts/puppet-modules.tar.gz?temp_url_sig=c3972b7ce75226c278ab3fa8237d31cc1f2115bd&temp_url_expires=1646738377'
6
​
Copied!
Note: If your overcloud deploy command using any other deploy artifact through a environment file, then you need to merge trilio deploy artifact url and your url in single file. 
How to check if your overcloud deploy environment files using deploy artifacts?
You need to check string 'DeployArtifactURLs' in your environment files (only those mentioned in overcloud deploy command with -e option). If you find it any such  environment file that is mentioned in overcloud dpeloy command with '-e' option then your deploy command is using deploy artifact.
In that case you need to merge all deploy artifacts in single file. Refer following steps.
Let's say, your artifact file path is "/home/stack/templates/user-artifacts.yaml" then refer following steps to merge both urls in single file and pass that new file to overcloud deploy command with '-e' option.
1
(undercloud) [[email protected] ~]$ cat /home/stack/.tripleo/environments/puppet-modules-url.yaml | grep http >> /home/stack/templates/user-artifacts.yaml
2
(undercloud) [[email protected] ~]$ cat /home/stack/templates/user-artifacts.yaml
3
# Heat environment to deploy artifacts via Swift Temp URL(s)
4
parameter_defaults:
5
    DeployArtifactURLs:
6
    - 'http://172.25.0.103:8080/v1/AUTH_57ba596219d143c8b076e9fcc4139f3g/overcloud-artifacts/some-artifact.tar.gz?temp_url_sig=dc972b7ce75226c278ab3fa8237d31cc1f2115sc&temp_url_expires=3446738365'
7
    - 'http://172.25.0.103:8080/v1/AUTH_46ba596219d143c8b076e9fcc4139fed/overcloud-artifacts/puppet-modules.tar.gz?temp_url_sig=c3972b7ce75226c278ab3fa8237d31cc1f2115bd&temp_url_expires=1646738377'
8
​
Copied!
​
3] Update overcloud roles data file to include Trilio services
TrilioVault contains multiple services. Add these services to your roles_data.yaml. 
In the case of uncustomized roles_data.yaml can the default file be found on the undercloud at:
/usr/share/openstack-tripleo-heat-templates/roles_data.yaml
Add the following services to the roles_data.yaml
 All commands need to be run as user 'stack'
3.1] Add Trilio Datamover Api Service to role data file
This service needs to share the same role as the keystone and database service.
In case of the pre-defined roles will these services run on the role Controller.
In case of custom defined roles, it is necessary to use the same role where 'OS::TripleO::Services::Keystone' service installed.
Add the following line to the identified role:
1
'OS::TripleO::Services::TrilioDatamoverApi'
Copied!
3.2] Add Trilio Datamover Service to role data file 
This service needs to share the same role as the nova-compute service.
In case of the pre-defined roles will the nova-compute service run on the role Compute.
In case of custom defined roles, it is necessary to use the role the nova-compute service is using.
Add the following line to the identified role:
1
'OS::TripleO::Services::TrilioDatamover' 
Copied!
3.3] Add Trilio Horizon Service role data file
This service needs to share the same role as the OpenStack Horizon server.
In case of the pre-defined roles will the Horizon service run on the role Controller.

Add the following line to the identified role:
1
OS::TripleO::Services::TrilioHorizon
Copied!
4] Prepare Trilio container images
All commands need to be run as user 'stack'
Trilio containers are pushed to 'RedHat Container Registry'. 
Registry URL: 'registry.connect.redhat.com'. Container pull URLs are given below.
Please note that using the hotfix containers requires that the TrilioVault Appliance is getting upgraded to the desired hotfix level as well.
RHOSP 13
1
TrilioVault 4.2 GA
2
TrilioVault Datamover container:        registry.connect.redhat.com/trilio/trilio-datamover:4.2.64-rhosp13
3
TrilioVault Datamover Api Container:   registry.connect.redhat.com/trilio/trilio-datamover-api:4.2.64-rhosp13
4
TrilioVault horizon plugin:            registry.connect.redhat.com/trilio/trilio-horizon-plugin:4.2.64-rhosp13
Copied!
RHOSP 16.1
1
TrilioVault 4.2 GA
2
TrilioVault Datamover container:        registry.connect.redhat.com/trilio/trilio-datamover:4.2.64-rhosp16.1
3
TrilioVault Datamover Api Container:   registry.connect.redhat.com/trilio/trilio-datamover-api:4.2.64-rhosp16.1
4
TrilioVault horizon plugin:            registry.connect.redhat.com/trilio/trilio-horizon-plugin:4.2.64-rhosp16.1
Copied!
RHOSP 16.2
1
TrilioVault 4.2 GA
2
TrilioVault Datamover container:        registry.connect.redhat.com/trilio/trilio-datamover:4.2.64-rhosp16.2
3
TrilioVault Datamover Api Container:   registry.connect.redhat.com/trilio/trilio-datamover-api:4.2.64-rhosp16.2
4
TrilioVault horizon plugin:            registry.connect.redhat.com/trilio/trilio-horizon-plugin:4.2.64-rhosp16.2
Copied!
There are three registry methods available in RedHat Openstack Platform.
1.Remote Registry
2.Local Registry
3.Satellite Server
4.1] Remote Registry
Follow this section when 'Remote Registry' is used.
In this method, container images gets downloaded directly on overcloud nodes during overcloud deploy/update command execution. User can set remote registry to redhat registry or any other private registry that he wants to use.
User needs to provide credentials of the registry in 'containers-prepare-parameter.yaml' file.
1.Make sure other openstack service images are also using the same method to pull container images.
If it's not the case you can not use this method.
2.Populate 'containers-prepare-parameter.yaml' with content like following. Important parameters are 'push_destination: false',  
ContainerImageRegistryLogin: true and registry credentials.
TrilioVault container images are published to registry 'registry.connect.redhat.com'. 
Credentials of  registry 'registry.redhat.io' will work for 'registry.connect.redhat.com' registry too. 
Note: This file -'containers-prepare-parameter.yaml' 
File Name: containers-prepare-parameter.yaml
1
parameter_defaults:
2
  ContainerImagePrepare:
3
  - push_destination: false
4
    set:
5
      namespace: registry.redhat.io/...
6
      ...
7
  ...
8
  ContainerImageRegistryCredentials:
9
    registry.redhat.io:
10
      myuser: '[email protected]!'
11
    registry.connect.redhat.com:
12
      myuser: '[email protected]!'
13
  ContainerImageRegistryLogin: true
Copied!
Redhat document for remote registry method: 
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.1/html/director_installation_and_usage/preparing-for-director-installation#container-image-preparation-parameters​
Note: File 'containers-prepare-parameter.yaml' gets created as output of command 'openstack tripleo container image prepare'. Refer above document by RedHat
3. Make sure you have network connectivity to above registries from all overcloud nodes. Otherwise image pull operation will fail.
4. User need to manually populate the trilio_env.yaml file with TrilioVault container image URLs as given below:
trilio_env.yaml file path:
1
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/
Copied!
1
# For RHOSP13
2
$ grep 'Image' trilio_env.yaml
3
   DockerTrilioDatamoverImage: registry.connect.redhat.com/trilio/trilio-datamover:4.2.64-rhosp13
4
   DockerTrilioDmApiImage: registry.connect.redhat.com/trilio/trilio-datamover-api:4.2.64-rhosp13
5
   DockerHorizonImage: registry.connect.redhat.com/trilio/trilio-horizon-plugin:4.2.64-rhosp13
6
​
7
# For RHOSP16.1
8
$ grep 'Image' trilio_env.yaml
9
   DockerTrilioDatamoverImage: registry.connect.redhat.com/trilio/trilio-datamover:4.2.64-rhosp16.1
10
   DockerTrilioDmApiImage: registry.connect.redhat.com/trilio/trilio-datamover-api:4.2.64-rhosp16.1
11
   ContainerHorizonImage: registry.connect.redhat.com/trilio/trilio-horizon-plugin:4.2.64-rhosp16.1
12
   
13
# For RHOSP16.2
14
$ grep 'Image' trilio_env.yaml
15
   DockerTrilioDatamoverImage: registry.connect.redhat.com/trilio/trilio-datamover:4.2.64-rhosp16.2
16
   DockerTrilioDmApiImage: registry.connect.redhat.com/trilio/trilio-datamover-api:4.2.64-rhosp16.2
17
   ContainerHorizonImage: registry.connect.redhat.com/trilio/trilio-horizon-plugin:4.2.64-rhosp16.2
Copied!
At this step, you have configured triliovault image urls in necessary environment file.
4.2] Local Registry
Follow this section when 'local registry' is used on the undercloud.
In this case it is necessary to push the TrilioVault containers to the undercloud registry.
TrilioVault provides shell scripts which will pull the containers from 'registry.connect.redhat.com' and push them to the undercloud and updates the trilio_env.yaml.
RHOSP13
1
cd /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp13/scripts/
2
​
3
./prepare_trilio_images.sh <undercloud_ip/hostname> 4.2.64-rhosp13
4
​
5
## Verify changes
6
$ grep '4.2.64-rhosp13' ../environments/trilio_env.yaml
7
   DockerTrilioDatamoverImage: 172.25.2.2:8787/trilio/trilio-datamover:4.2.64-rhosp13
8
   DockerTrilioDmApiImage: 172.25.2.2:8787/trilio/trilio-datamover-api:4.2.64-rhosp13
9
   DockerHorizonImage: 172.25.2.2:8787/trilio/trilio-horizon-plugin:4.2.64-rhosp13
Copied!
RHOSP 16.1
1
cd /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/scripts/
2
​
3
./prepare_trilio_images.sh <undercloud_ip/hostname> 4.2.64-rhosp16.1
4
​
5
## Verify changes
6
$ grep 'Image' ../environments/trilio_env.yaml
7
   DockerTrilioDatamoverImage: undercloud.ctlplane.localdomain:8787/trilio/trilio-datamover:4.2.64-rhosp16.1
8
   DockerTrilioDmApiImage: undercloud.ctlplane.localdomain:8787/trilio/trilio-datamover-api:4.2.64-rhosp16.1
9
   ContainerHorizonImage: undercloud.ctlplane.localdomain:8787/trilio/trilio-horizon-plugin:4.2.64-rhosp16.1
Copied!
RHOSP16.2
1
cd /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.2/scripts/
2
​
3
./prepare_trilio_images.sh <undercloud_ip/hostname> 4.2.64-rhosp16.2
4
​
5
## Verify changes
6
$ grep 'Image' ../environments/trilio_env.yaml
7
   DockerTrilioDatamoverImage: undercloud.ctlplane.localdomain:8787/trilio/trilio-datamover:4.2.64-rhosp16.2
8
   DockerTrilioDmApiImage: undercloud.ctlplane.localdomain:8787/trilio/trilio-datamover-api:4.2.64-rhosp16.2
9
   ContainerHorizonImage: undercloud.ctlplane.localdomain:8787/trilio/trilio-horizon-plugin:4.2.64-rhosp16.2
Copied!
At this step, you have downloaded triliovault container images and configured triliovault image urls in necessary environment file.
4.3] Red Hat Satellite Server
Follow this section when a Satellite Server is used for the container registry.
Pull the TrilioVault containers on the Red Hat Satellite using the given Red Hat registry URLs.​
Populate the trilio_env.yaml with container urls.
RHOSP 13
1
$ grep '4.2.64-rhosp13' ../environments/trilio_env.yaml
2
   DockerTrilioDatamoverImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-datamover:4.2.64-rhosp13
3
   DockerTrilioDmApiImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-datamover-api:4.2.64-rhosp13
4
   DockerHorizonImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-horizon-plugin:4.2.64-rhosp13
Copied!
RHOSP 16.1
1
$ grep 'Image' trilio_env.yaml
2
   DockerTrilioDatamoverImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-datamover:4.2.64-rhosp16.1
3
   DockerTrilioDmApiImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-datamover-api:4.2.64-rhosp16.1
4
   ContainerHorizonImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-horizon-plugin:4.2.64-rhosp16.1
Copied!
RHOSP16.2
1
$ grep 'Image' trilio_env.yaml
2
   DockerTrilioDatamoverImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-datamover:4.2.64-rhosp16.2
3
   DockerTrilioDmApiImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-datamover-api:4.2.64-rhosp16.2
4
   ContainerHorizonImage: <SATELLITE_REGISTRY_URL>/trilio/trilio-horizon-plugin:4.2.64-rhosp16.2
Copied!
​
At this step, you have downloaded triliovault container images into RedHat sattelite server  and configured triliovault image urls in necessary environment file.
5] Configure multi-IP NFS
This section is only required when the multi-IP feature for NFS is required.
This feature allows to set the IP to access the NFS Volume per datamover instead of globally.
On Undercloud node, change directory
1
cd triliovault-cfg-scripts/common/
Copied!
Edit file 'triliovault_nfs_map_input.yml' in the current directory and provide compute host and NFS share/ip map.
Get the compute hostnames from the following command. Check ‘Name' column. Use exact hostnames in 'triliovault_nfs_map_input.yml' file.
Run this command on undercloud by sourcing 'stackrc'.
1
(undercloud) [[email protected] ~]$ openstack server list
2
+--------------------------------------+-------------------------------+--------+----------------------+----------------+---------+
3
| ID                                   | Name                          | Status | Networks             | Image          | Flavor  |
4
+--------------------------------------+-------------------------------+--------+----------------------+----------------+---------+
5
| 8c3d04ae-fcdd-431c-afa6-9a50f3cb2c0d | overcloudtrain1-controller-2  | ACTIVE | ctlplane=172.30.5.18 | overcloud-full | control |
6
| 103dfd3e-d073-4123-9223-b8cf8c7398fe | overcloudtrain1-controller-0  | ACTIVE | ctlplane=172.30.5.11 | overcloud-full | control |
7
| a3541849-2e9b-4aa0-9fa9-91e7d24f0149 | overcloudtrain1-controller-1  | ACTIVE | ctlplane=172.30.5.25 | overcloud-full | control |
8
| 74a9f530-0c7b-49c4-9a1f-87e7eeda91c0 | overcloudtrain1-novacompute-0 | ACTIVE | ctlplane=172.30.5.30 | overcloud-full | compute |
9
| c1664ac3-7d9c-4a36-b375-0e4ee19e93e4 | overcloudtrain1-novacompute-1 | ACTIVE | ctlplane=172.30.5.15 | overcloud-full | compute |
10
+--------------------------------------+-------------------------------+--------+----------------------+----------------+---------+
Copied!
Edit input map file and fill all the details. Refer to the this page for details about the structure.
vi triliovault_nfs_map_input.yml
Update pyyaml on the undercloud node only
If pip isn't available please install pip on the undercloud.
1
## On Python3 env 
2
sudo pip3 install PyYAML==5.1 3 
3
​
4
## On Python2 env 
5
sudo pip install PyYAML==5.1
Copied!
Expand the map file to create a one-to-one mapping of the compute nodes and the nfs shares.
1
## On Python3 env 
2
python3 ./generate_nfs_map.py 
3
 
4
## On Python2 env 
5
python ./generate_nfs_map.py
Copied!
The result will be in file - 'triliovault_nfs_map_output.yml'
Validate output map file
Open file 'triliovault_nfs_map_output.yml
vi triliovault_nfs_map_output.yml
available in the current directory and validate that all compute nodes are covered with all the necessary NFS shares.
Append this output map file to 'triliovault-cfg-scripts/redhat-director-scripts/<RHOSP_RELEASE_DIRECTORY>/environments/trilio_nfs_map.yaml'
1
grep ':.*:' triliovault_nfs_map_output.yml >> ../redhat-director-scripts/<RHOSP_RELEASE_DIRECTORY>/environments/trilio_nfs_map.yaml
Copied!
Validate the changes in file 'triliovault-cfg-scripts/redhat-director-scripts/<RHOSP_RELEASE_DIRECTORY>/environments/trilio_nfs_map.yaml'
Include the environment file (trilio_nfs_map.yaml) in overcloud deploy command with '-e' option as shown below.
1
-e /home/stack/triliovault-cfg-scripts/redhat-director-scripts/<RHOSP_RELEASE_DIRECTORY>/environments/trilio_nfs_map.yaml
Copied!
Ensure that MultiIPNfsEnabled is set to true in trilio_env.yaml file and that nfs is used as backup target.
6] Provide environment details in trilio-env.yaml
Provide backup target details and other necessary details in the provided environment file. This environment file will be used in the overcloud deployment to configure Trilio components. Container image names have already been populated in the preparation of the container images. Still it is recommended to verify the container URLs.
The following information are required additionally:
Network for the datamover api
datamover password
Backup target type {nfs/s3}
In case of NFS
list of NFS Shares
NFS options
MultiIPNfsEnabled
In case of S3
S3 type {amazon_s3/ceph_s3}
S3 Access key
S3 Secret key
S3 Region name
S3 Bucket
S3 Endpoint URL
S3 Signature Version
S3 Auth Version
S3 SSL Enabled {true/false}
S3 SSL Cert
Use ceph_s3 for any non-aws S3 backup targets.
1
resource_registry:
2
  OS::TripleO::Services::TrilioDatamover: ../services/trilio-datamover.yaml
3
  OS::TripleO::Services::TrilioDatamoverApi: ../services/trilio-datamover-api.yaml
4
  OS::TripleO::Services::TrilioHorizon: ../services/trilio-horizon.yaml
5
​
6
  # NOTE: If there are addition customizations to the endpoint map (e.g. for
7
  # other integratiosn), this will need to be regenerated.
8
  OS::TripleO::EndpointMap: endpoint_map.yaml
9
​
10
parameter_defaults:
11
​
12
   ## Enable TrilioVault's quota functionality on horizon
13
   ExtraConfig:
14
     horizon::customization_module: 'dashboards.overrides'
15
​
16
   ## Define network map for trilio datamover api service
17
   ServiceNetMap:
18
       TrilioDatamoverApiNetwork: internal_api
19
​
20
   ## TrilioVault Datamover Password for keystone and database
21
   TrilioDatamoverPassword: "test1234"
22
​
23
   ## TrilioVault container pull urls
24
   DockerTrilioDatamoverImage: devundercloud.ctlplane.localdomain:8787/trilio/trilio-datamover:4.0.41-rhosp16
25
   DockerTrilioDmApiImage: devundercloud.ctlplane.localdomain:8787/trilio/trilio-datamover-api:4.0.41-rhosp16
26
​
27
   ## If you do not want Trilio's horizon plugin to replace your horizon container, just comment following line.
28
   ContainerHorizonImage: devundercloud.ctlplane.localdomain:8787/trilio/trilio-horizon-plugin:4.0.41-rhosp16
29
​
30
   ## Backup target type nfs/s3, used to store snapshots taken by triliovault
31
   BackupTargetType: 'nfs'
32
​
33
   ## If backup target NFS share support multiple IPs and you want to use those IPs(more than one) then
34
   ## set this parameter to True. Otherwise keep it False.
35
   MultiIPNfsEnabled: False
36
​
37
   ## For backup target 'nfs'
38
   NfsShares: '192.168.122.101:/opt/tvault'
39
   NfsOptions: 'nolock,soft,timeo=180,intr,lookupcache=none'
40
​
41
   ## For backup target 's3'
42
   ## S3 type: amazon_s3/ceph_s3
43
   S3Type: 'amazon_s3'
44
​
45
   ## S3 access key
46
   S3AccessKey: ''
47
​
48
   ## S3 secret key
49
   S3SecretKey: ''
50
​
51
   ## S3 region, if your s3 does not have any region, just keep the parameter as it is
52
   S3RegionName: ''
53
​
54
   ## S3 bucket name
55
   S3Bucket: ''
56
​
57
   ## S3 endpoint url, not required for Amazon S3, keep it as it is
58
   S3EndpointUrl: ''
59
​
60
   ## S3 signature version
61
   S3SignatureVersion: 'default'
62
​
63
   ## S3 Auth version
64
   S3AuthVersion: 'DEFAULT'
65
​
66
   ## If S3 backend is not Amazon S3 and SSL is enabled on S3 endpoint url then change it to 'True', otherwise keep it as 'False'
67
   S3SslEnabled: False
68
​
69
   ## If S3 backend is not Amazon S3 and SSL is enabled on S3 endpoint URL and SSL certificates are self signed, then
70
   ## user need to set this parameter value to: '/etc/tvault-contego/s3-cert.pem', otherwise keep it's value as empty string.
71
   S3SslCert: ''
72
​
73
   ## Configure 'dmapi_workers' parameter of '/etc/dmapi/dmapi.conf' file
74
   ## This parameter value used to spawn the number of dmapi processes to handle the incoming api requests.
75
   ## If your dmapi node has ‘n' cpu cores, It is recommended, to set this parameter to '4*n’.
76
   ## If dmapi_workers field is not present in config file. The Default value will be equals to number of cores present on the node
77
   DmApiWorkers: 16
78
​
79
   ## Don't edit following parameter
80
   EnablePackageInstall: True
81
​
82
​
83
   ## Load 'rbd' kernel module on all compute nodes
84
   ComputeParameters:
85
     ExtraKernelModules:
86
       rbd: {}
Copied!
7] Advanced Settings/Configuration
7.1] Haproxy customized configuration for TrilioVault dmapi service 
The existing default haproxy configuration works fine with most of the environments. Only when timeout issues with the dmapi are observed or other reasons are known, change the configuration as described here.
Following is the haproxy conf file location on haproxy nodes of the overcloud.
TrilioVault datamover api service haproxy configuration gets added to this file.
1
/var/lib/config-data/puppet-generated/haproxy/etc/haproxy/haproxy.cfg
Copied!
TrilioVault datamover haproxy default configuration from the above file looks as follows:
1
listen trilio_datamover_api
2
  bind 172.25.0.107:13784 transparent ssl crt /etc/pki/tls/private/overcloud_endpoint.pem
3
  bind 172.25.0.107:8784 transparent
4
  balance roundrobin
5
  http-request set-header X-Forwarded-Proto https if { ssl_fc }
6
  http-request set-header X-Forwarded-Proto http if !{ ssl_fc }
7
  http-request set-header X-Forwarded-Port %[dst_port]
8
  maxconn 50000
9
  option httpchk
10
  option httplog
11
  retries 5
12
  timeout check 10m
13
  timeout client 10m
14
  timeout connect 10m
15
  timeout http-request 10m
16
  timeout queue 10m
17
  timeout server 10m
18
  server overcloud-controller-0.internalapi.localdomain 172.25.0.106:8784 check fall 5 inter 2000 rise 2
19
​
Copied!
The user can change the following configuration parameter values.
1
retries 5
2
timeout http-request 10m
3
timeout queue 10m
4
timeout connect 10m
5
timeout client 10m
6
timeout server 10m
7
timeout check 10m
8
balance roundrobin
9
maxconn 50000
Copied!
To change these default values, you need to do the following steps.
i) On the undercloud node, open the following file for edit (Edit <RHOSP_RELEASE> with your cloud's release information. Valid values are - rhosp13, rhosp16, rhosp16.1)
For RHOSP13
1
/home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp13/services/trilio-datamover-api.yaml
Copied!
For RHOSP16.1
1
/home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/services/trilio-datamover-api.yaml
Copied!
For RHOSP16.2
1
/home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.2/services/trilio-datamover-api.yaml
Copied!
ii) Search the following entries and edit as required
1
          tripleo::haproxy::trilio_datamover_api::options:
2
             'retries': '5'
3
             'maxconn': '50000'
4
             'balance': 'roundrobin'
5
             'timeout http-request': '10m'
6
             'timeout queue': '10m'
7
             'timeout connect': '10m'
8
             'timeout client': '10m'
9
             'timeout server': '10m'
10
             'timeout check': '10m'
Copied!
iii) Save the changes.
8] Deploy overcloud with trilio environment
Use the following heat environment file and roles data file in overcloud deploy command:
1.trilio_env.yaml
2.roles_data.yaml
3.Use correct Trilio endpoint map file as per available Keystone endpoint configuration
1.Instead of tls-endpoints-public-dns.yaml file, use environments/trilio_env_tls_endpoints_public_dns.yaml
2.Instead of tls-endpoints-public-ip.yaml file, useenvironments/trilio_env_tls_endpoints_public_ip.yaml
3.Instead of tls-everywhere-endpoints-dns.yaml file, useenvironments/trilio_env_tls_everywhere_dns.yaml
4.If activated use the correct trilio_nfs_map.yaml file
To include new environment files use '-e' option and for roles data file use '-r' option.
An example overcloud deploy command is shown below:
1
openstack overcloud deploy --templates \
2
  -e /home/stack/templates/node-info.yaml \
3
  -e /home/stack/templates/overcloud_images.yaml \
4
  -e /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/environments/trilio_env.yaml \
5
  -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/enable-tls.yaml \
6
  -e /usr/share/openstack-tripleo-heat-templates/environments/ssl/inject-trust-anchor.yaml \
7
  -e /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/environments/trilio_env_tls_endpoints_public_dns.yaml \
8
  -e /home/stack/triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/environments/trilio_nfs_map.yaml \
9
  --ntp-server 192.168.1.34 \
10
  --libvirt-type qemu \
11
  --log-file overcloud_deploy.log \
12
  -r /home/stack/templates/roles_data.yaml
Copied!
9] Verify deployment
If the containers are in restarting state or not listed by the following command then your deployment is not done correctly. Please recheck if you followed the complete documentation.
9.1] On Controller node 
Make sure Trilio dmapi and horizon containers are in a running state and no other Trilio container is deployed on controller nodes. 
When the role for these containers is not "controller" check on respective nodes according to configured roles_data.yaml.
1
[[email protected] heat-admin]# podman ps | grep trilio
2
26fcb9194566  rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-datamover-api:4.2.64-rhosp16.2        kolla_start           5 days ago  Up 5 days ago         trilio_dmapi
3
094971d0f5a9  rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-horizon-plugin:4.2.64-rhosp16.2       kolla_start           5 days ago  Up 5 days ago         horizon
Copied!
Verify the haproxy configuration under:
1
/var/lib/config-data/puppet-generated/haproxy/etc/haproxy/haproxy.cfg
Copied!
9.2] On Compute node
Make sure Trilio datamover container is in running state and no other Trilio container is deployed on compute nodes. 
1
[[email protected] heat-admin]# podman ps | grep trilio
2
b1840444cc59  rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-datamover:4.2.64-rhosp16.2                    kolla_start           5 days ago  Up 5 days ago         trilio_datamover
Copied!
8.3] On the node with Horizon service
Make sure horizon container is in running state. Please note that 'Horizon' container is replaced with Trilio Horizon container. This container will have latest OpenStack horizon + TrilioVault's horizon plugin.
1
[[email protected] heat-admin]# podman ps | grep horizon
2
094971d0f5a9  rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-horizon-plugin:4.2.64-rhosp16.2       kolla_start           5 days ago  Up 5 days ago         horizon
Copied!
10] Additional Steps on TrilioVault Appliance
10.1] Change the nova user id on the TrilioVault Nodes
In RHOSP, 'nova' user id on nova-compute docker container is set to '42436'. The 'nova' user id on the TrilioVault nodes need to be set the same. Do the following steps on all TrilioVault nodes:
1.Download the shell script that will change the user id
2.Assign executable permissions
3.Execute the script
4.Verify that 'nova' user and group id has changed to '42436'
1
## Download the shell script
2
$ curl -O https://raw.githubusercontent.com/trilioData/triliovault-cfg-scripts/master/common/nova_userid.sh
3
​
4
## Assign executable permissions
5
$ chmod +x nova_userid.sh
6
​
7
## Execute the shell script to change 'nova' user and group id to '42436'
8
$ ./nova_userid.sh
9
​
10
## Ignore any errors and verify that 'nova' user and group id has changed to '42436'
11
$ id nova
12
   uid=42436(nova) gid=42436(nova) groups=42436(nova),990(libvirt),36(kvm)
Copied!
11] Troubleshooting for overcloud deployment failures
Trilio components will be deployed using puppet scripts.
oIn case of the overcloud deployment failing do the following command provide the list of errors.
The following document also provides valuable insights: https://docs.openstack.org/tripleo-docs/latest/install/troubleshooting/troubleshooting-overcloud.html​
1
openstack stack failures list overcloud
2
heat stack-list --show-nested -f "status=FAILED"
3
heat resource-list --nested-depth 5 overcloud | grep FAILED
4
​
5
=> If trilio datamover api containers does not start well or in restarting state, use following logs to debug.
6
​
7
​
8
docker logs trilio_dmapi
9
​
10
tailf /var/log/containers/trilio-datamover-api/dmapi.log
11
​
12
 
13
​
14
=> If trilio datamover containers does not start well or in restarting state, use following logs to debug.
15
​
16
​
17
docker logs trilio_datamover
18
​
19
tailf /var/log/containers/trilio-datamover/tvault-contego.log
Copied!