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.
cd triliovault-cfg-scripts/redhat-director-scripts/<RHOSP_RELEASE_DIRECTORY>/
Copied!
The TrilioVault appliance connected to this installation needs to be of version 4.1 HF4
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
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp16/
Copied!
RHOSP 16.1
1
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/
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'
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.
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.
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!
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.
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'
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. Populate the trilio_env.yaml with TrilioVault container image URLs:
TrilioVault Datamover container
TrilioVault Datamover api container
TrilioVault Horizon Plugin
trilio_env.yaml will be available in
1
cd triliovault-cfg-scripts/redhat-director-scripts/rhosp16.1/
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/
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:
## S3 region, if your s3 does not have any region, just keep the parameter as it is
46
S3RegionName: ''
47
​
48
## S3 bucket name
49
S3Bucket: ''
50
​
51
## S3 endpoint url, not required for Amazon S3, keep it as it is
52
S3EndpointUrl: ''
53
​
54
## S3 signature version
55
S3SignatureVersion: 'default'
56
​
57
## S3 Auth version
58
S3AuthVersion: 'DEFAULT'
59
​
60
## 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'
61
S3SslEnabled: False
62
​
63
## If S3 backend is not Amazon S3 and SSL is enabled on S3 endpoint URL and SSL certificates are self signed, then
64
## user need to set this parameter value to: '/etc/tvault-contego/s3-cert.pem', otherwise keep it's value as empty string.
65
S3SslCert: ''
66
​
67
## Don't edit following parameter
68
EnablePackageInstall: True
Copied!
6. Advanced Settings/Configuration
6.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.
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)
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.
8.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.
26fcb9194566 rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-datamover-api:4.1.94-hotfix-5-rhosp16.1 kolla_start 5 days ago Up 5 days ago trilio_dmapi
3
094971d0f5a9 rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-horizon-plugin:4.1.94-hotfix-5-rhosp16.1 kolla_start 5 days ago Up 5 days ago horizon
b1840444cc59 rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-datamover:4.1.94-hotfix-5-rhosp16.1 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.
094971d0f5a9 rhosptrainqa.ctlplane.localdomain:8787/trilio/trilio-horizon-plugin:4.1.94-hotfix-4-rhosp16.1 kolla_start 5 days ago Up 5 days ago horizon
Copied!
9] Additional Steps on TrilioVault Appliance
9.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'