https://github.com/shyamz-22/newrelic-deployment-resource

A concourse resource for adding newrelic deployment markers
https://github.com/shyamz-22/newrelic-deployment-resource

concourse concourse-ci-resource concourse-resource newrelic python

Last synced: 3 days ago
JSON representation

A concourse resource for adding newrelic deployment markers

• Host: GitHub
• URL: https://github.com/shyamz-22/newrelic-deployment-resource
• Owner: shyamz-22
• License: mit
• Created: 2019-05-26T17:02:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-11T11:51:52.000Z (over 3 years ago)
• Last Synced: 2023-05-04T05:41:05.912Z (over 1 year ago)
• Topics: concourse, concourse-ci-resource, concourse-resource, newrelic, python
• Language: Python
• Size: 13.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Docker](https://dockeri.co/image/shyamz22/newrelic-resource)

# New Relic Resource for Concourse

An output only opinionated concourse resource for adding deployment markers in New Relic

## New Relic Deployment markers

Details of Deployment markers can be found [here](https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/record-deployments)

## Source Configuration

* `api_key`: *Required.* Rest API key for adding deployment markers to an application

* `user`: *Required.* This Username will appear in the deployments dashboard

## `out`: Add a deployment marker

In order to add an deployment marker, a revision number and a description may be provided to the New Relic API.

For this purpose provide a `git` resource in the put step so that New Relic concourse resource

takes the **revision**  from `(SHA of origin/HEAD commit)` and **description** from `(Commit message of origin/HEAD commit)`.

* `git_src_directory`: *Required.* source code of the deployed version. Format is `/tmp/build/put/<>`

* `api_url`: *Mandatory.* Deployment [REST api endpoint](https://rpm.newrelic.com/api/explore/application_deployments/create)  

* `app_id`: *Optional* (`deprecated` in favour of api_url) Application ID from New Relic, if `api_url` is not provided this defaults to **US API endpoint**

## Example Pipeline

```yaml

resource_types:

- name: newrelic-deployment-marker

  type: docker-image

  source:

    repository: shyamz22/newrelic-resource

    tag: latest

resources:

- name: src

  type: git

  source:

    uri: [email protected]:shyamz-22/PactIt.git

    branch: master

    private_key: ((git-key))

- name: deployment-marker

  type: newrelic-deployment-marker

  source:

    api_key: ((newrelic-rest-api-key))

    user: [email protected]

jobs:

- name: deploy

  plan:

  - get: src # <-- 🤓 source code of deployed app

    trigger: true

  - task: deploy

    config:

      platform: linux

      image_resource:

        type: docker-image

        source:

          repository: alpine

      inputs:

      - name: src

      run:

        path: sh

        args:

        - -exc

        - |

          export TERM=dumb

          set -x

          # deploy

          echo "deployment-successful"

  on_success:

    put: deployment-marker

    params:

      git_src_directory: /tmp/build/put/src # <-- 🤓

      api_url: https://api.newrelic.com/v2/applications/((app-id))/deployments.json

```