VMware Cloud Foundation 4.2 Offline Bundle

Share on:

Updated blog post on 6-7-2022

Please click here to see the new blog post that covers the new changes in the lcm-tool.

This blog post currently goes over how to use markerfile to download VCF bundle upgrades. With new LCM Tools that launched VCF 4.4.1 this process is no longer necessary.

Updated blog post on 3-4-2022 to include VMware Cloud Foundation 4.4 changes


While upgrading enviroments from 4.3 to 4.4 and deploying new VMware Cloud Foundation 4.4 enviroments. I found that “lcm-tools” was no longer bundled inside the SDDC Manager Appliance. After doing some research I noticed the VMware Doc for the offline bundle process had changed when going to version 4.4..

Recently I was assigined to a project within my company to deploy VMware Cloud Foundation 4.x within one of our dark sites. The team started researching updating VMware Cloud Foundation when deployed within dark site. We came across VMware doc that went over the process. Over the weekend I decided to deploy nested VMware Cloud Foudation within my home lab using Intel NUCs. Another blog post will go over in detail on how to deploy nested VMware Cloud Foundation on Intel NUCs.

This walkthrough will go over how to download lcm-tools, manifest file, and offline bundles needed to upgrade your dark site/disconnected VMware Cloud Foundation enviroment.

Prerequisites


You will need the following before continuing:

  • VMware Customer Connect account with an entitlement for VMware Cloud Foundation.
  • A endpoint (Linux or Windows) that has internet connectivity.
    • For this demo, I will be using a Windows workstation.
  • Java Runtime Environment Installed
    • Can be downloaded here
  • WinSCP Installed
    • Can be downloaded here
  • To upload the manifest file from a Windows computer, you must have OpenSSL installed and configured.
  • A process worked out with the security team in order to bring JSON and MD5 outside of your enviroment.

Uploading the Bundle Transfer Utility to SDDC Manager


Download the Bundle Transfer Utility

  1. Download the Bundle Transfer Utility on a computer with internet access.
    • Log in to VMware Customer Connect and browse to the Download VMware Cloud Foundation page.
    • In the Select Version field, select the version to which you are upgrading.
    • Click Drivers & Tools
    • Expand VMware Cloud Foundation Tools and click Go To Downloads.
    • Click Download Now for the Bundle Transfer Utility.

Uploading the Bundle Transfer Utility to SDDC Manager

  1. Transfer “lcm-tools-prod.tar.gz” you downloaded from step 1 to the computer with access to SDDC Manager Appliance.

  2. Copy the “lcm-tools-prod.tar.gz” to SDDC Manager Appliance.

Note: I will be using WinSCP to accomplish this task and I will be copying the “lcm-tools-prod.tar.gz” to /home/vcf/ on SDDC Manager Applaince.

How to connect to SDDC Manager using WinSCP

  1. Open WinSCP
  2. Set file protocol to “SCP”
  3. Provide the Hostname or IP to your SDDC Manager (example, sddc-manager.esx.lab)
  4. Port Number should be 22
  5. Username should be “vcf”
  6. Enter the password for “vcf” and press login

  1. SSH into the SDDC Manager applaince using “vcf” user account.

  2. Enter “su” to switch to the root user.

  3. Create the lcm-tools directory

mkdir /opt/vmware/vcf/lcm/lcm-tools

  1. Extract the “lcm-tools-prod.tar.gz” to the new “lcm-tools” directory.

tar -xvzf /home/vcf/lcm-tools-prod.tar.gz -C /opt/vmware/vcf/lcm/lcm-tools/

  1. After extracting “lcm-tools-prod.tar.gz” to the new “lcm-tools” directory will need to set the permissions.
1cd /opt/vmware/vcf/lcm/
2chown vcf_lcm:vcf -R lcm-tools
3chmod 750 -R lcm-tools
  1. After setting permissions on the “lcm-tools” directory, “exit” the “su” user

  1. Navigate to the /opt/vmware/vcf/lcm/lcm-tools/bin/ directory

  2. Validate that the utility version matches the target release. Run the following command to display the utility version:

./lcm-bundle-transfer-util -v

How to Generate the Marker File


SSH into SDDC Manager VM

You can either use openSSH client that is now built into Windows 10 since build 1803 or Putty

  1. Use the user name “vcf” and password

  1. Change directory to the following location:

cd /opt/vmware/vcf/lcm/lcm-tools/bin

  1. Run the following command to generate the marker file

From VMware “The marker file (named markerFile) is a JSON file that contains information on the current software versions running on SDDC Manager. It also contains the bundles IDs for bundles that were downloaded before this file was generated. The markerFile.md5 contains the checksum for the markerFile.”

1./lcm-bundle-transfer-util --generateMarker

If you see “Succesfully created Marker file: /home/vcf/markerFile and Marker MD5 file: /home/vcf/markerFile.md5” then generate command was executed succesfully.

Copy the markerfile from the internal SDDC Manager VM to the external workstation with Interent Connectivity

  1. Verify your in the “/home/vcf” directory after connecting to SDDC Manager via WinSCP.
  2. Copy the following files to a directory you created on your workstation (Example, c:\temp\vcf-upgrade) * markerFile * markerFile.MD5

  1. Copy the contents of the directory you created on the internal workstation to the external workstation with internet connectivity.

