Skip to main content
Keystone

Deploy Keystone Collector on VMware vSphere systems

Contributors netapp-manini netapp-shwetav netapp-bcammett
PDFs

Deploying Keystone Collector on VMware vSphere systems includes downloading the OVA template, deploying the template by using the Deploy OVF Template wizard, verifying the integrity of the certificates, and verifying the readiness of the VM.

Deploying the OVA template

Follow these steps:

Steps

  1. Download the OVA file from this link and store it on your VMware vSphere system.

  2. On your VMware vSphere system, navigate to the VMs and Templates view.

  3. Right click on the required folder for the virtual machine (VM) (or data center, if not using VM folders) and select Deploy OVF Template.

  4. On Step 1 of the Deploy OVF Template wizard, click Select and OVF template to select the downloaded KeystoneCollector-latest.ova file.

  5. On Step 2, specify the VM name and select the VM folder.

  6. On Step 3, specify the required compute resource that is to run the VM.

  7. On Step 4: Review details, verify the correctness and authenticity of the OVA file.
    vCentre versions prior to 7.0u2 are unable to automatically verify the authenticity of the code signing certificate. vCentre 7.0u2 and later can perform the verifications, however, for this, the signing certificate authority should be added to vCentre. Follow these instructions for your version of vCentre:

    vCentre 7.0u1 and earlier: Learn more

    vCentre validates the integrity of the OVA file contents and that a valid code-signing digest is provided for the files contained in the OVA file. However, it does not validate the authenticity of the code-signing certificate. For verifying the integrity, you should download the full signing digest certificate, and verify it against the public certificate published by Keystone.

    1. Click the Publisher link to download the full signing digest certificate.

    2. Download the Keystone Billing public certificate from this link.

    3. Verify the authenticity of the OVA signing certificate against the public certificate by using OpenSSL:
      openssl verify -CAfile OVA-SSL-NetApp-Keystone-20221101.pem keystone-collector.cert

    vCentre 7.0u2 and later: Learn more

    7.0u2 and later versions of vCenter are capable of validating the integrity of the OVA file contents and the authenticity of the code-signing certificate, when a valid code-signing digest is provided. The vCenter root trust store contains only VMware certificates. NetApp uses Entrust as a certifying authority, and those certificates need to be added to the vCenter trust store.

    1. Download the code-signing CA certificate from Entrust here.

    2. Follow the steps in the Resolution section of this knowledge base (KB) article: https://kb.vmware.com/s/article/84240.

    When the integrity and authenticity of the Keystone Collector OVA are validated, you can see the text (Trusted certificate) with the publisher.
    OVA UI displaying a verified certificate

  8. On Step 5 of the Deploy OVF Template wizard, specify the location for storing the VM.

  9. On Step 6, select the destination network for the VM to use.

  10. On Step 7 Customize template, specify the initial network address and password for the admin user account.

    Note The admin password is stored in a reversible format in vCentre and should be used as a bootstrap credential to gain initial access to the VMware vSphere system. During the initial software configuration, this admin password should be changed. The subnet mask for the IPv4 address should be supplied in CIDR notation. For example, use the value of 24 for a subnet mask of 255.255.255.0.

  11. On Step 8 Ready to complete of the Deploy OVF Template wizard, review the configuration and verify that you have correctly set the parameters for the OVA deployment.

After the VM has been deployed from the template and powered on, open an SSH session to the VM and log in with the temporary admin credentials to verify that the VM is ready for configuration.

Initial system configuration

Perform these steps on your VMware vSphere systems for an initial configuration of the Keystone Collector servers deployed through OVA:

Note On completing the deployment, you can use the Keystone Collector Management Terminal User Interface (TUI) utility to perform the configuration and monitoring activities. You can use various keyboard controls, such as the Enter and arrow keys, to select the options and navigate across this TUI.

  1. Open an SSH session to the Keystone Collector server. When you connect, the system will prompt you to update the admin password. Complete the admin password update as required.

  2. Log in using the new password to access the TUI. On login, the TUI appears.

    Alternatively, you can launch it manually by running the keystone-collector-tui CLI command.

  3. If required, configure the proxy details in the Configuration > Network section on the TUI.

  4. Configure the system hostname, location, and NTP server in the Configuration > System section.

  5. Update the Keystone Collectors using the Maintenance > Update Collectors option. After the update, restart the Keystone Collector management TUI utility to apply the changes.