diff --git a/docs-content/index.html.md.erb b/docs-content/index.html.md.erb index b1f93e3..e09f711 100644 --- a/docs-content/index.html.md.erb +++ b/docs-content/index.html.md.erb @@ -1,12 +1,12 @@ --- -title: New Relic Nozzle for PCF +title: New Relic Nozzle for Pivotal Platform owner: Partners ---
-This documentation describes [New Relic Nozzle for Pivotal Cloud Foundry (PCF)](https://network.pivotal.io/products/nr-firehose-nozzle/). +This documentation describes [New Relic Nozzle for Pivotal Platform](https://network.pivotal.io/products/nr-firehose-nozzle/). -New Relic Nozzle for PCF collects metrics and events that are generated by all PCF components and applications that run on PCF Diego cells via the [Loggregator Firehose](https://docs.pivotal.io/pivotalcf/loggregator/index.html). It pushes this data to [New Relic](https://www.newrelic.com) to be ingested by New Relic Insights for dashboarding and visualization. +New Relic Nozzle for Pivotal Platform collects metrics and events that are generated by all Pivotal Platform components and applications that run on Pivotal Platform Diego cells via the [Loggregator Firehose](https://docs.pivotal.io/pivotalcf/loggregator/index.html). It pushes this data to [New Relic](https://www.newrelic.com) to be ingested by New Relic Insights for dashboarding and visualization.
@@ -16,19 +16,19 @@ New Relic Nozzle for PCF collects metrics and events that are generated by all P ## Overview -Once you install New Relic Nozzle for PCF, it starts collecting and pushing Firehose events to New Relic Insights for visualization. New Relic organizes the Firehose data based on Firehose event types, and shows each Firehose event type in its own separate dashboard. +Once you install New Relic Nozzle for Pivotal Platform, it starts collecting and pushing Firehose events to New Relic Insights for visualization. New Relic organizes the Firehose data based on Firehose event types, and shows each Firehose event type in its own separate dashboard. -The nozzle can be installed as a tile in Ops Manager, or deployed using the CLI command **cf push** as a regular application. You can then monitor the health and performance of your PCF deployments, and set alerts based on any metrics that are collected from PCF Firehose. +The nozzle can be installed as a tile in Ops Manager, or deployed using the CLI command **cf push** as a regular application. You can then monitor the health and performance of your Pivotal Platform deployments, and set alerts based on any metrics that are collected from Pivotal Platform Firehose. ## Key Features You can filter the nozzle dashboards that allow you to visualize the Firehose metrics and events. -You can monitor the health and performance of PCF components with the following categories: +You can monitor the health and performance of Pivotal Platform components with the following categories: - * PCF Domain - * PCF Deployment + * Pivotal Platform Domain + * Pivotal Platform Deployment * Firehose Event Type * Origin * Job @@ -71,7 +71,7 @@ tab based on the following event properties: ## Product Snapshot -The following table provides version and version-support information about New Relic Nozzle for PCF. +The following table provides version and version-support information about New Relic Nozzle for Pivotal Platform. @@ -108,12 +108,12 @@ The following table provides version and version-support information about New R ## Compatibility -This project has been tested and is compatible with PCF versions v2.3.x through v2.6.x. +This project has been tested and is compatible with Pivotal Platform versions v2.3.x through v2.6.x. ## Requirements -New Relic Nozzle for PCF has the following requirements: +New Relic Nozzle for Pivotal Platform has the following requirements: * An active New Relic account with a Pro or Pro Trial license * New Relic Insights included in the license diff --git a/docs-content/installing.html.md.erb b/docs-content/installing.html.md.erb index 8044641..b2d4c67 100644 --- a/docs-content/installing.html.md.erb +++ b/docs-content/installing.html.md.erb @@ -1,22 +1,22 @@ --- -title: Installing and Configuring New Relic Nozzle for PCF +title: Installing and Configuring New Relic Nozzle for Pivotal Platform owner: Partners --- -This topic describes how to install and configure New Relic Nozzle for Pivotal Cloud Foundry (PCF). +This topic describes how to install and configure New Relic Nozzle for Pivotal Platform. -You can either install the New Relic Nozzle for PCF as a tile in Ops Manager, or push it as a regular application. +You can either install the New Relic Nozzle for Pivotal Platform as a tile in Ops Manager, or push it as a regular application. -## Install and Configure New Relic Nozzle for PCF as a Tile in Ops Manager +## Install and Configure New Relic Nozzle for Pivotal Platform as a Tile in Ops Manager 1. Download the product file from [Pivotal Network](https://network.pivotal.io/products/nr-firehose-nozzle/). 1. Navigate to the Ops Manager Installation Dashboard and click **Import a Product** to upload the product file. -1. Under the **Import a Product** button, click the **+** sign next to the version number of New Relic Nozzle for PCF. This adds the tile to your staging area. +1. Under the **Import a Product** button, click the **+** sign next to the version number of New Relic Nozzle for Pivotal Platform. This adds the tile to your staging area. -1. Click the newly added **New Relic Nozzle for PCF** tile. +1. Click the newly added **New Relic Nozzle for Pivotal Platform** tile. 1. Follow the steps below to configure the nozzle tile: * Under **New Relic Firehose Nozzle > Settings > Assign AZs and Networks:** @@ -62,8 +62,8 @@ The following properties can be obtained either from Pivotal Application Service * Insights Insert Key: An insert key from `https://insights.newrelic.com/accounts/RPM-ID/manage/api_keys`. * User Name: `Ops Manager -> Pivotal Application Service -> Credentials -> Job -> UAA -> Opentsdb Nozzle Credentials -> Link to Credential -> identity`
(Only for Application push) * Password: `Ops Manager -> Pivotal Application Service -> Credentials -> Job -> UAA -> Opentsdb Nozzle Credentials -> Link to Credential -> password`
(Only for Application push) - * UAA URL: `https://uaa.YOUR-PCF-DOMAIN` -- `cf curl /v2/info`
(Only for Application push) - * Traffic Controller URL: `wss://doppler.PCF-DOMAIN:SSL-PORT` -- `cf curl /v2/info`
(Only for Application push) + * UAA URL: `https://uaa.YOUR-Pivotal Platform-DOMAIN` -- `cf curl /v2/info`
(Only for Application push) + * Traffic Controller URL: `wss://doppler.Pivotal Platform-DOMAIN:SSL-PORT` -- `cf curl /v2/info`
(Only for Application push) * Admin User Name: `Ops Manager -> Pivotal Application Service -> Credentials -> Job -> UAA -> Admin Credentials -> Link to Credential -> identity`
(Only for Application push) * Admin Password: `Ops Manager -> Pivotal Application Service -> Credentials -> Job -> UAA -> Admin Credentials -> Link to Credential -> password`
(Only for Application push) @@ -74,9 +74,9 @@ The following properties can be obtained either from Pivotal Application Service 1. Return to the Ops Manager Installation Dashboard and click **Apply Changes**. -## Install and Configure New Relic Nozzle for PCF as an Application +## Install and Configure New Relic Nozzle for Pivotal Platform as an Application -When pushing New Relic Nozzle for PCF as an application, you need to have a manifest with the following properties: +When pushing New Relic Nozzle for Pivotal Platform as an application, you need to have a manifest with the following properties: ``` applications: @@ -92,9 +92,9 @@ When pushing New Relic Nozzle for PCF as an application, you need to have a mani env: NOZZLE_USERNAME: NOZZLE-USER NOZZLE_PASSWORD: NOZZLE-PASSWORD - NOZZLE_API_URL: https://api.YOUR-PCF-DOMAIN - NOZZLE_UAA_URL: https://uaa.YOUR-PCF-DOMAIN - NOZZLE_TRAFFIC_CONTROLLER_URL: wss://doppler.YOUR-PCF-DOMAIN:SSL-PORT + NOZZLE_API_URL: https://api.YOUR-Pivotal Platform-DOMAIN + NOZZLE_UAA_URL: https://uaa.YOUR-Pivotal Platform-DOMAIN + NOZZLE_TRAFFIC_CONTROLLER_URL: wss://doppler.YOUR-Pivotal Platform-DOMAIN:SSL-PORT NOZZLE_FIREHOSE_SUBSCRIPTION_ID: newrelic.firehose NOZZLE_SKIP_SSL: true/false NOZZLE_SELECTED_EVENTS: Comma-separated list of event types @@ -128,7 +128,7 @@ When pushing New Relic Nozzle for PCF as an application, you need to have a mani ### Application Build and Deploy -The application is already built and ready to run on PCF. If you make any changes to the code, or would like to run on other operating systems, you can rebuild the binary. +The application is already built and ready to run on Pivotal Platform. If you make any changes to the code, or would like to run on other operating systems, you can rebuild the binary. 
 $ env GOOS=<OS-name> GOARCH=amd64 go build -o dist/nr-nozzle
@@ -153,4 +153,4 @@ You can specify the values for these properties during the setup of the tile in
    
 * These environment variables must be in lower case.
 * You must set `http_proxy` to your proxy server address and port (i.e. `http://my_proxyserver:my_proxy_port`).
-* You must set `no_proxy` to any address that you need to bypass. In order for the nozzle to work properly with proxies, you must bypass the `doppler` server (`doppler.YOUR-PCF-DOMAIN.com`). Make sure you do not include the protocol and the port for `no_proxy`. Just add the server name.
+* You must set `no_proxy` to any address that you need to bypass. In order for the nozzle to work properly with proxies, you must bypass the `doppler` server (`doppler.YOUR-Pivotal Platform-DOMAIN.com`). Make sure you do not include the protocol and the port for `no_proxy`. Just add the server name.
diff --git a/docs-content/release-notes.html.md.erb b/docs-content/release-notes.html.md.erb
index 1a691b8..01325dd 100644
--- a/docs-content/release-notes.html.md.erb
+++ b/docs-content/release-notes.html.md.erb
@@ -1,9 +1,9 @@
 ---
-title: Release Notes for New Relic Nozzle for PCF
+title: Release Notes for New Relic Nozzle for Pivotal Platform
 owner: Partners
 ---
 
-These are release notes for New Relic Nozzle for PCF.
+These are release notes for New Relic Nozzle for Pivotal Platform.
 
 
 ##  v1.1.21
@@ -13,7 +13,7 @@ These are release notes for New Relic Nozzle for PCF.
 Features included in this release:
 
 * Fixed problem with printing error logs
-* Tested on PCF up to and including v2.6
+* Tested on Pivotal Platform up to and including v2.6
 
 
 ##  v1.1.20
@@ -23,7 +23,7 @@ Features included in this release:
 Features included in this release:
 
 * Added support for New Relic EU data center
-* Tested on PCF up to and including v2.6
+* Tested on Pivotal Platform up to and including v2.6
 
 
 ##  v1.1.19
@@ -35,7 +35,7 @@ Features included in this release:
 * Added New Relic Insights GO library for improved connection to New Relic Insights
 * Improved error handling and error messages
 * Added accessors to obtain system information during the tile configuration
-* Tested on PCF up to and including v2.6
+* Tested on Pivotal Platform up to and including v2.6
 
 
 ##  v1.1.17
@@ -45,7 +45,7 @@ Features included in this release:
 Features included in this release:
 
 * updated to BOSH Release 1.16.0 (corresponds to version 6.45.0 of the CF CLI)
-* Tested on PCF up to and including v2.6
+* Tested on Pivotal Platform up to and including v2.6
 
 
 ##  v1.1.16
@@ -56,7 +56,7 @@ Features included in this release:
 
 * Added HTTP healthcheck
 * Improved error handling when connecting to other systems
-* Tested on PCF v2.3 and v2.4
+* Tested on Pivotal Platform v2.3 and v2.4
 
 
 ##  v1.1.14
@@ -77,7 +77,7 @@ Features included in this release:
 Features included in this release:
 
 * Added maximum number of events to upload to New Relic in every packet
-* Tested and verified on PCF v2.2.x and v2.3.x
+* Tested and verified on Pivotal Platform v2.2.x and v2.3.x
 
 Bug Fixes:
 
@@ -91,7 +91,7 @@ Bug Fixes:
 Features included in this release:
 
 * Extends filtering capabilities of the nozzle to allow exclusion and inclusion of events with selected deployment, origin, and/or job names
-* Tested and verified on PCF v2.2.x and PCF v2.3.x
+* Tested and verified on Pivotal Platform v2.2.x and Pivotal Platform v2.3.x
 
 
 ##  v1.0.4
@@ -100,10 +100,10 @@ Features included in this release:
 
 Features included in this release:
 
-* Allows PCF admin to set number of nozzle instances in the tile
+* Allows Pivotal Platform admin to set number of nozzle instances in the tile
 * Collects more Application details (`org name`, `space name`, `application name`, stack guid, etc.) in ContainerMetric events
 * Allows filtering of unwanted Firehose events
-* Tested and verified on PCF v2.0.x and v2.1.x
+* Tested and verified on Pivotal Platform v2.0.x and v2.1.x
 
 
 ##  v0.8.0 
diff --git a/docs-content/using.html.md.erb b/docs-content/using.html.md.erb
index 27de2e8..04ddcd5 100644
--- a/docs-content/using.html.md.erb
+++ b/docs-content/using.html.md.erb
@@ -1,14 +1,14 @@
 ---
-title: Using New Relic Nozzle for PCF
+title: Using New Relic Nozzle for Pivotal Platform
 owner: Partners
 ---
 
-This topic describes how to use New Relic Nozzle for Pivotal Cloud Foundry (PCF).
+This topic describes how to use New Relic Nozzle for Pivotal Platform.
 
 
-##  Using New Relic Nozzle for PCF
+##  Using New Relic Nozzle for Pivotal Platform
 
-Metrics and events the PCF Loggregator Firehose collects are visualized in dashboards in New Relic Insights. These dashboards allow you to filter the data by various metrics.
+Metrics and events the Pivotal Platform Loggregator Firehose collects are visualized in dashboards in New Relic Insights. These dashboards allow you to filter the data by various metrics.
 
 For example, in the **Container Metrics** dashboard, you can filter the data by **CF Origins**, **Jobs**, and **IP address**. Then you can select an application ID to narrow down to the data coming only from one application. Furthermore, if you would like to see the performance of one application container, you can select one of the containers by clicking on the container index, filtering the data in the dashboard, and drilling down to the data for only one application container.
 
@@ -29,7 +29,7 @@ select average(containerMetricCpuPercentage) from PcfFirehoseEvent facet contain
 select count(*) from  PcfFirehoseEvent where FirehoseEventType = 'HttpStartStop' facet httpStatusCode
 ```
 
-Events from all PCF deployments end up in **PcfFirehoseEvent**. If you collect events from multiple PCF environments, you can use **pcfDomain** and **pcfInstanceIp** metrics to distunguish between events from different PCF deploments (either in a **WHERE** clause or by **FACET**ing the events by **pcfDomain**).
+Events from all Pivotal Platform deployments end up in **PcfFirehoseEvent**. If you collect events from multiple Pivotal Platform environments, you can use **pcfDomain** and **pcfInstanceIp** metrics to distunguish between events from different Pivotal Platform deploments (either in a **WHERE** clause or by **FACET**ing the events by **pcfDomain**).
 
 
 ##  Obtaining Insights Pre-Built Dashboards
Element