New Relic NGINX integration buildpack for VMware Tanzu

Build the buildpack

1. Clone the buildpack repository to your system:
   bash

   Copy

   $
   git clone https://github.com/newrelic/newrelic-pcf-nginx-buildpack

2. Change directory to the cloned buildpack.
3. Source the .envrc file in the buildpack directory:
   bash

   Copy

   $
   source .envrc

4. Install Bosh CLI and Tile Generator:
   bash

   Copy

   $
   ./scripts/setup.sh

5. To build the buildpack, you have two options:

• Only build the buildpack:

  bash

  Copy

  $
  make clean
  $
  make package

  The following buildpacks will be generated:

  • build/newrelic_nginx_buildpack-cached-cflinuxfs4-v*.zip

  • build/newrelic_nginx_buildpack-cached-cflinuxfs3-v*.zip

    OR

• Build the buildpack by creating a tile:

  bash

  Copy

  $
  make clean
  $
  make all

  The following tile will be generated:

  • product/newrelic-pcf-nginx-buildpack-*.pivotal

Deploy to Cloud Foundry

1. Upload the buildpack to Cloud Foundry and optionally specify it by name using the CF CLI:

   bash

   Copy

   $
   cf create-buildpack newrelic_nginx_buildpack [BUILDPACK_ZIP_FILE_PATH] 99

2. Create a folder named example and download the example.tar.gz archive:

   bash

   Copy

   $
   mkdir example
   $
   cd example
   $
   wget https://github.com/newrelic/newrelic-pcf-nginx-buildpack/releases/download/v1.0.1/example.tar.gz

   About the example directory

   The example directory contains various artifacts necessary for the buildpack. Below is a description of each artifact and related documentation for reference:

   example/
   ├── buildpack.yml
   ├── manifest.yml
   ├── mime.types
   ├── nginx-config.yml
   ├── nginx.conf
   └── public
       └── index.html

   Copy

   Artifacts descriptions:

   • buildpack.yml:

     • Contains configuration for the buildpack.
     • Action required: Update the NGINX version information to ensure compatibility with the latest version of the NGINX buildpack.

   • manifest.yml:

     • Defines the application-related configurations and metadata.
     • Action required: Update this file with the correct application information and ensure the buildpack order is correctly specified. This is crucial for the proper deployment of your application.
     • New Relic license key: This integration requires a license key. You can set it in the manifest.yml file using the environment variable NEW_RELIC_LICENSE_KEY: <ingest_key_value>. Alternatively, the license key can be obtained from the New Relic service broker by binding the application.
     • Status port: Based on your NGINX configuration, the status port information is required. The default port value is 8080, which can be set using the environment variable STATUS_PORT: 8080.
       • Note: Additional environmental variables can be set as per your requirements.
     • The nginx_buildpack must be installed before newrelic_nginx_buildpack.
       • Example: cf push my_app -b nginx_buildpack -b newrelic_nginx_buildpack
       • See the following pages for reference:
         • Use multiple buildpacks
         • nginx_buildpack documentation

   • mime.types:

     • Specifies MIME types required by the NGINX buildpack.
     • Note: Required by the NGINX buildpack for serving different file types with appropriate MIME types.

   • nginx.conf:

     • A primary template configuration file for NGINX.
     • Note: Required by the NGINX buildpack to configure how NGINX serves the application. Ensure that location /nginx_status in nginx.conf matches the STATUS_URL in nginx-config.yml.

   • nginx-config.yml:

     • This template contains configuration settings for New Relic NGINX integration.
     • Action required: Refer to the New Relic NGINX documentation to understand various configuration options and adjust settings as necessary.
     • Note: Ensure that the location /nginx_status in nginx.conf matches the STATUS_URL in nginx-config.yml.

   • public:

     • Contains static files that NGINX will serve.
     • Note: The index.html file is crucial as the default file served by NGINX.

   Additional notes:

   • Ensure all configuration files are updated according to the latest documentation and version requirements.
   • Proper configuration is essential for the correct functionality of the buildpack and the application it serves.

3. Push the application using the cf push command by using the manifest.yml:

   bash

   Copy

   $
   cf push

(Optional) Bind your application to New Relic Broker Service

To integrate your application with the New Relic Broker Service, follow these steps:

1. Use the Cloud Foundry CLI to create a New Relic service instance:

   bash

   Copy

   $
   cf create-service newrelic <NEWRELIC_PLAN_NAME> <YOUR_NEWRELIC_SERVICE_INSTANCE_NAME>

   Make sure you replace <NEWRELIC_PLAN_NAME> with the desired New Relic plan and <YOUR_NEWRELIC_SERVICE_INSTANCE_NAME> with a name for your service instance.

2. Bind your application to the New Relic service instance using the CF CLI:

   bash

   Copy

   $
   cf bind-service my_app <YOUR_NEWRELIC_SERVICE_INSTANCE_NAME>

   Make sure to replace my_app with the name of your application and <YOUR_NEWRELIC_SERVICE_INSTANCE_NAME> with the name of the New Relic service instance you created.

3. Specify the New Relic service instance in the services section of your application's manifest.yml file:

   services:
     - <YOUR_NEWRELIC_SERVICE_INSTANCE_NAME>

   Copy

4. Deploy your application with the updated manifest:

   bash

   Copy

   $
   cf push