Configure IBM Cloud

Configuring IBM Cloud is a four-step process:

Add IBM Cloud

To add an IBM Cloud cloud follow these steps.

  1. Navigate to Admin > Clouds. This brings you to the Clouds page. If you, or another tenant admin in your tenant, have already added clouds to your tenant, they will be listed here. Click the Add Cloud link in the upper right.

  2. After clicking Add Cloud, the Add Cloud dialog box is displayed. Enter the cloud name, select the cloud provider, and then click Next

  3. After clicking Next, the second page of the Add Clouds dialog box, Connectivity Settings, appears. Set the toggle switches to configure the Cloud Connectivity settings.

    • When adding a public VM cloud in the CloudCenter Suite UI, the Cloud Connectivity Settings page, the second page of the Add Cloud dialog box, appears with a single toggle displayed: Worker VMs Directly Connect with CloudCenter Suite.

    • Setting this toggle to No implies you will install Cloud Remote for each region of this cloud. This also causes a second toggle to appear: CloudCenter Suite Directly Accessible from Cloud Remote. 

    • Follow the table below for guidance on setting these toggles.

      Toggle settingsUse case

      Diagram

      Worker VMs Directly Connect with CloudCenter Suite = YesUnimpeded connectivity exists between the CloudCenter Suite cluster and the cloud region API endpoint
      AND
      Unimpeded connectivity exists between the CloudCenter Suite cluster and worker VMs

      Cloud Remote is not required



      Worker VMs Directly Connect with CloudCenter Suite = No
      AND
      CloudCenter Suite Directly Accessible from Cloud Remote = Yes

      Worker VMs need to communicate to the CloudCenter Suite cluster through Cloud Remote
      AND
      Cloud Remote can initiate the connection to the CloudCenter Suite cluster


      Worker VMs Directly Connect with CloudCenter Suite = No
      AND
      CloudCenter Suite Directly Accessible from Cloud Remote = No

      Worker VMs need to communicate to the CloudCenter Suite cluster through Cloud Remote
      AND
      the CloudCenter Suite cluster cannot receive a connection initiated by Cloud Remote

      Note

      The connectivity toggle settings set at the cloud level are inherited by each region you add to this cloud. However, it is possible to override these toggle settings on a per region basis from the Regions tab for each region.


  4. Click Done to save the configuration and close the dialog box.  This brings you back to the Clouds page and the cloud you just created will be added to the bottom of the list on the left side of the page.

Add an IBM Cloud Region

After creating an IBM Cloud cloud, the next step is to create the first region for the cloud. Follow these steps.

  1. Navigate to the Clouds page and select the cloud you created on the left side of the screen. Then click the Add Region button on the right side of the screen.
  2. After clicking the Add Region button, the Add Region dialog box is displayed. Select a region from the list and click Save.
  3. After clicking Save you are brought back to the Clouds page with the region you added shown on the right side of the page.

Configure an IBM Cloud Region

