This site will be decommissioned on December 31st 2024. After that date content will be available at techdocs.broadcom.com.

If you have deployed VMware Data Services Manager in an air-gapped environment, an environment with no internet connectivity, you are responsible for manually checking for updates and populating new database templates and software updates in the Provider Repo.

You are required to periodically check VMware Tanzu Network for new VMware Data Services Manager database templates and updates. If any new database templates or software updates are available, you must download the Air-gap Environment Repository distributed in the release and manually populate the Provider Repo, preserving the existing directory structure.

Step 1: Examine Tanzu Network and download a new VMware Data Services Manager release.

Step 2: Populate the Provider Repo.

Step 3: Populate the Provider Repo to upgrade.

Examining Tanzu Network and Downloading a New Release

The database templates and software updates in a VMware Data Services Manager release are available as a separate, single download from VMware Tanzu Network. The download file is a .zip file that unpacks to the required Provider Repo directory structure.

Perform these steps to download the air-gapped deliverable:

  1. Navigate to VMware Data Services Manager on VMware Tanzu Network, locate and select Air-gap Environment Repository, and download the file.

    The format of the download file name is:

    air_gap_deliverables.zip
    
  2. Make note of the directory to which the file was downloaded.

Populating the Provider Repo

You must populate the Provider Repo bucket with the contents of the air_gap_deliverables.zip file that you downloaded from Tanzu Network, retaining the existing directory structure.

Note: The Provider expects that the zip file is unpacked, as-is, in the root level of the bucket. Do not introduce intermediate folders or change the directory structure.

Prerequisites

Before you begin populating the Provider Repo, ensure that you:

  • Have created and can identify the name of the bucket configured for the repo.
  • Have the keys to the S3-compatible object storage on hand.
  • Have access to a CLI or GUI fronting the S3 repository.

Procedure

After you have downloaded the air_gap_deliverables.zip file from the VMware Tanzu Network, perform the following procedure to unpack the file into the Provider Repo:

  1. Recall the file system location of the downloaded air_gap_deliverables.zip file.

  2. Unpack the file locally:

    user@host$ mkdir airgap
    user@host$ cd airgap
    user@host$ unzip <path_to_file>/air_gap_deliverables.zip
    

    The command unpacks the database templates, software updates, and supporting files for the VMware Data Services Manager release to the current working directory.

  3. Copy the unpacked files to the Provider Repo bucket:

    • For example, if you are using a CLI and your Provider Repo is in AWS:

      user@host$ cd ..
      user@host$ aws s3 cp --recursive ./airgap/ s3://<bucket_name>/
      

      To be able to connect to AWS S3, configure AccessKeyId and SecretAccessKey on your local computer.

      In certain cases, you might need to define an endpoint-url to be able to copy files to S3:

      user@host$ aws s3 cp --recursive ./airgap/ s3://<bucket_name>/ --endpoint-url https://<ip_address>> --no-verify-ssl
      
    • If you are using a GUI front-end, use the tool to copy the files.

  4. Verify that the S3 bucket includes the following files and directories:

     dsm-control-plane/
     dsm-data-plane/
     manifests/
    

Base Release Example

When you populate folders for the base 2.0 release, folder and file structure of the manifest looks similar to the following.

dsm-control-plane
- dsm-provider-va-2.0.0.XXXX-XXXXXXXX_updaterepo.zip
dsm-data-plane
- 2.0.0-image-bundle-image-bundle-2.0.0-X-XXXXXXXX.zip
manifests
- 2.0.0-release.json
- dsm-control-plane
  - 2.0.0.XXXX-provider-appliance-release-manifest.json
  - tag-details.json. 
- dsm-data-plane
  - 2.0.0-dsm-dataplane-manifest.yaml

Populating the Provider Repo to Upgrade

You must populate the Provider Repo bucket with the contents of the air_gap_deliverables.zip file that you downloaded from Tanzu Network, retaining the existing directory structure.

Note: The Provider expects that the zip file is unpacked, as-is, in the root level of the bucket. Do not introduce intermediate folders or change the directory structure.

Prerequisites

Before you begin populating the Provider Repo, follow these prerequisites:

  • When upgrading from version 2.0.1 to 2.0.2, enable Data Services Release (DSR) in your 2.0.1 environment before installing the 2.0.2 control plane.
  • You have created and can identify the name of the bucket configured for the repo.
  • You have the keys to the S3-compatible object storage on hand.
  • You have access to a CLI or GUI fronting the S3 repository.

Procedure

After you have downloaded the air_gap_deliverables.zip file from the VMware Tanzu Network, perform the following procedure to unpack the file into the Provider Repo:

  1. Copy the contents of dsm-control-plane/, dsm-data-plane/, and manifests/ directories of the new release and place it in the corresponding directories in the Provider Repo.

  2. (Optional) After all the appliances and databases are updated to the new release version, delete the files of the old release from corresponding directories in the Provider Repo.

The new software will be visible and available to the Provider when it next checks for updates. The updates are checked every 8 hours starting from the first installation according to the NTP server configured for the Provider VM. For manual upgrades, see Checking for Upgrades to the DSM Plugin.

Ensure that none of the artifacts related to the current release are deleted while deleting files of the older release from the directories in the Provider Repo.

Upgrade Example

When you populate folders to update the base 2.0 release, folder and file structure looks similar to the following.

dsm-control-plane
- dsm-provider-va-2.0.0.XXXX-XXXXXXXX_updaterepo.zip
- dsm-provider-va-2.0.1.XXXX-XXXXXXXX_updaterepo.zip
- dsm-provider-va-2.0.2.XXXX-XXXXXXXX_updaterepo.zip
dsm-data-plane
- 2.X.X-image-bundle-image-bundle-2.X.X-X-XXXXXXXX.zip
manifests
- 2.0.0-release.json
- 2.X.X-release.json
- dsm-control-plane
  - 2.0.0.XXXX-provider-appliance-release-manifest.json
  - 2.X.X.XXXX-provider-appliance-release-manifest.json
  - tag-details.json
- dsm-data-plane
  - 2.0.0-dsm-dataplane-manifest.yaml
  - 2.X.X-dsm-dataplane-manifest.yaml

Troubleshooting Guidelines

If you experience problems when deploying VMware Data Services Manager in the air-gapped environment, verify the following in the S3 bucket:

  • The folder structure includes dsm-control-plane, dsm-data-plane, and manifests.

  • The manifests folder has the <release-version>-release.json file, and the dsm-control-plane and dsm-data-plane folders.

  • The dsm-control-plane and dsm-data-plane folders have the 2.0.0.XXXX-provider-appliance-release-manifest.json and 2.0.0-dsm-dataplane-manifest.yaml files respectively.

If the problems persists, contact the administrator.

check-circle-line exclamation-circle-line close-line
Scroll to top icon