Lucene search

K
veeamVeeam softwareVEEAM:KB4226
HistoryOct 17, 2021 - 12:00 a.m.

How to Connect to an Object Storage Repository via AWS Privatelink / Direct Connect

2021-10-1700:00:00
Veeam software
www.veeam.com
17
veeam backup
aws privatelink
storage repository

AI Score

6.8

Confidence

High

Purpose

"This article documents the configuration of Veeam Backup & Replication for using AWS PrivateLink or AWS Direct Connect. These services enable Scale-Out Backup Repository offload to Capacity Tier or Archive Tier, as well as the connection to an Object Storage Repository, without the use of public endpoints.

The instructions are applicable to Veeam Backup & Replication version 12 or newer.

Solution

Prepare the AWS Environment

  1. _(If using AWS Direct Connect, skip to step 2.)
    _For AWS PrivateLink, configure a VPN connection to the VPC where you plan to deploy the PrivateLink Endpoint. One of the ways to do this is to create a tunnel on the VM gateway using AWS Client VPN.

  2. Create Endpoints in VPC:
    1. Create an S3 Interface Endpoint in your VPC. It will be assigned a DNS name that you can see in the AWS Console under VPC - Endpoints when selecting the corresponding Endpoint.
    2. An EC2 Endpoint must also be created if intending to use Archive Tier.

Prepare the Veeam Backup & Replication Environment

  1. Disable automatic updating of the AmazonS3Regions.xml file by creating the following registry value on the Veeam Backup Server.
    This will prevent Veeam Backup & Replication from overwriting the changes you’ll make in the next section of this guide.

**Key Location:**HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\
**Value Name:**CloudRegionsDisableUpdate
**Value Type:**DWORD (32-Bit) Value
**Value Data:**1


AmazonS3Regions.xml Overwritten During Product Update

The ‘CloudRegionsDisableUpdate’ registry value only disables Veeam Backup & Replication performing its daily check and update of the AmazonS3Regions.xml file.

This registry value** does not** prevent that file from being overwritten by an updated version of that file contained within and deployed by a product update.

You should keep a copy of your modified AmazonS3Regions.xml in a safe place so that you can restore it if a product update reverts the custom changes you make.

  1. Disable certificate revocation checks by creating the following setting on the machine that is assigned as the Gateway server within the Object Storage Repository settings:
    * For Windows-based Gateway servers, create the following registry value:** **
    **Key Location:**HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\
    **Value Name:**ObjectStorageTlsRevocationCheck
    **Value Type:**DWORD (32-Bit) Value
    **Value Data:**0
* For Linux-based Gateway servers, add the following entry to the ****/etc/VeeamAgentConfig**If the /etc/VeeamAgentConfig file is not present, it must be created.****** file:  

    
            ObjectStorageTlsRevocationCheck=0

Note: Prior to Veeam Backup & Replication 12, this setting was named S3TLSRevocationCheck.
5. To configure the Helper Appliance used for Object Storage Repository Health Checks to use the private IP address, add the following registry value on the Veeam Backup Server:

Key Location: HKLM\SOFTWARE\Veeam\Veeam Backup and Replication **Value Name: **ArchiveUsePrivateIpForAmazonHelperAppliance **Value Type: **DWORD (32-Bit) Value **Value Data: **1

1 = Enable Archive Appliance use Private IP | 0 = Disable (Default)
6. If you plan to use Amazon Glacier for Archive Tier, review the following:
* Certificate revocation checks must be permitted. The Veeam Backup Server and the VPC where the Archiver Appliance is deployed must have access to certificate revocation lists used by AWS over port 80 (*.amazontrust.com).
* The following additional registry values must be created on the Veeam Backup Server:
* **Key Location:**HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\
**Value Name:**ArchiveFreezingUsePrivateIpForAmazonAppliance
**Value Type:**DWORD (32-Bit) Value
**Value Data:**1
* **Key Location:**HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\
**Value Name:**ArchiveFreezingSkipProxyValidation
**Value Type:**DWORD (32-Bit) Value
**Value Data:**1