To configure a region you added to your IBM Cloud cloud, follow this procedure:

  1. Navigate to Clouds page: Admin > Clouds. Find your IBM Cloud cloud from the cloud list on the left half of the screen and click its Configure Cloud link. This displays the Regions tab for this cloud as shown in the figure below with the Cloud Settings section displayed first.

  2. After you have added multiple regions to your IBM Cloud cloud, the Regions tab will show multiple individual region tabs on the left side of the screen. Click the tab of the region you want to configure.

  3. Click the Edit Cloud Settings link in the upper right of the Cloud Settings section. This opens the Configure Cloud Settings dialog box. The Cloud Settings section contains fields that are unique to IBM Cloud and settings that are common to all cloud providers. Adjust these field values per the instructions in the following tables.

    IBM Cloud Specific Cloud Settings

    FieldUsage
    Domain NameThe URL route allocated to your organization in IBM Cloud.

    Cloud Agnostic Cloud Settings

    FieldUsage
    Exclude these special characters for Windows passwordWhen the Workload Manager agent is installed on a Windows worker VM, a special user account, called cliqruser, is created to support RDP sessions that may be initiated by the user through the Workload Manager UI. A Workload Manager process running on the CloudCenter Suite cluster creates a random password and passes it to the agent for creating the cliqruser account. Because some Windows deployments may restrict using certain characters for Windows passwords, this field is provided to tell the Workload Manager to exclude these special characters in the generation of the password for the cliqruser account.
    Agent Bundle URLIf you plan to use a local repository to host the bundle store, you need to enter the URL of the local bundle store here. Otherwise, leave blank.
    Agent Custom RepositoryIf you plan to use a local repository to host the package store, you need to enter the URL of the local package store here. Otherwise, leave blank.

    When you are done editing the settings in the dialog box, click Save.

  4. Determine if you need Cloud Remote for this region. Scroll down to the Region Connectivity section for the region and click on the Configure Region link in the upper right to open the Configure Region dialog box. The toggle settings should be the same as when you set them in the connectivity page of the Add Cloud dialog box. If all of the connectivity toggles in the Region Connectivity dialog box are set to Yes, then Cloud Remote is NOT needed for this cloud region. In this case, you would normally leave all region connectivity settings at their current values and continue to the next settings section. 

    The exception to this guidance is when a NAT firewall or proxy server exists between the CloudCenter Suite management cluster and worker VMs, or between the CloudCenter Suite management cluster and users that would use Workload Manager to initiate a Guacamole remote connection to a worker VM. In either of these cases, override the address fields in the Region Connectivity dialog box as explained below.

    Networking Constraint

    Field

    Value

    Worker VMs must use a proxy server or NAT firewall to access the "local" AMQP server running in the CloudCenter Suite cluster.Worker AMQP IP AddressIP address and port number that the firewall or proxy server presents to the worker VMs on behalf of the "local" AMQP server running in the CloudCenter Suite cluster.
    Users must use a proxy server or NAT firewall to access the Guacamole server running in the CloudCenter Suite cluster.Guacamole Public IP Address and PortIP address and port number that the firewall or proxy server presents to users on behalf of the Guacamole server running in the CloudCenter Suite cluster.
    Worker VMs must use a proxy server or NAT firewall to access the Guacamole server running in the CloudCenter Suite cluster.Guacamole IP Address and Port for Application VMsIP address and port number that the firewall or proxy server presents to the worker VMs on behalf of the Guacamole server running in the CloudCenter Suite cluster.

    Click OK to save the changes and dismiss the dialog box. You can now proceed to the next region settings section: VM Naming and IPAM Strategy.

  5. If any of the connectivity toggles in the Region Connectivity dialog box are set to No, then you must install and configure Cloud Remote for this region. 

     Steps to configure Cloud Remote in an IBM Cloud cloud region

    Configure Cloud Remote in an IBM Cloud Region

    Configure Cloud Remote in an IBM Cloud region as follows.

    Since CloudCenter Suite does not include a prebuilt appliance for Cloud Remote for IBM Cloud, the following procedure includes steps to build the Cloud Remote appliance from the Cisco-supplied Cloud Remote installer file.

    Launch Cloud Remote Built from the Installer File

    1. Launch a Centos 7 instance, ensure the prerequisites are installed, and run the Cloud Remote installer file:

       Steps to Build a Cloud Remote Appliance Using the Installer File

      Build a Cloud Remote Appliance Using the Installer File

      1. Download the Cloud Remote installer file from software.cisco.com. The file name will be in a format similar to "cloudRemote5.1.0-20190614.0.bin".

      2. Launch a CentOS 7 instance in your target cloud. The instance should have as a minimum 2 vCPUs, 8 GB Memory, and 30 GB storage.  Once launched, use your cloud console to note the instance's public and/or private IP addresses. You will need this information later on in order login to the Cloud Remote web UI and to complete the Region Connectivity settings in the CloudCenter Suite Web UI. 

      3. Login to the instance and ensure all of the yum installed packages are up to date by executing the yum update command.

        sudo yum update
      4. If your instance's kernel version is 7.0 or greater, reboot your instance and skip to the next step. Otherwise, execute the following commands to install the 7.0 Linux kernel and reboot the instance:

        sudo rpm --import https://www.elrepo.org/RPM-GPG-KEY-elrepo.org
        sudo rpm -Uvh http://www.elrepo.org/elrepo-release-7.0-3.el7.elrepo.noarch.rpm
        sudo yum --disablerepo='*' --enablerepo='elrepo-kernel' list available
        sudo yum --enablerepo=elrepo-kernel -y install kernel-ml
        sudo grub2-set-default 0
        sudo grub2-mkconfig -o /boot/grub2/grub.cfg
        sudo reboot
      5. After the instance completes its reboot, login to the instance again and use the scp command to copy the Cloud Remote installer file from your PC to the instance.
      6. From the directory where you copied the installer file, run the installer:

        ./<cr_installer_bin> -- --host-ip <cr_private_ip>

        Replace <cr_installer_bin> with the installer file name, and replace <cr_private_ip> with the private IP of the instance assigned by the cloud provider.

        Note

        The installer bin file is a self extracting installer. Therefore, it is important to include " -- " between the installer file name and the command option: "--host-ip".

      7. When the installer completes successfully, you will see an appropriate success message on the VM's console. If you see an error message about the kernel not being of a late enough version, repeat the step above to install the version 7.0 kernel. If you receive an error message about any yum package being out of date, repeat the step above to update all yum installed packages.

    2. Optional but recommended for production environments: Repeat the step above twice to create two additional instances of the appliance to be used to form a cluster for HA. Cloud Remote includes support for clustering of multiple nodes. You will "add" these two additional instances to the first instance after the first instance is configured.  See Cloud Remote (Conditional) > Scaling for details.

    Setup Cloud Remote Firewall Rules for a VM-based Cloud Region

    After you deploy the Cloud Remote appliance, you will need to open various ports on each instance of the appliance. To do this, use the tools provided by the cloud provider to create a new security group for your Cloud Remote cluster; then, associate each appliance in the cluster with that security group. Use the tables below for guidance on what port rules should be added to that security group.

    Port rules for a single node Cloud Remote deployment:

    PortProtocolSourceUsage
    22TCPLimit to address space of users needing SSH access for debugging and changing default portsSSH
    443TCPLimit to address space of users needing access to the Cloud Remote web UI for setup and scalingHTTPS (Cloud Remote web UI)
    8443TCPLimit to address space of users needing SSH or RDP access to their managed VMsUser to Guacamole
    5671TCPLimit to address space of the managed VMs and the address of the CloudCenter Suite cluster's local AMQP serviceAMQP
    15671TCPLimit to address space of users needing web access for debugging the remote AMQP serviceHTTPS (AMQP Management)
    7789TCPLimit to address space of the managed VMsWorker VM to Guacamole

    The Cloud Remote web UI, User-to-Guacamole, and AMQP ports listed above are the defaults used by Cloud Remote. You may change these port numbers using the Change Ports shell script (see Cloud Remote (Conditional) > Custom Port Numbers (Conditional)) once the appliance is fully configured and communicating with the CloudCenter Suite cluster. If you plan to modify any of these three port numbers, update the firewall rules accordingly.

    For a multi-node Cloud Remote cluster deployment, these additional port rules should be added to the same security group used for the single node configuration:

    PortProtocolSource
    2377TCP<cr_sec_group> *
    25672TCP<cr_sec_group>
    7946UDP<cr_sec_group>
    4369TCP<cr_sec_group>
    9010TCP<cr_sec_group>
    4789UDP<cr_sec_group>

     * <cr_sec_group> represents the security group that all Cloud Remote nodes are joined to.

    Specify AMQP and Guacamole Addresses for Supporting Cloud Remote

    From the CloudCenter Suite UI, for the cloud region requiring Cloud Remote, navigate to the corresponding Regions or Details tab. Click the Configure Region link in the upper left of the Region Connectivity section to bring up the Configure Region dialog box. The toggle settings should be the same as when you set them in the connectivity page of the Add Cloud dialog box. You must update some of the address fields in the dialog box according to the scenarios summarized in the table below.

    Toggle SettingsFieldValue

    Worker VMs Directly Connect with CloudCenter = No
    AND
    CloudCenter Directly Accessible from Cloud Remote = Yes

    Local AMQP IP Address

    Pre-populated with the address and port number of the "local" AMQP server running in the CloudCenter Suite cluster. This address must be accessible to Cloud Remote

    If Cloud Remote is accessing the CloudCenter Suite cluster through a user-supplied proxy server or NAT firewall, overwrite this field with the corresponding local AMQP IP address and port number provided by the user-supplied proxy server or NAT firewall and accessible to Cloud Remote.

    Worker VMs Directly Connect with CloudCenter = No
    AND
    CloudCenter Directly Accessible from Cloud Remote = No
    Remote AMQP IP Address

    Enter <Cloud_Remote_IP>:<amqp_port>, where
    <Cloud_Remote_IP> = the IP address Cloud Remote which is accessible to the CloudCenter Suite cluster, and
    <amqp_port> = 5671 OR the custom AMQP port number you would later set with the Change Ports shell script on the Cloud Remote appliance (see Cloud Remote (Conditional) >
    Custom Port Numbers (Conditional)).

    If there is no user-supplied NAT firewall or proxy server between the CloudCenter Suite cluster and Cloud Remote, the IP address would be the public IP address of Cloud Remote.

    If there is a NAT firewall or proxy server between the CloudCenter Suite cluster and Cloud Remote, instead, enter the corresponding public IP address and port number that the firewall or proxy server presents to the internet on behalf of the "remote" AMQP server running in Cloud Remote.


    Worker VMs Directly Connect with CloudCenter = NoWorker AMQP IP Address

    Enter <Cloud_Remote_IP>:<amqp_port>, where
    <Cloud_Remote_IP> = the Cloud Remote IP address accessible to the worker VMs, and
    <amqp_port> = 5671 OR the custom AMQP port number you would later set with the Change Ports shell script on the Cloud Remote appliance (see Cloud Remote (Conditional) > Custom Port Numbers (Conditional)).

    Worker VMs Directly Connect with CloudCenter = NoGuacamole Public IP and PortEnter <Cloud_Remote_IP>:<guac_port>, where
    <Cloud_Remote_IP> = the Cloud Remote IP address accessible to CloudCenter Suite users, and
    <guac_port> = 8443 OR the custom Guacamole port number you would later set with the Change Ports shell script on the Cloud Remote appliance (see Cloud Remote (Conditional) > Custom Port Numbers (Conditional)).
    Worker VMs Directly Connect with CloudCenter = NoGuacamole IP Address and Port for Application VMsEnter <Cloud_Remote_IP>:<guac_port>, where
    <Cloud_Remote_IP> = the Cloud Remote IP address accessible to worker VMs, and
    <guac_port> = 7789

    When done, click OK to save the setting and dismiss the dialog box.

    Download Region Connectivity Settings and Upload to Cloud Remote

    Cloud Remote uses the region connectivity settings set in the Workload Manager or Cost Optimizer UI. After saving the Region Configuration settings in the Workload Manager or Cost Optimizer UI, you must download them and to your local computer and then upload them to Cloud Remote as follows.

    Click the Download Configuration link in the upper right of the Region Connectivity section, as shown in the figure below.

    Clicking Download Configuration causes two things to happen:

    • An encrypted zip file named artifacts.zip will be downloaded by your browser. Make note of the location of this zip file as you will need to upload it to Cloud Remote through the Cloud Remote web UI (see below).

    • The Region Connectivity section header updates to display a Copy Encryption Key link, as shown in figure below. 

    Click the Copy Encryption Key link to save the key to your clipboard. A success message will be display temporarily above the Region Connectivity section header. Make sure not to overwrite the clipboard with other data. You will need the key when you upload the configuration zip file to Cloud Remote.

    If you change the connectivity settings in the CloudCenter Suite UI and need to again download the zip file, a new encryption key is automatically created and can be copied to the clipboard by clicking the Copy Encryption Key link again.

    After you have downloaded the zip file and copied the encryption key to your clipboard, login to Cloud Remote web UI.

    1. Open another browser tab and login to https://<Cloud Remote_ip> with the default credentials: admin / cisco. 
    2. You will immediately be required to change your password. Do so. 
    3. You are now brought to the Cloud Remote home page as shown in the figure below.
    4. Click the Apply Configuration button in the page header. This prompts you to select a configuration file and enter the encryption key as shown in the figure below.
    5. Paste the encryption key that was copied to the clipboard into the Encryption Key field in the dialog box.
    6. Click Select File and browse to the artifacts.zip file that you downloaded through the CloudCenter Suite web UI and select it.
    7. Click Confirm.
    8. Once the zip file is successfully transmitted and accepted, the Cloud Remote appliance attempts to establish communication with the CloudCenter Suite cluster and the Cloud Remote web UI home page is updated to show the name of the region it is connecting to in the upper right (see figure below).

    Switch your focus back to the Region Connectivity section of the target cloud region in the CloudCenter Suite web UI. The status indicator in the Region Connectivity section header will change from Not Configured to Running once connectivity between  Cloud Remote and the CloudCenter Suite cluster is completely established (see figure below).

    After completing these steps, Workload Manager and Cost Optimizer can use Cloud Remote for communicating with the target cloud region.

  6. VM Naming and IPAM Strategy (conditional): Configure any VM naming or IPAM strategies in the Strategy section as explained in VM Naming and IPAM Strategies. If you leave the settings at the defaults, no IPAM strategy is applied and the default VM naming strategy is applied.

  7. External Lifecycle Actions (conditional): Specify any external lifecycle actions to be performed on all VMs launched by Workload Manager in this region as explained in External Lifecycle Actions Settings

  8. Instance Types (informational): CloudCenter Suite automatically syncs instance types for public cloud regions on a daily basis. This data includes published pricing for each instance type. It is not possible to edit IBM Cloud region instance types. See Instance Types Settings for more details.

  9. Storage Types (conditional): CloudCenter Suite automatically syncs storage types for public cloud regions on a daily basis. This data includes the cloud provider published pricing for each storage type. It is not possible to edit IBM Cloud region storage types. See Storage Types Settings for more details.

  10. Image Mappings: Image mappings allow services based on CloudCenter Suite logical images to be deployed using the appropriate physical image stored on the target cloud region. CloudCenter Suite automatically maps the OOB logical images to public cloud region physical images when you add the region to your cloud. Cisco periodically updates these mappings when new versions of OS physical images are uploaded by the cloud provider. To apply these updates to your region after it is added to your cloud, click the Sync Image Mappings link in the upper right of this section. If you create any custom logical images, you must manually import the corresponding physical images into your region and then map the corresponding logical images to these physical images. See Images for more context.

