Page tree

Unsupported content

   

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Skip to end of metadata
Go to start of metadata

This topic describes how to integrate BMC TrueSight Capacity Optimization with BMC Cloud Lifecycle Management 4.x to extract cloud services data.

Note

If you have already installed the Integration with BMC - Cloud Lifecycle Management component with the Import Tenant/Service tree option selected, you will find a preconfigured instance of the BMC - Cloud Lifecycle Management 4.0/4.1/4.5 - Cloud Services extractor in the ETL Tasks table under Administration > ETL & System Tasks > ETL tasks, and you do not need to create a new ETL task. For more information, see BMC - Cloud Lifecycle Management 4.x.

 This topic contains the following sections:

Integration steps

To integrate BMC TrueSight Capacity Optimization with the Cloud Service Extractor, perform the following task:

  1. Navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
  2. In the ETL tasks page, click Add > Add ETL under the Last run tab.
  3. In the Add ETL page, set values for the following properties under each expandable tab. The page contains the following tabs:

      Note

      Basic propertiesare displayed by default in the Add ETL page. These are the most common properties that you can set for an ETL, and it is acceptable to leave the default selections for each as is.

      Property Value
      Run configuration
      ETL task name By default, this field is populated based on the selected ETL module. You can specify a different name for the ETL Task. Duplicate names are allowed.
      Run configuration name Default name is already filled out for you. This field is used to differentiate different configurations you can specify for the ETL task. You can then run the ETL task based on it.
      Environment You can select Production or Test to mark the ETL tasks. For example, you can start by marking the task as Test and change it to Production after you have seen that you are getting what you wanted.
      Description (Optional) Enter a brief description for this ETL.
      Log level Select how detailed you want the ETL log to be. The log includes Error, Warning and Info type of log information.
      • 1 - Light: Add bare minimum activity logs to the log file.
      • 5 - Medium: Add medium-detailed activity logs to the log file.
      • 10 - Verbose: Add detailed activity logs to the log file. Info,

      Note: Log levels 5 and 10 are typically used for debugging or troubleshooting ETL issues. Using a log level of 5 is general practice, however, you may choose level 10 to get a high level of detail while troubleshooting.

      Execute in simulation mode Select Yes if you want to to validate the connectivity between the ETL engine and the target, and to ensure that the ETL does not have any other configuration issues.
      When set to Yes, the ETL will not store actual data into the data warehouse. This option is useful while testing a new ETL task.
      ETL module (BMC recommends you to make this selection first) Select BMC - Cloud Lifecycle Management 4.0/4.1/4.5 - Cloud Services extractor.
      Module description A link in the user interface that points you to technical documentation for the ETL.
      Entity catalog
      Sharing status Select any one:
      • Shared entity catalog: Select this option if, for the same entities, data is coming from multiple sources. For example, BPA ETL.
        • Sharing with Entity Catalog: Select an entity catalog from the drop-down list.
      • Private entity catalog: Select this option if, for the same entity, data is coming from a single source.
      Object relationships
      Associate new entities to

      Specify the domain where you want to add the entities created by the ETL. You can select an existing domain or create a new one.

      Additional Information

      By default, a new domain is created for each ETL, with the same name as that of the extractor module. As the ETL is created, a new hierarchy rule with the same name of the ETL task is automatically created, with status Active. If you update the ETL by specifying a different domain, the hierarchy rule is updated automatically.

      Select any one of the following options: 

      • New domain: Create a new domain. Specify the following properties under New domain:
        • Parent: Select a parent domain for your new domain from the domain selector control.
        • Name: Specify a name for your new domain.
      • Existing domain: Select an existing domain. Make a selection for the following property:
        • Domain: Select an existing domain from the domain selector control.
      CLM configuration
      Host name <Platform Manager> Enter the host name for the Platform Manager.
      Port Enter the port number for the Platform Manager.
      Transport Type Select the transport protocol to use with Platform Manager.
      Need authentication

      If No is (pre)selected, you must change the selection to Yes. This allows you to specify the following Platform Manager authentication parameters:

      • Username: Enter the username of the authorized Platform Manager user.
      • Password: Enter the password for this username.
      • Login type: Select any one – 
        • Regular: (Default) Provide regular Platform Manager privileges to the user authenticated above.
        • Super user: Provide Administrator Platform Manager privileges to the user authenticated above.
          The Super User and Impersonate types of login are based on a challenge-response type of communication between client and CSM, with AES/128bit standard Java security encryption.
        • Impersonate: Impersonate Platform Manager privileges from another user for the user authenticated above.
      Host name <Enterprise CMDB>

      Enter the Enterprise CMDB host name to use with Chargeback for BMC TrueSight Capacity Optimization.

      Port Enter the port number to connect to the Enterprise CMDB.
      Username Enter the Enterprise CMDB user name.
      Password (can be empty) (Optional) Enter the password.
      Chargeback options Select the appropriate option for Chargeback. (See the Chargeback task for details.)
      ETL task properties
      Task group Select a task group to classify this ETL into. it is not necessary to group it into a task group.
      Running on scheduler Select the scheduler over which you want to run the ETL. The type of schedulers available are:
      • Primary Scheduler: Runs on the AS
      • Generic Scheduler: Runs on a separate machine
      • Remote: Runs on different remote machines.
      Maximum execution time before warning The number of hours, minutes or days to execute the ETL for before generating warnings or alerts, if any.
      Frequency Select the frequency for ETL execution. Available options are:
      • Predefined: Select a Predefined frequency from Each DayEach Week, or Each Month.
      • Custom: Enter a Custom frequency (time interval) as the number of minutes, hours, days, or weeks to run the ETL in.
      Start timestamp: hour\minute (Applies to Predefined frequency) The HH:MM start timestamp to add to the ETL execution running on a Predefined frequency.
      Custom start timestamp Select a yyyy-mm-dd hh:mm timestamp to add to the ETL execution running on a Custom frequency.

      Note

      To view or configure Advanced properties, click Advanced. You do not need to set or modify these properties unless you want to change the way the ETL works. These properties are for advanced users and scenarios only.

      Property Value
      Run configuration
      Datasets

      Enables you to select or deselect metric groups for which data will be populatedAvailable datasets. The OpenStack connector allows you to choose only from the given list of datasets, and you cannot include additional datasets to the run configuration of the ETL.

      1. Click Edit.
      2. Select one (click) or more (shift+click) datasets that you want to exclude fromAvailable datasets and click >> to move them to Selected datasets.
      3. Click Apply.
      Use enterprise grouping Select yes or no. The default value is no.
      CLM configuration
      Extraction parallelism Enter the number of threads to keep open simultaneously for importing data.
      Use CMDB Graph API Select the appropriate option to use CMDB graph API.
      Empty price handling

      Select the required option for handling the empty price.

      Note

      If you select the option to replace the empty price with a value in the same currency, ensure that you enter only non-negative values.

      Additional properties
      List of properties

      Additional properties can be specified for this ETL that act as user inputs during execution. You can specify values for these properties either at this time, or from the "You can manually edit ETL properties from this page" link that is displayed for the ETL in view mode.

      1. Click Add.
      2. Add an additional property in the etl.additional.prop.n box.
      3. Click Apply.
        Repeat this task to add more properties.
      Loader configuration
      Empty dataset behavior Choose one of the following actions if the loader encounters an empty dataset:
      • Warn: Warn about loading an empty dataset.
      • Ignore: Ignore the empty dataset and continue parsing.
      ETL log file name Name of the file that contains the ETL execution log; the default value is: %BASE/log/%AYEAR%AMONTH%ADAY%AHOUR%MINUTE%TASKID
      Maximum number of rows for CSV output A number which limits the size of the output files.
      CSV loader output file name Name of the file generated by the CSV loader; the default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID.
      BCO loader output file name Name of the file generated by the BMC TrueSight Capacity Optimization loader; the default value is: %BASE/output/%DSNAME%AYEAR%AMONTH%ADAY%AHOUR%ZPROG%DSID%TASKID.
      Detail mode Select the level of detail:
      • Standard: Data will be stored on the database in different tables at the following time granularities: Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
      • Raw also: Data will be stored on the database in different tables at the following time granularities: Raw (as available from the original data source), Detail (configurable, by default: 5 minutes), Hourly, Daily, Monthly.
      • Raw only: Data will be stored on the database in a table only at Raw granularity (as available from the original data source).

      For more information on granularities, see Accessing data using public views and Sizing and scalability considerations.

      Reduce priority

      Select either Normal or High.

      Remove domain suffix from datasource name (Only for systems) If set to True, the domain name is removed from the data source name. For example, server.domain.com will be saved as server.
      Leave domain suffix to system name (Only for systems) If set to True, the domain name is maintained in the system name. For example: server.domain.com will be saved as such.
      Update grouping object definition If set to True, the ETL will be allowed to update the grouping object definition for a metric loaded by an ETL.
      Skip entity creation (Only for ETL tasks sharing lookup with other tasks) If set to True, this ETL does not create an entity, and discards data from its data source for entities not found in BMC TrueSight Capacity Optimization. It uses one of the other ETLs that share lookup to create the new entity.
      Scheduling options
      Hour mask Specify a value to execute the task only during particular hours within the day. For example, 0 – 23 or 1,3,5 – 12.
      Day of week mask Select the days so that the task can be executed only during the selected days of the week. To avoid setting this filter, do not select any option for this field.
      Day of month mask Specify a value to execute the task only during particular days within a month. For example, 5, 9, 18, 27 – 31.
      Apply mask validation By default this property is set to True. Set it to False if you want to disable the preceding Scheduling options that you specified. Setting it to False is useful if you want to temporarily turn off the mask validation without removing any values.
      Execute after time Specify a value in the hours:minutes format (for example, 05:00 or 16:00) to wait before the task must be executed. This means that once the task is scheduled, the task execution starts only after the specified time passes.
      Enqueueable Select one of the following options:
      • False (Default): While a particular task is already running, if the next execution command arises – it is ignored.
      • True: While a particular task is already running, if the next execution command arises – it is placed in a queue and is executed as soon as the current execution ends.
    • Click Save.
      You return to the Last run tab under the ETL tasks page.
    • Validate the results in simulation mode: In the ETL tasks table under ETL tasks > Last run, locate your ETL (ETL task name), click  to run the ETL.
      After you run the ETL, the Last exit column in the ETL tasks table will display one of the following values:
      • OK: The ETL executed without any error in simulation mode.
      • WARNING: The ETL execution returned some warnings in simulation mode. Check the ETL log.
      • ERROR: The ETL execution returned errors and was unsuccessful. Edit the active Run configuration and try again.
    • Switch the ETL to production mode: To do this, perform the following task:
      1. In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
      2. In the Run configurations table in the ETL details page, click  to edit the active run configuration.
      3. In the Edit run configuration page, navigate to the Run configuration expandable tab and set Execute in simulation mode to No.
      4. Click Save.
    • Locate the ETL in the ETL tasks table and click  to Run it, or schedule an ETL run.
      After you run the ETL, or schedule the ETL for a run, it will extract the data form the source and transfer it to the BMC TrueSight Capacity Optimization database.

    Metrics for BMC Cloud Lifecycle Management 4.x to extract cloud services data

    The following BMC TrueSight Capacity Optimization metrics are populated by the BMC - Cloud Lifecycle Management 4.x - Cloud Service extractor ETL:

    • CLOUD_NAME
    • TENANT_NAME
    • SO_NAME
    • SOI_NAME
    • REQUESTED_CPU_FAMILY
    • REQUESTED_CPU_NUM
    • REQUESTED_DISK_NUM
    • REQUESTED_DISK_SIZE
    • REQUESTED_OS_FAMILY
    • REQUESTED _REAL_MEM
    • LOCATION_SITE

    Related topics

    Using datasets

    Developing custom ETLs

    Dataset reference

    Horizontal and Vertical datasets

    Datasets and metrics