Pure Storage REST API ETL for TrueSight Capacity Optimization

Before installing Pure Storage REST API ETL for TrueSight Capacity Optimization, you must ensure that the following requirements are met:

• Your Pure Storage flash array supports Pure Storage REST API v1.6 or higher
• An API Token has been created as explained below.

A. Creating the API Token

Because the Pure Storage REST API uses authentication tokens to create sessions, you will have to first create an API token to be able to collect capacity information. The procedure is as follows:

1. Log in to the Purity GUI. Default credentials are pureuser/pureuser. 
   
2. Under the SYSTEM tab, navigate to Users > API Tokens.
   
3. Click  and select Add API Token.
   
4. Enter a Username and click Create.
   

1. The API Token is now created. To view it, click  next to the username you have just added and select Show API Token:
   
   A pop-up is displayed. Copy the API token. This information will be required when configuring the Pure Storage REST API ETL.

B. Deploying the ETL module

Complete the following steps to deploy the ETL Module:

1. Navigate to Administration > SYSTEM > Maintenance.
2. Verify the installation status of the already uploaded packages. If their status is "READY" or "RUNNING", wait for the installation to complete before proceeding.
3. At the bottom of the Maintenance page, locate the Upload patch or additional package file section.
4. Click Browse.
5. Locate and select the ETL installation package.
6. Click Upload.
7. Read the Overview and click Next to continue.
8. Read and accept the End User License Agreement.
9. Select the server on which the operation must be executed; that is the server on which the package will be saved. Click Proceed to continue.

10. A successful installation will result in a green line in the Additional Packages table.

    Note

     In case of unsuccessful outcome (e.g. a yellow WARNING line), click the  icon to inspect the deployment log.

A. Configuring the basic properties

Some of the basic properties display default values. You can modify these values if required.

To configure the basic properties:

1. In the TrueSight Capacity Optimization console, navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
2. On the ETL tasks page, under the Last run tab, click Add > Add ETL. The Add ETL.The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, and ETL additional settings.
3. On the Run configuration tab, select Storage - Pure Storage REST API Extractor Service from the ETL Module list. The name of the ETL is displayed in the ETL task name field. You can edit this field to customize the name.
   

4. Click the Entity catalog tab, and select one of the following options:

   • Shared Entity Catalog:

     Select if other ETLs access the same entities that are used by the Pure Storage REST API ETL.

     • From the Sharing with Entity Catalog list, select the entity catalog name that is shared between ETLs.
   • Private Entity Catalog: Select if this is the only ETL that extracts data from the Pure Storage resources.

   1. Click the Connection Settings tab, and configure the following properties:

      Property	Description
      Hostname	Hostname or IP address of the Pure Storage system.
      API Token	API token to be used by the Pure Storage REST API to create sessions and collect capacity information. For more information, refer to Creating the API Token.

5. Click Save. You are returned to the Last run tab under the ETL tasks page. 

   1. 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.

   • 
     
     • 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. 

   1. Switch the ETL to production mode: Perform the following steps:
      1. In the ETL tasks table under ETL tasks > Last run, click the ETL under the Name column.
      2. In the Run configuration 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. 
6. 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 from the source and transfer it to TrueSight Capacity Optimization database. You can see the entity hierarchy in the left Navigation pane, under Workspace.

(Optional) B. Configuring the advanced properties

You can configure the advanced properties to change the way the ETL works or to collect additional metrics.

To configure the advanced properties:

1. On the Add ETL page, click Advanced

2. Configure the following properties:

   Property	Description
   Levels up to	By default, extended level metrics are not imported by the ETL. To import them, you will have to customize the collection level and set it to [4] Extended. For more information about Aging Class Mapping, refer to the topic Adding and managing metric profiles.

3. Click Save. The ETL tasks page shows the details of the newly configured Pure Storage REST API ETL.
4. Complete the procedure by performing steps 6 to 8 from the Configuring the basic properties procedure.

After you configure the ETL, you can run it to collect data. You can run the ETL in the following modes:

A. Simulation mode: Only validates connection to the data source, does not collect data. Use this mode when you want to run the ETL for the first time or after you make any changes to the ETL configuration.

B. Production mode: Collects data from the data source.

A. Running the ETL in the simulation mode

To run the ETL in the simulation mode:

1. In the TrueSight Capacity Optimization console, navigate to Administration > ETL & System Tasks, and select ETL tasks.
2. On the ETL tasks page, click the ETL. The ETL details are displayed.

1. In the Run configurations table, click Edit to modify the ETL configuration settings.
2. On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
3. Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
4. On the ETL tasks page, check the ETL run status in the Last exit column. 
   OK Indicates that the ETL ran without any error. You are ready to run the ETL in the production mode.
5.  If the ETL run status is Warning, Error, or Failed:
   1. On the ETL tasks page, click  in the last column of the ETL name row.
   2. Check the log and reconfigure the ETL if required.
   3. Run the ETL again.
   4. Repeat these steps until the ETL run status changes to OK.

B. Running the ETL in the production mode

You can run the ETL manually when required or schedule it to run at a specified time.

a. Running the ETL manually

1. On the ETL tasks page, click the ETL. The ETL details are displayed.
2. In the Run configurations table, click Edit  to modify the ETL configuration settings. The Edit run configuration page is displayed.
3. On the Run configuration tab, select No for the Execute in simulation mode option, and click Save.
4. To run the ETL immediately, click Run active configuration. A confirmation message about the ETL run job submission is displayed.
   When the ETL is run, it collects data from the source and transfers it to the TrueSight Capacity Optimization database.

b. Scheduling the ETL run

By default, the ETL is scheduled to run daily. You can customize this schedule by changing the frequency and period of running the ETL.

To configure the ETL run schedule:

1. On the ETL tasks page, click the ETL, and click Edit. The ETL details are displayed.
   
   
2. On the Edit task page, do the following, and click Save:
   • Specify a unique name and description for the ETL task.
   • In the Maximum execution time before warning field, specify the duration for which the ETL must run before generating warnings or alerts, if any.
   • Select a predefined or custom frequency for starting the ETL run. The default selection is Predefined.
   • Select the task group and the scheduler to which you want to assign the ETL task.
3. Click Schedule. A message confirming the scheduling job submission is displayed.
   When the ETL runs as scheduled, it collects data from the source and transfers it to the TrueSight Capacity Optimization database.

Testing the connection to the REST API

The ETL relies on the REST API to collect information about Pure Storage systems. Because some connectivity issues may exist and cause the ETL to fail, it is highly recommended to test the connection to this specific component. The procedure is as follows:

1. Download the troubleshooting tool from EPD.
2. Run the command java –jar <Troubleshooting_Tool_Name.jar> to launch the tool.
3. Enter the information required to connect to the system and click Test Connection.
4. Wait for the test to complete.
5. If a connectivity issue is detected, an error message will appear. In this case, the issue encountered does not concern the ETL. Check your configuration to diagnose the source of the issue.
6. Click Save As to export the connection test results into a txt file.

Hiding the API token ID

Starting with version 11.3.01, the API token ID is displayed as a hidden password.

If you are upgrading from a previous version of the ETL and wish the API token ID to be hidden, you can either:

1. Remove the ETL task and create a new one
   or
2. Change the ETL property that manages the API token ID display.
   In previous versions of the ETL, the API token ID display was managed by the apiToken property that made the API token to appear in clear in the console. In order to hide the API token ID, the ETL must use the new property apiToken.password, that is installed, by default, with version 11.3.01. Therefore, the apiToken property must be removed:

1. 
   
   1. Select the ETL task you wish to modify and click the edit icon.
   2. Expand the Connection Settings section and enter your API token.
      
   3. At the bottom of the page click the hyperlink this page to manually modify the ETL properties.
   4. Click the remove  icon next to apiToken.
      
   5. Click Save.

Customizing volumes monitoring

Discovering volumes and collecting their performance metrics are resource-intensive actions that can create extra workload on the system. To reduce the system resource consumption, administrators can disable or enable the volumes monitoring at will and fine-tune the creation of volume entities into the TrueSight Capacity Optimization environment.

The following metrics are no longer collected and displayed in the console when volumes monitoring is disabled:

To customize volumes and shares monitoring

1. Edit the Pure Storage REST API ETL Run Configuration.
2. Expand the ETL additional settings menu.

3. From the Volumes pull-down lists, select one of the following options:

   Option	Result
   Disabled	Volumes are not discovered. Volumes-related metrics are not loaded in the console. Note Use this configuration if the number of volumes to manage significantly slows down the system performance. Disabling the volumes monitoring prevents the discovery of volumes and consequently does not allow the ETL to collect, save or process their data. Note that the calculation of metrics for other sources may be impacted.
   Collected for metric computation (Default)	All volumes are discovered and their metrics are collected and processed. Volumes-related metrics are not loaded in the console. Note Use this configuration if you wish to collect and process volume/shares-related metrics without loading this information in the console. The collected data will however be used to calculate metrics for other sources, when required. This will reduce the resource consumption of your system.
   Collected and Imported	All volumes are discovered and their metrics are collected and processed. Volumes-related metrics are saved in the database, processed and loaded in the console. Note Use this configuration if your system is powerful enough to manage all the volumes to monitor.

4. Click Save.

Running the Extractor Service task

Setting the collect frequency