Skip to main content
Skip table of contents

Create a VM Template

Create a vSphere Template for Your Cluster from a Base OS Image

Using the base OS image created in a previous procedure, DKP creates the new vSphere template directly on the vCenter server.

  1. Set the following vSphere environment variables on the bastion VM host:

    export VSPHERE_SERVER=your_vCenter_APIserver_URL
    export VSPHERE_USERNAME=your_vCenter_user_name
    export VSPHERE_PASSWORD=your_vCenter_password


  2. Copy the base OS image file created in the vSphere Client to your desired location on the bastion VM host, and make a note of the path and file name.

  3. Create an image.yaml file and add the following variables for vSphere. DKP uses this file and these variables as inputs in the next step.
    NOTE: You will need to replace OS name below based on your OS - EX: “rhel-79” to “rhel-86”. See other YAML examples for copy and paste below last step.

    download_images: true
    build_name: "rhel-79"
    packer_builder_type: "vsphere"
    guestinfo_datasource_slug: ""
    guestinfo_datasource_ref: "v1.4.0"
    guestinfo_datasource_script: "{{guestinfo_datasource_slug}}/{{guestinfo_datasource_ref}}/"
      cluster: ""
      datacenter: ""
      datastore: ""
      folder: ""
      insecure_connection: "false"
      network: ""
      resource_pool: ""
      template: "base-rhel-7.9" # change default value with your base template name
      vsphere_guest_os_type: "rhel7_64Guest"
      guest_os_type: "rhel7-64"
      # goss params
      distribution: "RHEL"
      distribution_version: "7.9"
    # Use following overrides to select the authentication method that can be used with base template
    # ssh_username: ""  # can be exported as environment variable 'SSH_USERNAME'
    # ssh_password: "" # can be exported as environment variable 'SSH_PASSWORD'
    # ssh_private_key_file = "" # can be exported as environment variable 'SSH_PRIVATE_KEY_FILE'
    # ssh_agent_auth: false  # if set to true, ssh_password and ssh_private_key will be ignored

  4. Create a vSphere VM template with your variation of the following command:

    konvoy-image build images/ova/<image.yaml>

    Any additional configurations can be added to this command using --overrides flags as shown below:

    1. for FIPS, add this flag - --overrides overrides/fips.yaml

    2. for air-gapped, add this flag --overrides overrides/offline-fips.yaml

  5. The Konvoy Image Builder (KIB) uses the values in image.yaml and the input base OS image to create a vSphere template directly on the vCenter server. This template contains the required artifacts needed to create a Kubernetes cluster.
    When KIB provisions the OS image successfully, it creates a manifest file. The artifact_id field of this file contains the name of the AMI ID (AWS), template name (vSphere), or image name (GCP/Azure), for example:

          "name": "vsphere-clone",
          "builder_type": "vsphere-clone",
          "build_time": 1644985039,
          "files": null,
          "artifact_id": "konvoy-ova-vsphere-rhel-84-1.21.6-1644983717",
          "packer_run_uuid": "260e8110-77f8-ca94-e29e-ac7a2ae779c8",
          "custom_data": {
            "build_date": "2022-02-16T03:55:17Z",
            "build_name": "vsphere-rhel-84",
            "build_timestamp": "1644983717",

  6. Next steps are to deploy a DKP cluster using your vSphere template.

Next, create a Kubernetes Bootstrap Cluster to enable creating your vSphere cluster and moving CAPI objects to it.

YAML Files found in Konvoy Image Builder section.

Next Step:

vSphere Bootstrap

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.