Ghe integration #21929
Ghe integration #21929
Conversation
|
Hi @cbehera-newrelic 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local. If you really require a preview url, reach out to one of the writers and they will generate one for you. |
|
netlify build |
1 similar comment
|
netlify build |
🚀 Netlify Preview Building!If the build is successful, the preview for this pull request will be available at the following URL (usually takes 10-20 minutes): |
cbehera-newrelic
added
content
|
|
||
| **Prerequisites** | ||
|
|
||
| * Login to your GitHub Enterprise account you plan to integrate with New Relic. |
There was a problem hiding this comment.
| * Login to your GitHub Enterprise account you plan to integrate with New Relic. | |
| * Login to the GitHub Enterprise account you plan to integrate with New Relic. |
|
|
||
| **Prerequisites** | ||
|
|
||
| * Login to your GitHub Enterprise account you plan to integrate with New Relic. |
There was a problem hiding this comment.
How is signing in a prerequisite?
| * Docker environment to run the collector service within your GHE network. | ||
|
|
||
|
|
||
| **Architecture overview** |
There was a problem hiding this comment.
Would it be better to show this as a diagram?
|
|
||
| 1. **Create and configure a GitHub app**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**. | ||
|
|
||
| 1. **Configure Permissions**: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided. |
There was a problem hiding this comment.
Provided? Wont it be on the Docs site? Why cant we link to it?
| 1. **Create and configure a GitHub app**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**. | ||
|
|
||
| 1. **Configure Permissions**: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided. | ||
| 2. **Set Up Webhooks**: Configure the Webhook URL (which we will provide) and create a custom Event Secret for secure communication. |
There was a problem hiding this comment.
where will they find it?
| <tr> | ||
| <td>`API_KEY`</td> | ||
| <td>New Relic</td> | ||
| <td>Generate an API key from the New Relic dashboard.</td> |
There was a problem hiding this comment.
Wouldnt it be better to have deep links here?
| We will provide a sample Docker Compose file that automates the download and deployment of the service. | ||
|
|
||
| 1. Download the provided Docker Compose file. | ||
| 2. Configure the environment variables from step 2. |
|
|
||
| **Option B: Direct Docker image run** | ||
|
|
||
| You can download the Docker image directly from our Docker App registry and run it using your organization's preferred CI/CD pipeline or deployment method. |
There was a problem hiding this comment.
Link to Docker app library?
| 4. **Access the New Relic UI**: | ||
|
|
||
| 1. Once the collector service is running and the GitHub App is installed on your GHE organization(s), the corresponding GHE organizations will appear in the New Relic UI. | ||
| 2. Click **First time sync** to start the initial data synchronization. |
|
|
||
| 5. On the **GitHub Enterprise integration** screen: | ||
|
|
||
| - Click **Go to Teams** to view the imported teams information on [Teams](/docs/service-architecture-intelligence/teams/teams). |
There was a problem hiding this comment.
Go through all your instructions and align them to , , format
2 participants
No description provided.