For this demo, we are going to assume I have the lcm-tools downloaded and the marker files have been copied outside of the dark site/disconnected environment.

Downloading the Manifest and Offline Bundles


Downloading the mainfest file on the interent connected workstation

This is a structured metadata file that contains information about the VMware product versions included in the release Bill of Materials.

  1. On the workstation with interent access. Run Powershell or Command Prompt as administrator.

  2. Chanage directory to the folder you copied over from the internal workstation.

  3. Change directory to the “bin” folder

  4. Type the following command: (Note it is case sensitive!)

    This part will require a MyVMware account that has entitlement for VMware Cloud Foundation.

1./lcm-bundle-transfer-util --download --manifestDownload --depotUser Username

Downloading offline bundle on the interent connected workstation

  1. On the workstation with interent access. Run Powershell or Command Prompt as administrator.

  2. Chanage directory to the folder you copied over from the internal workstation.

  3. Change directory to the “bin” folder

  4. Type the following command: (Note it is case sensitive!)

    This part will require a MyVMware account that has entitlement for VMware Cloud Foundation. (Note if you have VxRail –pdu or –partnerDepotUser switch would be added.)

1.\lcm-bundle-transfer-util --download --outputDirectory C:\temp\VCF-Demo\ --depotUser 'MyVMware Account' --markerFile C:\temp\VCF-Demo\markerFile --markerMd5File C:\temp\VCF-Demo\markerFile.md5
  1. Type in your MyVMware password

  2. Verify the files and versions being downloaded

  3. Type in “y” to continue

  4. The tool should start downloading the files needed

  5. You should see the following output after the download has completed.

Uploading and Importing the mainfest file on the SDDC Manager


Uploading the manifest file to SDDC Manager

  1. Open WinSCP and connect to the SDDC Manager VM
  2. Change directory in WinSCP
1/home/vcf/
  1. Copy the manifest file you downloaded into a directory (Ex. /home/vcf/) on the SDDC Manager
1lcmManifestv1.json

Importing the manifest file

  1. SSH into SDDC Manager VM
  2. Change directory to the following
1cd /opt/vmware/vcf/lcm/lcm-tools/bin
  1. Run the following command:
1./lcm-bundle-transfer-util --update --sourceManifestDirectory Manifest-Downloaded-Directory --sddcMgrFqdn "SDDC Manager FQDN" --sddcMgrUser administrator@vsphere.local
2

  1. Wait for the tool to validate the manifest file

  2. You should see the following output when the process is completed.

Verify manifest import within the SDDC Manager client

  1. Log into SDDC Manager client using a web browser.
1https://sddc-manager.esx.lab
  1. Go to “Devloper Center”

  2. Select “API Explorer” and “APIs for managing LCM Manifest”

  1. Expand “GET” and Select “Execute”

  2. Under Response select “Manifest” and review the output to verify the manifest was uploaded.

Thats it! You have succesfully imported the manifest file into SDDC manager.

Uploading and Importing the offline bundles on the SDDC Manager


Uploading the update bundle to the SDDC Manager VM

For this demo, we are going to assume I have already copied the update bundle back into dark site environment.

  1. Open WinSCP and connect to the SDDC Manager VM
  2. Change directory in WinSCP
1/nfs/vmware/vcf/nfs-mount/
  1. Create a folder (example, VCF_Offline_Upload)
  2. Copy the following contents you downloaded into new directory created on the SDDC Manager
1  ├── bundles (Folder)
2  ├── manifests (Folder)
3  ├── tmp (folder)
4  ├── deltafileDownloaded
5  ├── deltafileDownloaded.md5
6  ├── index.v3

In the SDDC Manager VM, change ownership and permissions of the uploaded bundle

  1. SSH into SDDC Manager VM
  2. Run the following command:
1chmod -R 0777 /nfs/vmware/vcf/nfs-mount/folderyoucreated

In the SDDC Manager VM, import the update bundle

  1. SSH into SDDC Manager VM
  2. Change directory to the following
1cd /opt/vmware/vcf/lcm/lcm-tools/bin
  1. Run the following command:
1./lcm-bundle-transfer-util -upload -bundleDirectory /nfs/vmware/vcf/nfs-mount/folderyoucreated

  1. Wait for the tool to validate all the files. This may take awhile * Note you can see the import process if you log into the SDDC Manager mangement interface.

Wait for all bundles to be uploaded before proceeding with the upgrade.

  1. You should see the following output when the process is completed.

Verify import within the SDDC Manager client

  1. Log into SDDC Manager client using a web browser.
1https://sddc-manager.esx.lab
  1. Go to “Lifecyle Management” and select “Bundle Management”

  2. You should see the applicable bundles for your environment inside Lifecyle Management. Clicking on download history will show all of the compoments that have been imported.

Thats it! You have succesfully imported offline bundles into SDDC manager.

Sources

Offline Bundle Download for VMware Cloud Foundation

Deep dive into VMware Cloud Foundation – Part 1 Building a Nested Lab