[Onepane] Adds Onepane Integration (ECOINT-3) #2426

sajosam · 2024-06-25T09:04:43Z

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

PR has a meaningful title or PR has the no-changelog label attached
Feature or bugfix has tests
Git history is clean
If PR impacts documentation, docs team has been notified or an issue has been opened on the documentation repo
If this PR includes a log pipeline, please add a description describing the remappers and processors.

Additional Notes

Anything else we should know when reviewing?

…tras

drichards-87 · 2024-06-25T14:40:07Z

Created Jira card for Docs Team editorial review.

eho1307 · 2024-07-02T14:20:24Z

Thanks for opening this PR! Dominic has reached out over email for additional information before we proceed with reviews.

onepane/README.md

emarsha94 · 2024-08-06T14:23:43Z

onepane/README.md

+- 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


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

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/assets/dashboards/onepane_overview.json

onepane/manifest.json

onepane/README.md

emarsha94 · 2024-08-06T14:30:31Z

onepane/manifest.json

+        "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"


Some of the images should include images of your datadog dashboard (once it's updated)

Please limit the images to 6 - thanks. Additionally, at least 1 image of the Datadog dashboard will need to be added as mentioned above.

…ontent

emarsha94 · 2024-08-08T15:19:42Z

onepane/README.md

+- 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


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.

emarsha94 · 2024-08-08T15:22:04Z

onepane/README.md

+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].
+


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.

emarsha94 · 2024-08-08T15:22:28Z

onepane/README.md

+
+- 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.


Please update this to reflect Datadogs OAuth uninstallation steps

aliciascott

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/README.md

onepane/manifest.json

onepane/assets/logos/onepane_dark.png

emarsha94 · 2024-08-23T16:12:53Z

onepane/manifest.json

+        "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"


Please limit the images to 6 - thanks. Additionally, at least 1 image of the Datadog dashboard will need to be added as mentioned above.

aliciascott

approving the changes I requested, thanks for updating !

sajosam and others added 3 commits May 21, 2024 14:42

Added onepane to integration

f1eaa4b

images and dashboard added

71fda56

updated dashboard added

cd0c3fa

sajosam requested review from a team as code owners June 25, 2024 09:04

sajosam and others added 6 commits June 25, 2024 14:35

Merge branch 'master' into master

ff315d8

Added hoepage for code owners

4cfe412

Merge branch 'master' of https://github.com/onepaneai/integrations-ex…

d878fd4

…tras

removed duplicate ID

356b309

remobed non-unique valules

5ddeca3

changed code owners

7c04839

drichards-87 added the editorial review Waiting on a more in-depth review from a docs team editor label Jun 25, 2024

sajosam added 2 commits June 28, 2024 10:12

Merge branch 'master' into master

0406f2d

Merge branch 'master' into master

1431836

aliciascott added the product/review-requested label Jul 1, 2024

eho1307 added kind/technology-partner product/HOLD labels Jul 2, 2024

datadog-assets bot added docs/review-requested ecosystems/review-requested labels Jul 2, 2024

sajosam and others added 5 commits July 3, 2024 14:22

Merge branch 'master' into master

8511cfd

Merge branch 'master' into master

6465a52

Merge branch 'master' into master

d35def7

Merge branch 'master' into master

e52f6fc

Oauth client published

b8e2233

emarsha94 requested changes Aug 6, 2024

View reviewed changes

datadog-assets bot added product/requested-changes and removed product/review-requested labels Aug 6, 2024

sajosam and others added 5 commits August 7, 2024 20:20

Merge branch 'master' into master

682262d

Merge branch 'master' into master

f84ebad

updated the dashboard as u provided via email. and also updated the c…

b2f5d03

…ontent

Merge remote-tracking branch 'refs/remotes/origin/master'

8adea64

image ratio changed

eb80dd6

emarsha94 requested changes Aug 8, 2024

View reviewed changes

sajosam and others added 7 commits August 18, 2024 22:35

Updated docs to reflect new Datadog OAuth flow

ffdca95

remvoed localhost

fbfdac7

Merge branch 'master' into master

5096ef4

fixed oauth client.json

2669046

Merge remote-tracking branch 'refs/remotes/origin/master'

18c78a4

Added Public client id

1c38c4c

fixed image size

d597721

aliciascott requested changes Aug 22, 2024

View reviewed changes

datadog-assets bot added docs/requested-changes and removed docs/review-requested labels Aug 22, 2024

sajosam and others added 2 commits August 23, 2024 15:21

changes updated

86f2b56

Merge branch 'master' into master

6eae062

dd-dominic changed the title ~~[Onepane] Adds Onepane Integration~~ [Onepane] Adds Onepane Integration (ECOINT-3) Aug 23, 2024

emarsha94 requested changes Aug 23, 2024

View reviewed changes

sajosam added 2 commits August 24, 2024 14:16

logo replaced with svg format and limit the images to 6

5a0d9d1

Merge remote-tracking branch 'refs/remotes/origin/master'

6070c7d

DrkSephy approved these changes Aug 26, 2024

View reviewed changes

Merge branch 'master' into master

c8663f7

aliciascott approved these changes Sep 4, 2024

View reviewed changes

datadog-assets bot added docs/approved and removed docs/requested-changes labels Sep 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Onepane] Adds Onepane Integration (ECOINT-3) #2426

[Onepane] Adds Onepane Integration (ECOINT-3) #2426

sajosam commented Jun 25, 2024

drichards-87 commented Jun 25, 2024

eho1307 commented Jul 2, 2024

emarsha94 Aug 6, 2024

emarsha94 Aug 8, 2024

emarsha94 Aug 6, 2024

emarsha94 Aug 23, 2024

emarsha94 Aug 8, 2024

emarsha94 Aug 8, 2024

emarsha94 Aug 8, 2024

aliciascott left a comment

emarsha94 Aug 23, 2024

aliciascott left a comment


		- 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.

[Onepane] Adds Onepane Integration (ECOINT-3) #2426

Are you sure you want to change the base?

[Onepane] Adds Onepane Integration (ECOINT-3) #2426

Conversation

sajosam commented Jun 25, 2024

What does this PR do?

Motivation

Review checklist

Additional Notes

drichards-87 commented Jun 25, 2024

eho1307 commented Jul 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aliciascott left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aliciascott left a comment

Choose a reason for hiding this comment