Add an IBM Cloud Cloud Account

Configuration Process

To add an IBM Cloud cloud account, follow this procedure.

  1. Locate your IBM Cloud cloud on the Clouds page and click the Add Cloud Account link for this cloud. This displays the Add Cloud Account dialog box as shown below.

  2. Assign a cloud account Name

    Tip

    The name should not contain any space, dash, or special characters.

  3. Provide the IBM Cloud cloud credentials:

    1. IBM Cloud Account Name

    2. IBM Cloud Account API Key

  4. Click the Connect button. CloudCenter Suite will now attempt to validate your account credentials.

  5. After the credentials are verified, the Connect button changes to an Edit button and two new fields appear Enable Account For and Enable Reporting By Org Structure

    1. Set the Enable Account For dropdown per the table below.

      ValueUsage

      Provisioning

      Workload Manager can deploy jobs using this account.

      Reporting

      Cost Optimizer and Workload Manager will track cloud costs for this account. Typical usage: master cloud accounts that are used for billing aggregation.

      It is recommended that you do not add a Reporting account to the same tenant through different cloud groups.

      Enabling a public cloud account for Reporting may incur expenses to retrieve cost data. These expenses are proportional to the number of configured cloud accounts and regions.

      Provisioning, Reporting

      Default. Account is used for both provisioning and reporting.

    2. Click the Save button when done. 

Cloud Accounts Tab

After you add cloud accounts to a cloud, they will appear in the Accounts tab for the cloud as shown in the figure below.

The Accounts tab contains columns for data entered when creating an account: Account Name, Description, Enabled For; and two additional columns: Billing Units and Actions. Billing Units is a dual function:

  • If the cloud account contains only one billing unit, the ID for that billing unit is displayed.

  • If the cloud account contains multiple billing units, such as an AWS master account, the number of billing units in that account is displayed followed by the text Billing Units

A billing unit is the most granular level of cloud cost recording in CloudCenter Suite. The definition of a billing unit varies by a cloud provider as shown in the table below.

Cloud ProviderBilling Unit
AWSAccount ID
AzureRMSubscription ID
GoogleProject ID
IBM CloudAccount ID
vCenterCloud Group Prefix - Datacenter Name
vCDOrganization Name
OpenStackProject ID
KubernetesNamespace UID

The last column, Actions, contains links to let you edit or deleted the cloud account, or manage instance types for the cloud account.



  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved