action.skip

Installing in IBM Cloud

Use this procedure to install the Zenoss Cloud Collector virtual appliance as an IBM Virtual Infrastructure instance in the IBM Cloud platform.

Note

The virtual appliance image for IBM Cloud is compatible with the VPC Infrastructure only; Classic Infrastructure is not supported.

Prerequisites

To perform this task, you need an IBM Cloud account with permissions to access the IBM Cloud Catalog and create virtual machines in the VPC Infrastructure.

Installing the collector

Note

The virtual appliance image for IBM Cloud is available in the us-east and us-south zones. To use the appliance in other regions, please contact your Zenoss representative.

  1. Log in to IBM Cloud as a user with permission to access the IBM Cloud Catalog and create virtual machines in the VPC Infrastructure.

  2. Navigate to the IBM Cloud Catalog, and then search for "Zenoss Cloud Collector".

  3. Click on the Zenoss Cloud Collector card.

  4. From the Select a version list, select the version for your region.

    Version names begin with the date they were built and end with the region in which they are valid. Always choose the most recent version and the correct region for your deployment.

  5. In the bottom-right corner, click Continue.

  6. On the Virtual server for VPC page, specify the server.

    1. In the Server type area, specify the type.

      • For Architecture, select Intel.
      • For Hosting type, select Public.
    2. In the Location area, ensure that the Region and Zone settings match the region associated with the version you selected in step 4.

      Note

      IBM Cloud does not select a region automatically. Once you do so, IBM Cloud switches the operating system setting to the operating system of the Zenoss Cloud Collector image.

    3. In the Details area, enter a name for your server.

    4. Leave the settings in the Operating system area unchanged.

    5. In the Profile area, select a bx2-4x16 instance or a larger instance.

      Zenoss Cloud Collector requires a minimum of 4 CPUs, 16GB RAM, and a boot volume.

    6. In the SSH keys area, select an existing key or create a new key.

      The key you specify in this step becomes the default key for the ccuser account.

    7. (Optional) In the Advanced options area, add DNS search domains or SSH keys.

      • Enable the Metadata option.

      • In the User data (optional) area, paste or import a JSON object that specifies the search domains or SSH keys.

        For more information, see the user data example.

      Note

      IBM Cloud does not allow you to change user data after initialization. However, you can use the Zenoss Collector Appliance TUI to change the settings after the virtual machine is running. See Optional DNS search domains or SSH keys for more information.

    8. In the remaining areas, specify options as desired.

  7. In the right column, click Create virtual server.

  8. Gain access to the new virtual machine.

    Use the SSH key pair generated during installation to log in to the ccuser account:

    ssh ccuser@<PUBLIC_IP_ADDRESS> -i <PATH_TO_SSH_PRIVATE_KEY>
    

Optional: Set additional DNS search domains or SSH keys

You can customize DNS resolution for your virtual machine and grant access to additional users. The following options are supported:

  • Additional DNS forwarding/DNS search domain entries
  • A default resolver other than the one provided by IBM Cloud
  • Additional SSH public keys

Example

For example, you wish to enable the following options for your virtual machine:

  • Forward DNS queries for *.example.com and *.example.org to the 203.0.113.4 and 203.0.113.5 resolvers
  • Forward DNS queries for *.myorg.example.net to the 198.51.100.253 resolver
  • Forward all other queries to the 192.0.2.2 and 192.0.2.3 resolvers
  • Grant access to the private SSH keys associated with public_key1 and public_key2 (through the ccuser account)

To configure the options, create the following JSON object:

{
    "dns-forwarding": [
        {
            "dns-search": ["example.com", "example.org"],
            "dns-servers": ["203.0.113.4", "203.0.113.5"]
        },
        {
            "dns-search": ["myorg.example.net"],
            "dns-servers": ["198.51.100.253"]
        }
    ],
    "dns-default-servers": ["192.0.2.2", "192.0.2.3"],
    "sshkeys": [ "public_key1", "public_key2"]
}

Then, from the Zenoss Collector Administration > Userdata menu, adjust the contents to match the new JSON object.

Next step

Connect to a Collection Zone (Initializing a collector appliance).