Pivotal Cloud Foundry

Transcription

1 VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR Pivotal Cloud Foundry Installation & Configuration Guide

2 TABLE OF CONTENTS 1. Purpose Installation and Configuration Requirements Licensing Requirements Installing the Management Pack Uploading the Installation File Adding a License Key Configuring the Blue Medora Firehose Nozzle Prerequisites Procedure Configuring the Management Pack Creating an Adapter Instance and Credential Adding an SSL Certificate to the vrops Truststore Manually Discovering Resources Validating Data Collection Appendix I: Management Pack Folders and Files Appendix II: Webserver Appendix II: Revision Notes...19 NOTE: This document supports the version of each product listed, as well as all subsequent versions, until a new edition replaces it. You can find the most up-to-date technical documentation on the Blue Medora support site at: The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: support@bluemedora.com. 2 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

3 1. Purpose The Blue Medora VMware vrealize Operations (vrops) Management Pack for Pivotal Cloud Foundry Installation and Configuration Guide describes how to set up Blue Medora s Management Pack for Pivotal Cloud Foundry to use within vrealize Operations. 2. Installation and Configuration Requirements Before installing and configuring the Management Pack, ensure your system meets the following requirements: Table 1: Management Pack System Requirements VERSION(S) VREALIZE OPERATIONS (VROPS) REQUIREMENTS vrealize Operations, v6.x (Advanced or Enterprise edition) PIVOTAL CLOUD FOUNDRY (PCF) REQUIREMENTS Pivotal Cloud Foundry 1.7+ CREDENTIALS N/A UAA User Name/Password NOTE: The Management Pack requires a least privileged UAA user account with a minimum scope of doppler. firehose. CONNECTION vrops hostname or IP address Pivotal Cloud Foundry hostname or IP address The Management Pack collects data using the Blue Medora Firehose Nozzle s REST API via default port NOTE: The Blue Medora Firehose Nozzle must be configured prior to adding an adapter instance. Refer to section 5. Configuring the Blue Medora Firehose Nozzle for details. 3. Licensing Requirements When purchased individually, the Management Pack for Pivotal Cloud Foundry is licensed per OSI. Alternatively, customers who have purchased Blue Medora s True Visibility Suite (Standard, Advanced, or Enterprise) can access all management packs within that suite (and the edition below it, if applicable). The Management Pack for Pivotal Cloud Foundry is part of Blue Medora s Advanced True Visibility Suite (TVS), which means a TVS Advanced license or higher is required to use it. For more information, visit A license key will be provided by Blue Medora when the Management Pack or True Visibility Suite is purchased and must be added as a Pivotal Cloud Foundry Adapter License within vrealize Operations before the Management Pack can be configured and used. Refer to section 4.2 Adding a License Key, for details. 3 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

4 4. Installing the Management Pack Installing the Management Pack in vrealize Operations involves completing the following tasks: Uploading the Installation File Adding a License Key 4.1 Uploading the Installation File The Management Pack for Pivotal Cloud Foundry is installed by uploading a.pak file Prerequisites Obtain the Management Pack installation file from Read the release notes that are included with the.pak file Procedure 1. Save the.pak file in a temporary location. 2. Log in to vrealize Operations as an admin user. 3. Click the Home icon, then select the Administration navigation shortcut from the panel on the left. Figure 1: Home > Administration 4. In the right panel, the Solutions tab will be displayed. Figure 2: Solutions Tab 4 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

5 5. Click the Add icon ( ) to upload the.pak file to the vrealize Operations server. In the dialog that appears, browse to the location of the saved.pak file, then click Upload. NOTE: The.pak file upload may take several minutes to complete. Status information appears in the Installation Details text box throughout the installation process. Figure 3: Select the.pak file to upload 6. Click Next when the upload has finished. Read the End User License Agreement (EULA) and click the I accept the terms of this agreement checkbox to accept, then click Next. 7. Click Finish when the installation process is complete. NOTE: The installation utility creates the pcf_adapter3 folder and pcf_adapter3.jar file in the $VCOPS_ BASE/user/plugins/inbound folder. Refer to section 7. Appendix I: Management Pack Folders and Files for more information. 5 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

6 4.2 Adding a License Key The Management Pack for Pivotal Cloud Foundry requires a valid license for full operation. Complete the following steps to license the Management Pack Install the License 1. In vrealize Operations Manager, navigate to Administration > Licensing > License Keys. 2. Click the Add icon ( ). In the dialog that appears, select Pivotal Cloud Foundry. Figure 4: Add License 3. Enter your Blue Medora license key, then click Validate. If successful, License key validated successfully will be displayed. 4. Click Save to finish adding your license key Add the License to a Group NOTE: Adding a license to a license group is only necessary if using vrops In later versions, the License will automatically be added to a group. 1. Navigate to License Groups. 2. Select the license group PivotalCloudFoundry Licensing, then click the Edit icon ( ). 3. Check the newly added license. 4. Enter a name for this license group, then click Next. 5. Select the resources to include/exclude in this group, then click Next. 6. Click Finish. 7. Navigate back to License Keys and click the Refresh License Usage icon ( ). 6 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

7 5. Configuring the Blue Medora Firehose Nozzle The Blue Medora Firehose Nozzle is a Cloud Foundry component that collects metrics for the Loggregator Firehose and exposes them via a RESTful API. Before the nozzle can be configured, it must be deployed. There are multiple ways to deploy the nozzle: Blue Medora Nozzle for PCF Tile method (recommended) Cloud Foundry Command Line Interface (cf-cli) Cloning from the GitHub repo and running it on any machine that can connect to the Traffic Controller BOSH Command Line Interface (CLI) 5.1 Prerequisites Blue Medora Nozzle for PCF Tile method (recommended) Download the Blue Medora Nozzle for PCF Tile from the Pivotal Network at: io/, then follow the instructions for installing, configuring, and using the nozzle as documented on the Pivotal web site at: Cloud Foundry CLI method Install the Cloud Foundry Command Line Interface (cf-cli) available at: cloudfoundry/cli To deploy the nozzle, configure manifest.yml and run cf push to install the cf app as described here: Cloning from github deployment method Install the Go programming language (version 1.6+) on a machine that can connect to the Traffic Controller To deploy the nozzle, run the following command, which clones the nozzle files and dependencies from the GitHub repository and sets them up them in your Go environment: go get github.com/bluemedorapublic/bluemedora-firehose-nozzle BOSH CLI deployment method 5.2 Procedure Install the BOSH Command Line Interface (CLI) using the BOSH release available at: com/bluemedorapublic/bluemedora-firehose-nozzle-release Deploy the nozzle as instructed in the following tutorial: nozzle-tutorial.html The following sections describe how to configure the nozzle once it has been deployed using one of the manual deployment methods listed above ( ). For additional support, refer to the following reference material: For more information on managing UAA users within Cloud Foundry, refer to the following guide: For more information on setting up a nozzle user with BOSH, refer to the following tutorial: docs.cloudfoundry.org/loggregator/nozzle-tutorial.html For more information on setting up the BOSH manifest, refer to the following guide: docs/deployment-manifest.html NOTE: For more information on how metrics are pulled from the Blue Medora Firehose Nozzle, refer to section 8. Appendix II: Webserver. 7 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

8 5.2.1 Configuring the UAA User Ensure the Cloud Foundry UAA user you plan to use is authorized to access the loggregator firehose and has doppler.firehose permissions. An example of one way to modify the UAA user involves editing your Cloud Foundry BOSH manifest under the properties.uaa.clients section. An example configuration would look similar to the following: properties: uaa: clients: bluemedora-firehose-nozzle: access-token-validity: authorized-grant-types: authorization_code,client_credentials,refresh_token override: true secret: <password> scope: openid,oauth.approvals,doppler.firehose authorities: oauth.login,doppler.firehose Configuring the Nozzle To configure the nozzle itself, which connects to the Cloud Foundry firehose and exposes a RESTful API, modify and re-save the configuration file, bluemedora-firehose-nozzle.json, located in the config folder of the nozzle files as follows: Table 2: Blue Medora Firehose Nozzle Configuration Fields FIELD UAAURL UAAUsername UAAPassword TrafficControllerURL SubscriptionID DisableAccessControl InsecureSSLSkipVerify IdleTimeoutSeconds MetricCacheDurationSeconds DESCRIPTION The UAA login URL of the Cloud Foundry deployment. The UAA username that has access to read from Loggregator Firehose. Password for the UAA Username. The URL for the Traffic Controller. To find the URL, follow the instructions outlined here: architecture.html#firehose The subscription ID of the nozzle. For more information about subscription IDs and nozzle scaling, refer to: org/loggregator/log-ops-guide.html#scaling-nozzles If true, disables authentication with UAA. Used in lattice deployments. If true, allows insecure connections to the UAA and Traffic Controller endpoints. The amount of time, in seconds, the connection to the Firehose can be idle before disconnecting. The amount of time, in seconds, the RESTful API web server will cache metric data. The higher this duration, the less likely the data will be correct for a certain metric as it could hold stale data. WebServerPort Port to connect to the RESTful API (default: 8081). 8 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

9 An example configuration would look similar to the following: { UAAURL : UAAUsername : apps_metrics_processing, UAAPassword : password, TrafficControllerURL : wss://doppler.pcf.envrionment.com:443, SubscriptionID : bluemedora-nozzle-id, DisableAccessControl : false, InsecureSSLSkipVerify : true, IdleTimeoutSeconds : 30, MetricCacheDurationSeconds : 60, WebServerPort : 8081 } Generating SSL Certificates The Blue Medora Nozzle uses SSL for its REST webserver. In order to generate these certificates, run the following command and answer the questions at the prompts: openssl req -x509 -nodes -days newkey rsa:2048 -keyout certs/key.pem -out certs/cert.pem Running the Nozzle Once you have deployed and configured the nozzle, you can run it using the following command: go run main.go 9 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

10 6. Configuring the Management Pack Configuring the Management Pack for Pivotal Cloud Foundry includes the following tasks: Creating an Adapter Instance and Credential Adding an SSL Certificate to the vrops Truststore (optional) Manually Discovering Resources (if necessary) Validating Data Collection 6.1 Creating an Adapter Instance and Credential You must create an adapter instance and credential for the Management Pack in order to define the adapter type and identify the device(s) from which the adapter instance will retrieve data Prerequisites Install the Management Pack for Pivotal Cloud Foundry. Refer to section 4. Installing the Management Pack Procedure 1. Log in to vrealize Operations as an administrator. 2. Click on the Administration navigation shortcut ( ). The Solutions view should automatically open. 3. Select the Pivotal Cloud Foundry adapter from the Solutions list. Figure 5: Solutions List 10 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

11 4. Click the Configure icon ( ). The Manage Solution window will appear. Figure 6: Manage Solution Window NOTE: If creating multiple adapter instances, click the Add icon ( ) above the list of Instance Names on the left. 5. In the Manage Solution window, enter the following information: Instance Settings: Display Name: A name for this particular instance of the Management Pack Description: Optional; most helpful for describing multiple adapter instances of the Management Pack Basic Settings: Host: Hostname or IP address of the Nozzle NOTE: The Management Pack supports IPv4 and FQDN. Credential: Click the Add icon ( ), then enter your credential information (refer to Figure 7). Advanced Settings: Collectors/Groups: Automatically selected Port: Optional; default port is 8081, but can be changed as needed to match Nozzle configuration. (Tile / Cloud Foundry App default port: 443; BOSH Install default port: 8081) Validate Certificate Against Truststore: Optional; default setting is False (all server certificates are trusted by vrops). If set to True, the Pivotal Cloud Foundry host server SSL certificate must be added to the truststore on your vrops machine. For more information, refer to section 6.2 Adding an SSL Certificate to the vrops Truststore. Support Autodiscovery: Default setting is True, which enables the adapter instance to create resources for you. If you select False, you must manually discover your Pivotal Cloud Foundry resources. 11 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

12 Figure 7: Manage Credential Window Credential Name: Assign a name to your set of credentials User Name: UAA User Name used in Nozzle configuration Password: UAA Password used in Nozzle configuration 6. Click OK to save your credential. 7. Click Test Connection to ensure vrealize Operations can connect properly to the system. 8. Click Save Settings to save your adapter instance configuration. 12 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

13 6.2 Adding an SSL Certificate to the vrops Truststore NOTE: Different levels of security can be configured in the Management Pack for Pivotal Cloud Foundry. The least secure configuration is to leave the default selection of False for the Validate Certificate Against Truststore Advanced Setting. For added security, you can enable SSL by following the instructions below and selecting True for the Validate Certificate Against Truststore Advanced Setting. 1. Obtain the SSL certificate for the Blue Medora Nozzle, which is stored in the certs directory of the Nozzle base directory. 2. Copy the certificate to your vrops machine. 3. Use ssh to log in to the vrops machine as the root user, then run the following command: Linux: $VCOPS_BASE/jre/bin/keytool -import -alias <product_alias> /tmp/<certfile> -keystore $VCOPS_DATA_VCOPS/user/conf/ssl/tcserver.truststore -storepass <truststore_password> -trustcacerts Windows: %VCOPS_BASE%\jre\bin\keytool -import -alias <product_alias> C:\path\to\ certfile -keystore %VCOPS_DATA_VCOPS%\user\conf\ssl\tcserver.truststore -storepass <truststore_password> -trustcacerts NOTE: The <truststore_password> is generated by vrops and is located in /storage/vcops/user/ conf/ssl/storepass.properties. Copy the password from the ssltruststorepassword= field and paste it in the <truststore_password> placeholder. Parameter Descriptions: -alias is a unique name for each key that you add (per host) certfile is the location where the cert file was saved 4. Run the reboot command to re-start the vrops machine for the changes to take effect. 13 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

14 6.3 Manually Discovering Resources If Autodiscovery was set to False when configuring the adapter instance, you will need to manually discover resources as described in this section. With manual discovery, the adapter sends a request to the Pivotal Cloud Foundry system to return resources, which you then manually select to import into vrealize Operations Prerequisites Create a Pivotal Cloud Foundry adapter instance and credential. Refer to section, 6.1 Creating an Adapter Instance and Credential, for details Procedure 1. Log in to vrealize Operations as an administrator. 2. Click the Administration navigation shortcut ( ). 3. Click Environment Overview (Inventory Explorer in vrops 6.1+) in the navigator pane. Figure 8: Environment Overview (Inventory Explorer) > Adapter Instances 4. Under Adapter Instances, select Pivotal Cloud Foundry Adapter Instance. 14 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

15 5. Click the Discover Resources icon ( ) to open the Discover Objects window. Figure 9: Discover Objects Window 6. In the Discover Objects window, select the following information: The Collector to use NOTE: Unless you added additional collectors, the only available collector is your vrops server. Pivotal Cloud Foundry for Adapter Type The applicable Adapter Instance Pivotal Cloud Foundry Discovery for Discovery Info Whether Only New Objects (select/de-select checkbox) should be collected 7. Click OK to start the discovery process. 8. The discovery process can take several seconds to several minutes. When it has finished, the Discovery Results window lists your resources. 9. Double-click each resource kind that contains resources to add. 10. Select options for each kind of resource. Refer to Table 3. Table 3: Resource Options OPTION Import Collect DESCRIPTION Import the resources but do not start collecting data. Resources appear in the resource list as Not Collecting; data is not stored; analysis is not performed. Import the resources and start collecting data. When you select the Collect check box, the Import check box is also selected. 11. Click OK. The Discovery Results window closes and the new resources appear What To Do Next If you did not select the option to start metric collection when you defined a resource, you can start metric collection after the resource is defined. To start collecting metrics for a resource, choose the resources, then click the Start Collecting icon ( ). 15 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

16 6.4 Validating Data Collection After you add an adapter instance, you will want to validate the data that it collects in vrealize Operations Prerequisites Add a Pivotal Cloud Foundry adapter instance. Refer to section 6.1 Creating an Adapter Instance and Credential, for details Procedure 1. Select the Environment shortcut. NOTE: If you enabled Autodiscovery for the adapter instance, it will create resources as soon as it begins collecting metrics. If you disabled Autodiscovery for the adapter instance, you must go back and discover resources manually before you can validate data collection. Refer to section 6.3 Manually Discovering Resources. 2. Under Inventory Trees, select All Objects, then expand the Pivotal Cloud Foundry objects list. 3. Select a resource from the list, then click the Troubleshooting tab and All Metrics view to validate values against the data source. Figure 10: Pivotal Cloud Foundry Adapter Objects Troubleshooting 16 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

17 7. Appendix I: Management Pack Folders and Files The installer places the Management Pack files in the pcf_adapter3 folder under the $VCOPS_BASE/user/ plugins/inbound folder as shown below. Table 4: Management Pack Folders and Files FOLDER FILE DESCRIPTION conf lib work #_PCF_ADAPTER_max_ observations.moar dashboards (folder) describe.xml describeschema.xsd historical.properties images (folder) license.properties oss_attribution.txt pcf.properties reports (folder) reskndmetrics (folder) resources (folder) scripts (folder) version.txt Refer to lib folder for entire list install.log lastcollection.properties Tracks Max Observed metrics for the adapter instance Contains.json files for Management Pack Dashboards Describes the Management Pack Used to validate describe.xml Used to enable historical mode. Allows the adapter to backfill data if collection is interrupted for any reason. Contains.png files for AdapterKind, ResourceKinds, and TraversalSpec Contains back-up copy of licenses used for this Management Pack Describes open source libraries used by the Management Pack Contains properties that can be modified to adjust adapter operation Contains.xml files for Management Pack Reports Contains.xml files for Dashboard Metric configuration Contains resources.properties file Contains.sdm files consumed by the Management Pack Contains version information.jar files that contain the classes and resources used to implement the Management Pack Tracks when the last collection for each adapter instance was performed (used when historic mode is enabled) 17 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

18 8. Appendix II: Webserver The webserver is how metrics are pulled out of the Blue Medora Firehose Nozzle. It provides a RESTful API that requires an authentication token. Token Request A token can be requested from the /token endpoint. A token times out after 60 seconds. In order to request a token, send a GET request with the two header pairs username and password with values that correspond to the UAA user in the bluemedora-firehose-nozzle.json config file. If a successful login occurs, the response will contain a header pair of token and the value will be your token. Metric Endpoints Once a valid token is acquired, a GET request with the header pair token and value of your token can be sent to one of the following endpoints: /metron_agents /syslog_drains /tps_watchers /tps_listeners /stagers /ssh_proxies /senders /route_emitters /reps /receptors /nsync_listeners /nsync_bulkers /garden_linuxs /file_servers /fetchers /convergers /cc_uploaders /bbs /auctioneers /etcds /doppler_servers /cloud_controllers /traffic_controllers /gorouters A JSON response will be sent in the following form: [ { Deployment : deployment_name, Job : job_name, Index : 0, IP : X.X.X.X, ValueMetrics :{ MetricName :integer_value, MetricName :integer_value }, CounterMetrics :{ MetricName :integer_value, MetricName :integer_value } } ] NOTE: Counter metrics are reported as totals over time. The consumer must take the delta between two totals to get the current value as time changes. 18 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

19 9. Appendix II: Revision Notes This installation guide is updated with each release of the product, or when necessary. The following table provides its revision history. REVISION DATE DESCRIPTION REV-06 REV JUN FEB-2017 Updated System Requirements to indicate support for PCF versions 1.7 and above. Updated section 6.2 Adding an SSL Certificate to the vrops Truststore to include Windows instructions REV FEB-2017 Updated Blue Medora GitHub links REV-03 REV JAN NOV-2016 Added default port information for PCF Tile, Cloud Foundry App, and BOSH Install to the Port Advanced Setting description in section 6.1 Creating an Adapter Instance and Credential. Added information to section 5. Configuring the Blue Medora Firehose Nozzle about the recommended Blue Medora Nozzle for PCF Tile method for deploying the Blue Medora Firehose Nozzle. REV SEP-2016 Initial release 19 Blue Medora VMware vrealize Operations Management Pack for Pivotal Cloud Foundry Installation & Configuration Guide

20 You can find the most up-to-date technical documentation on the Blue Medora support site at: The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: Copyright 2017 Blue Medora Inc. All rights reserved. U.S. and international copyright and intellectual property laws protect this product. Blue Medora is a registered trademark or trademark of Blue Medora in the United States and/or other jurisdictions. The Pivotal name (including Pivotal Cloud Foundry) and logo are trademarks or registered trademarks of Pivotal Software, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies. Blue Medora 3225 N Evergreen Dr. NE Suite 103 Grand Rapids, MI