-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs-website for github integration #19286
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
--- | ||
title: Seamlessly adopt New Relic Service catalog with the GitHub integration | ||
tags: | ||
- New Relic integrations | ||
- GitHub integration | ||
metaDescription: Set up automatic ingestion of your GitHub Dependabot events by using webhook for ongoing ingestion. | ||
freshnessValidatedDate: 2024-10-29 | ||
--- | ||
|
||
|
||
Implementing a New Relic Service Catalog can unlock considerable benefits, but at present, it requires a considerable investment of time and resources. You have to take care of team orchestration, user provisioning, role assignments, and entity ownership delineation, which create a significant threshold for entry. To ease this challenge, we suggest the adoption of an automation solution that capitalizes on existing team configurations and relationships maintained in external systems such as GitHub. This simplifies the initial configuration, dramatically lessen the required effort, and accelerates the adoption of the New Relic Service Catalog, making its powerful insights and organization tools more accessible to users. | ||
Check warning on line 11 in src/content/docs/infrastructure/host-integrations/host-integrations-list/github-integration.mdx
|
||
|
||
<img | ||
title="GitHub Integration dashboard" | ||
alt="GitHub Integration dashboard" | ||
src="/images/github-integration-screenshot.webp" | ||
/> | ||
|
||
<figcaption> | ||
After setting up our GitHub integration, see your data of teams, repos and users right out of the box. | ||
</figcaption> | ||
|
||
## Prerequisites [#prerequisites] | ||
|
||
Users need to ensure that they're logged in to their GitHub accounts. This needs to be the same GitHub account in which they want to install the GitHub app that New Relic will be providing during installation step. | ||
|
||
|
||
## Set up the GitHub integration [#set-up-github] | ||
|
||
Vist <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > + Integrations & Agents** > GitHub integration</DNT> tile and follow the below steps to complete the GitHub integration. | ||
|
||
<Steps> | ||
<Step> | ||
|
||
## Service Catalog Details [#service-catalog-details] | ||
|
||
In this installation step, we will be asked to enable/disable the Power Service catalog option. Power Service catalog provides the users the ability to import all the data related to Teams, Repositories, Pull Request, Pull Request Review and Deployment. | ||
Check warning on line 37 in src/content/docs/infrastructure/host-integrations/host-integrations-list/github-integration.mdx
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In this step, you have to enable or disable the Power Service catalog option. This option provides users the ability to import all data related to teams, repositories, pull requests, pull request reviews, and deployments. |
||
|
||
Users can enable it for importing all the items mentioned in the Power Service Catalog. Disabling it, users will only be able to import basic information about the teams and repositories. | ||
</Step> | ||
|
||
<Step> | ||
|
||
## GitHub Integration [#github-integration] | ||
|
||
<img | ||
title="GitHub Integration dashboard" | ||
alt="GitHub Integration dashboard" | ||
src="/images/github-integration-progress.webp" | ||
/> | ||
|
||
As a next step of installation, we need to click on the install button. Then we get redirected to the GitHub App installation page. This app is provided by New Relic to help fetch the user's GitHub account related information. | ||
Check warning on line 52 in src/content/docs/infrastructure/host-integrations/host-integrations-list/github-integration.mdx
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Next, click |
||
|
||
Once the installation is complete, we will see the result page which will dynamically list down the retrieved GitHub data related to teams, repos, pull requests and deployments. It will take some time to fetch the complete inforamtion, hence the page will keep refreshing after every 10 seconds till we've the power service catalog ready. | ||
|
||
The result obtained will look like the below: | ||
|
||
| Category | Content | | ||
| --- | --- | | ||
| Teams | List of teams within the GitHub organization | | ||
| Repositories | List of repositories owned by the GitHub account | | ||
| Pull Requests | List of open and closed pull requests | | ||
| Deployments | List of deployment events | | ||
|
||
These list items will be clickable links that will open up new tabs with more information like this below: | ||
<img | ||
title="GitHub Integration dashboard" | ||
alt="GitHub Integration dashboard" | ||
src="/images/github-integration-success.webp" | ||
/> | ||
</Step> | ||
</Steps> | ||
|
||
To learn more about installing GitHub apps to your account, you can visit this site https://docs.github.com/en/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Implementing a New Relic Service Catalog can unlock considerable benefits, but it requires considerable time and resources. You have to take care of team orchestration, user provisioning, role assignments, and entity ownership delineation. These create a significant threshold for entry. To ease this challenge, consider an automation solution that capitalizes on existing team configurations and relationships maintained in external systems such as GitHub. This simplifies the initial configuration and accelerates the adoption of the New Relic Service Catalog.