Modify the AmazonS3Regions.xml File


This Affects All Traffic to the Modified Region

The AmazonS3Regions.xml file contains a list of regions and their respective endpoints. Modifying a region’s endpoints makes it possible to force Veeam Backup & Replication to connect to a specific endpoint when that region is selected in the UI. This modification will cause all tasksthat utilize the region you modify to employ the customized S3 and EC2 endpoints. If you wish to avoid interference, consider altering a region that other tasks or objects in Veeam Backup & Replication are not using. Then, use that altered region exclusively when you want to direct traffic to use the custom endpoints.

  1. On the Veeam Backup Server, edit C:\Program Files\Veeam\Backup and Replication\Backup\AmazonS3Regions.xml
  2. Find the Region section corresponding to your PrivateLink or Direct Connect location.

Example:

     <Region Id="ap-northeast-1" Name="Asia Pacific (Tokyo)" Type="Global">
  1. Within that region’s section, find the line <Endpoint Type=“s3”> and replace the existing DNS value with the S3 Interface Endpoint DNS created in Prepare the AWS Environment > Step 2.

_Note: For S3, the AWS console will display a DNS value starting with an asterisk. When altering the AmazonS3Regions file, replace that asterisk with the word bucket.
_
Example:

    &lt;Endpoint Type="S3"&gt;s3-ap-northeast-1.amazonaws.com&lt;/Endpoint&gt;

Is changed to:

    &lt;Endpoint Type="S3"&gt;**bucket**.vpce-00000000000000000-00000000.s3.ap-northeast-1.vpce.amazonaws.com&lt;/Endpoint&gt;
  1. If multiple lines for <Endpoint Type=“S3”> are in the Region section you are altering, remove all but the one you changed.

Example:

    &lt;Region Id="ap-northeast-1" Name="Asia Pacific (Tokyo)" Type="Global"&gt;
&lt;Endpoint Type="S3"&gt;bucket.vpce-00000000000000000-00000000.s3.ap-northeast-1.vpce.amazonaws.com&lt;/Endpoint&gt;
~~&lt;Endpoint Type="S3"&gt;s3.dualstack.ap-northeast-1.amazonaws.com&lt;/Endpoint&gt;~~
  1. If you plan to use Archive Tier: Within the same Region section, find the line <Endpoint Type=“EC2”> and replace the existing DNS value with the EC2 Endpoint DNS created in Step 2.

Example:

    &lt;Endpoint Type="EC2"&gt;ec2.ap-northeast-1.amazonaws.com&lt;/Endpoint&gt;

Is changed to:

    &lt;Endpoint Type="EC2"&gt;vpce-00000000000000000-00000000.ec2.ap-northeast-1.vpce.amazonaws.com&lt;/Endpoint&gt;
  1. Save the file.

before edits.

Before Changes

After change example

After Adding Custom S3 and EC2 Endpoint

  1. Stop all tasks within Veeam Backup & Replication and restart the Veeam Backup Service to apply all changes.

Add Object Storage Repository

Now that the AmazonS3Regions.xml file has been modified, when you select the entry you changed within Veeam Backup & Replication, the software will connect to the specified endpoints.

More Information

Related Articles:

To submit feedback regarding this article, please click this link: Send Article Feedback
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.

Affected configurations

Vulners
Node
veeamveeam_backup_\&_replicationMatch12.2
OR
veeamveeam_backup_\&_replicationMatch12.1
OR
veeamveeam_backup_\&_replicationMatch12
VendorProductVersionCPE
veeamveeam_backup_\&_replication12.2cpe:2.3:a:veeam:veeam_backup_\&_replication:12.2:*:*:*:*:*:*:*
veeamveeam_backup_\&_replication12.1cpe:2.3:a:veeam:veeam_backup_\&_replication:12.1:*:*:*:*:*:*:*
veeamveeam_backup_\&_replication12cpe:2.3:a:veeam:veeam_backup_\&_replication:12:*:*:*:*:*:*:*

AI Score

6.8

Confidence

High