-
Notifications
You must be signed in to change notification settings - Fork 724
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
[Onepane] Adds Onepane Integration (ECOINT-3) #2426
base: master
Are you sure you want to change the base?
Conversation
Created Jira card for Docs Team editorial review. |
Thanks for opening this PR! Dominic has reached out over email for additional information before we proceed with reviews. |
- Show changes and infrastructure events alongside errors to pinpoint potential root causes. | ||
- Enable root cause investigation by correlating incidents with change data and infrastructure data. | ||
|
||
## Setup |
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.
OAuth must be kicked off from Datadog. Please include the exact steps a user will take within Datadog to set up the integration. For example, go to the Onepane integration on the integrations page, select install, click connect accounts, log in to your onepane account, .... etc
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.
The steps below do not walk through the OAuth flow. Please update the steps to walk through OAuth steps a user will take to install the integration as mentioned above.
Users should not be creating api or app keys within their account as OAuth replaces the need for this.
onepane/manifest.json
Outdated
"media_type": "image", | ||
"caption": "Datadog Deploying", | ||
"image_url": "images/deploying.png" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "List Host Resources", | ||
"image_url": "images/host_resources.png" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "Datadog Integration", | ||
"image_url": "images/integration.png" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "Datadog Resource Mapping", | ||
"image_url": "images/onepane_mapping.png" |
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.
Some of the images should include images of your datadog dashboard (once it's updated)
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.
Please limit the images to 6 - thanks. Additionally, at least 1 image of the Datadog dashboard will need to be added as mentioned above.
- Show changes and infrastructure events alongside errors to pinpoint potential root causes. | ||
- Enable root cause investigation by correlating incidents with change data and infrastructure data. | ||
|
||
## Setup |
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.
The steps below do not walk through the OAuth flow. Please update the steps to walk through OAuth steps a user will take to install the integration as mentioned above.
Users should not be creating api or app keys within their account as OAuth replaces the need for this.
onepane/README.md
Outdated
In Onepane: | ||
|
||
Here's how to connect your Datadog account to Onepane | ||
|
||
- Access Onepane Console: Head over to the Onepane console at [console.onepane.ai][2] | ||
|
||
- Locate Integrations: In the left-hand menu, find the "Integrations" section. Click the "Add Integration" button in the top right corner. | ||
|
||
- Choose Datadog: From the list of available integrations, select "Datadog". | ||
|
||
- When you select Datadog, you will be redirected to the Datadog login page. | ||
|
||
- Authenticate with OAuth. | ||
|
||
- Log in using your Datadog credentials. | ||
|
||
- Upon successful authentication, Datadog will create an API key for you. | ||
|
||
- Provide a name for your Datadog connector. | ||
|
||
- Input the site URL and Application key obtained from the ![prerequisite steps][8]. | ||
|
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.
OAuth must be intiated from Datadog. To make OAuth work for users across all Datadog regions, you will need to ensure that you’re making the correct API calls based on their region. When the user kicks off authorization from the Datadog tile, a site parameter is sent on redirect from the onboarding_url. You will use this site parameter in your calls to the Authorize and Token endpoints. Please note that if a user kicks off authorization directly from your platform, this site parameter will not be sent, and the user will be prompted to select their site on the Datadog authorize page.
onepane/README.md
Outdated
|
||
- Confirm Deletion: A confirmation dialog might appear. If you're certain you want to proceed, click "Confirm" to remove the Datadog integration. | ||
|
||
When deleting the Datadog integration, the OAuth-generated API keys and other credentials will be soft-deleted and permanently deleted after 7 days. |
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.
Please update this to reflect Datadogs OAuth uninstallation steps
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.
Hi @sajosam in addition to the remaining comments from @emarsha94 , I added a few more suggestions, please let me know when resolved and I'll re-review, thanks!
onepane/manifest.json
Outdated
"media_type": "image", | ||
"caption": "Datadog Deploying", | ||
"image_url": "images/deploying.png" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "List Host Resources", | ||
"image_url": "images/host_resources.png" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "Datadog Integration", | ||
"image_url": "images/integration.png" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "Datadog Resource Mapping", | ||
"image_url": "images/onepane_mapping.png" |
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.
Please limit the images to 6 - thanks. Additionally, at least 1 image of the Datadog dashboard will need to be added as mentioned above.
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.
approving the changes I requested, thanks for updating !
What does this PR do?
This PR adds documentation for the Onepane integration, including an overview, setup instructions, uninstallation steps, and information about data collected
Motivation
The motivation is to provide users with clear instructions on how to connect Datadog to Onepane, enabling them to leverage additional value from their existing Datadog investments. This integration allows users to correlate incidents with change data and infrastructure data, potentially improving root cause analysis and incident resolution
Review checklist
no-changelog
label attachedAdditional Notes
Anything else we should know when reviewing?