Background
This document will guide you through the upgrade of a Virtru Gateway.
Requirements
This document assumes that you have a fully functioning Gateway.
Quick upgrade to version latest version listed on our release notes page:
Update Yaml
Edit the setup script(s) (Standard Gateway) Check here first for latest version number
If using the standard image, use:
containers.virtru.com/gateway:v<version-number>
Or
Note:
If using the FIPS-validated image, use:
containers.virtru.com/gateway-fips:v<version-number>
In the Chart.yaml
file, the version for the Gateway is dictated in the chart version
and the appVersion
values.
Refer to our Release Notes for the latest Gateway version (for the appVerison) number (example: appVersion: v2.42.0
). Once you have updated the version number within the Chart.yaml
file, redeploy the helm charts and check that your cluster is now running the most recent version.
To find the latest helm chart version, run:
- Update Your Helm Repos:
helm repo update
- Search for the Specific Chart:
Search for the available Helm charts in the virtru-charts repository. In this case, you are likely looking for the Gateway chart:helm search repo virtru-charts/gateway
This will give you the available versions of the gateway chart.
- Pull the Chart and Extract yaml file to update:
Once you have identified the correct chart (based on the latest version or the one you're currently using), you can pull the chart to get its files, including the chart.yaml or values.yaml. Use the --untar option to extract the chart contents (including values.yaml) to a local directory:
This will create a directory named gateway (or whatever chart you're pulling) with the chart yaml files.helm pull virtru-charts/gateway --untar
- Modify the yaml file i.e., Chart.yaml or values.yaml:
Now, navigate to the directory and open the chart.yaml file for editing:cd gateway
nano Chart.yaml
# Set appVersion to the latest version
appVersion: v<version-number>
Make the necessary updates/changes to the yaml file. i.e. change the app version number to the most recent
-
Apply the Changes:
After editing the Chart.yaml, redeploy the Helm release with the updated configuration:helm upgrade -n virtru -f ./Chart.yaml virtru ./
This command will upgrade your release using the updated values.yaml file, and your changes will be applied to the running pods.
Additional Configuration
If the chart files are not available in your local directory, you'll need to locate or export the current configuration. Follow these steps:
- Export the yaml file from Helm
Retrieve the existing yaml file i.e, values.yaml used by the release with the following command:helm get values gateway -n virtru > new-values.yaml
This will export the existing values into a file namenew-values.yaml
You can edit this file and apply the changes (See step 5). - Gateway Configuration Document
Refer to standard documentation for Gateway configuration. You can get your endpoints to set as smart hosts by running the following command:kubectl -n virtru get services
And there should be public endpoints you can use when relaying mail to your new gateways.
Post-Deployment
After successfully deploying the Virtru Private Keystore, monitor the status of your pods to ensure they are running correctly. Use kubectl
commands to check pod statuses and review logs for any errors or warnings.
To list the pods enter the command below:
kubectl get pods -n virtru
helm list -n virtru
kubectl logs <pod-name> -f -n virtru
To view the versions or image details of the containers running your pods:
kubectl get pods -n virtru -o wide
kubectl describe pod <pod-name> -n virtru