Skip to content

Commit 3a7751e

Browse files
bethh0rnbethh0rn
authored
Merge pull request #973 from ritza-co/edit-1125-pagerduty
1125: Proofread pagerduty-integration.mdx
2 parents b13b8cd + 7f1836d commit 3a7751e

File tree

1 file changed

+74
-66
lines changed

1 file changed

+74
-66
lines changed

‎docs/integration/external-integrations/pagerduty-integration.mdx‎

Lines changed: 74 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This guide walks you through creating a PagerDuty Service, setting up the integr
1414

1515
## Alert Types
1616

17-
You can customize alerts sent from Device42 by choosing from wide range of violating conditions from a set of **Rule Types**, such as Discovery, Operating System, Part Model, Software, and more. Choose from a range of available triggers for each rule type that include, but are not limited to, the following:
17+
You can customize alerts sent from Device42 by choosing from a wide range of violating conditions within a set of **Rule Types**, such as Discovery, Operating System, Part Model, Software, and more. Choose from various available triggers for each rule type. These triggers include, but are not limited to, the following:
1818

1919
Operating System
2020

@@ -54,18 +54,18 @@ System
5454

5555
## How it Works
5656

57-
Device42 metrics that fall outside of a designated range or meet a given criteria will send an alert to a service in PagerDuty.
57+
When a Device42 metric falls outside of a designated range or meets a given criterion, Device42 sends an alert to a service in PagerDuty.
5858

5959
## Requirements
6060

61-
- Device42 version 16.14.00 and later.
62-
- Network access to one of the Device42 Cloud Connectors. For example, `connect.device42.net` (US) or `connect-eu.device42.net` (EU).
61+
- Device42 version 16.14.00 and later
62+
- Network access to one of the Device42 Cloud Connectors, such as `connect.device42.net` (US) or `connect-eu.device42.net` (EU)
6363

6464
## Support
6565

6666
If you need help with this integration, please contact **Device42 Support** using any of our listed contact methods.
6767

68-
- **Hours of Operation:** Monday-Friday, 9AM – 6PM EST
68+
- **Hours of Operation:** Monday-Friday, 9 am–6 pm EST
6969
- **Phone:** 1 (844) 424-2422
7070
- **Email:** [[email protected]](mailto:[email protected])
7171
- **Website:** https://support.device42.com
@@ -79,19 +79,20 @@ The Device42 integration in PagerDuty will generate a key that you'll use in Dev
7979
### Create a New Service with Integration
8080

8181
To create a new service, go to **Services > Service Directory** and click the **+ New Service** button.
82-
The setup will guide you to selecting an integration in the final step.
8382

84-
- To create a new service, click the **+ New Service** button and enter a **Name** and optional **Description** for the new service. Continue with steps 2 and 3 of the guided setup until you get to the [fourth **Integration** step](#select-the-device42-integration).
83+
Follow the guided setup until you reach the [fourth **Integration** step](#select-the-device42-integration).
8584

8685
:::tip
8786
Please refer to PagerDuty's [Configuring Services and Integrations](https://support.pagerduty.com/docs/services-and-integrations#section-configuring-services-and-integrations) docs page for details on the service options.
8887
:::
8988

90-
![Create a PagerDuty Service](/assets/images/pagerduty-integration/pagerduty-create-service.png)
89+
![Create a PagerDuty Service](/assets/images/pagerduty-integration/pagerduty-create-service.png)
9190

92-
- To add the Device42 integration to an existing PagerDuty Service, click the name of the service, open the **Integrations** tab, then click the **+ Add New Integration** button.
91+
### Add Integration to an Existing Service
9392

94-
![Add new integration](/assets/images/pagerduty-integration/pagerduty-add-integration.png)
93+
To add the Device42 integration to an existing PagerDuty Service, click the name of the service, open the **Integrations** tab, then click the **+ Add New Integration** button.
94+
95+
![Add new integration](/assets/images/pagerduty-integration/pagerduty-add-integration.png)
9596

9697
### Select the Device42 Integration
9798

@@ -101,7 +102,7 @@ When you get to the **Integration** step, search for and select **Device42**, th
101102

102103
### Copy the Integration Key
103104

104-
An **Integration Key** will be generated. Keep this key saved in a safe place, as it will be used when you configure the integration with Device42 in the next section. You won't need the **Integration URL** generated by PagerDuty.
105+
An **Integration Key** will be generated. Keep this key saved in a safe place, as you'll use it to configure the integration with Device42 in the next section. You won't need the **Integration URL** generated by PagerDuty.
105106

106107
![Copy the Integration Key](/assets/images/pagerduty-integration/pagerduty-integration-key.png)
107108

@@ -113,12 +114,15 @@ The Device42 setup includes configuring your [Cloud Services](/integration/exter
113114

114115
The [Cloud Connector](/integration/external-integrations/device42-cloud-connector-overview.mdx) provides a secure and reliable way to route external integration communication.
115116

116-
From the Device42 Dashboard, go to **Tools > Integrations > Cloud Services** and click **Edit** at the top-right of the page.
117+
From the Device42 Dashboard, go to **Tools > Integrations > Cloud Services** and click **Edit** at the top right of the page.
118+
119+
Enter your Device42 instance URL in the **D42 URL for SaaS apps** field, for example, `https://192.168.92.130/`.
120+
121+
Fill in the **Company Name** and **Email** to be used as a contact for any integration-related incidents.
117122

118-
1. Fill your Device42 instance URL in **D42 URL for SaaS apps**, for example `https://192.168.92.130/`.
119-
2. Fill in the **Company Name** and **Email** to be used as a contact for any integration-related incidents.
120-
3. Select the **USA** option from the **Cloud Connector** drop down list if this is the region closest to you, otherwise select **Europe**. PagerDuty works best with a USA Cloud Connector.
121-
4. Click **Save** and the page will reload, displaying your **Device42 GUID**.
123+
Select the **USA** option from the **Cloud Connector** dropdown list if the USA is the region closest to you; otherwise, select **Europe**. PagerDuty works best with a USA Cloud Connector.
124+
125+
Click **Save** and the page will reload, displaying your **Device42 GUID**.
122126

123127
<ThemedImage
124128
alt="Device42 Cloud Services"
@@ -132,14 +136,18 @@ From the Device42 Dashboard, go to **Tools > Integrations > Cloud Services** and
132136

133137
Navigate to **Tools > Integrations > External Integrations** and click **Create** on the top-right of the screen.
134138

135-
1. In the **URL** field, enter the domain of your PagerDuty account as it appears in the browser's address bar, for example, `https://device42demoacc.pagerduty.com`. Note this is not the **Integration URL** from the Device42 integration in PagerDuty.
136-
2. Select **PagerDuty** from the **Type** drop down field.
137-
3. In the **Token** field, input the **Integration Key** you got from the Device42 integration in PagerDuty:
138-
- Click the **plus icon** to create a new Secret.
139-
- In the pop-up window, click the **Create** button at the top right.
140-
- Enter a **Username** that will act as an alias and be attached to the PagerDuty integration key for future reference.
141-
- Paste the PagerDuty **Integration Key** in the **Password** field ensuring that there are no trailing white spaces or new line characters.
142-
4. **Save** the External Integration.
139+
In the **URL** field, enter the domain of your PagerDuty account as it appears in the browser's address bar, for example, `https://device42demoacc.pagerduty.com`. Note this is not the **Integration URL** from the Device42 integration in PagerDuty.
140+
141+
Select **PagerDuty** from the **Type** dropdown field.
142+
143+
In the **Token** field, input the **Integration Key** you got from the Device42 integration in PagerDuty:
144+
145+
- Click the **plus icon** to create a new Secret.
146+
- In the pop-up window, click the **Create** button at the top right.
147+
- Enter a **Username** that will act as an alias and be attached to the PagerDuty integration key for future reference.
148+
- Paste the PagerDuty **Integration Key** in the **Password** field, ensuring that there are no trailing white spaces or new line characters.
149+
150+
**Save** the External Integration.
143151

144152
<ThemedImage
145153
alt="Add external integration"
@@ -151,14 +159,14 @@ Navigate to **Tools > Integrations > External Integrations** and click **Create*
151159

152160
### Configure an Alert
153161

154-
You need to configure a Device42 alert to use the PagerDuty External Integration and route the alert message to PagerDuty. The following steps will configure a prohibited software alert, but any type of alert can be used and would have similar steps.
162+
You need to configure a Device42 alert to use the PagerDuty External Integration and route the alert message to PagerDuty. The following steps configure a prohibited software alert, but any type of alert can be used and would have similar steps:
155163

156-
1. Go to **Analytics > Alerts > Setup Alerts** and click the **Create** button.
157-
2. Under **Rule Type** select **Software**.
158-
5. Under **Trigger** select **Prohibited Software Installed**.
159-
6. For the **Alert Type** choose **Alert Integration**.
160-
7. From the **Alert Integration** dropdown select your PagerDuty instance URL that should be populated.
161-
8. **Save** the alert.
164+
- Go to **Analytics > Alerts > Setup Alerts** and click the **Create** button.
165+
- Under **Rule Type** select **Software**.
166+
- Under **Trigger** select **Prohibited Software Installed**.
167+
- For the **Alert Type** choose **Alert Integration**.
168+
- From the **Alert Integration** dropdown, select your PagerDuty instance URL that should be populated.
169+
- **Save** the alert.
162170

163171
<ThemedImage
164172
alt="Configure alert settings"
@@ -170,12 +178,12 @@ You need to configure a Device42 alert to use the PagerDuty External Integration
170178

171179
## Test the Integration
172180

173-
To test that the condition triggers the alert as expected, designate a Software Component as **Prohibited** and add that software to a device.
181+
To test that the condition triggers the alert as expected, designate a Software Component as **Prohibited** and add that software to a device:
174182

175-
1. Navigate to **Resources > Software Components > All Software Components**.
176-
2. Click on the software component you want to set as prohibited and click the **Edit** button on the top-right.
177-
4. Under **Software Type** select **Prohibited**.
178-
5. **Save** the change.
183+
- Navigate to **Resources > Software Components > All Software Components**.
184+
- Click on the software component you want to set as prohibited and click the **Edit** button on the top-right.
185+
- Under **Software Type** select **Prohibited**.
186+
- **Save** the change.
179187

180188
<ThemedImage
181189
alt="Software component settings"
@@ -185,12 +193,12 @@ To test that the condition triggers the alert as expected, designate a Software
185193
}}
186194
/>
187195

188-
Next, manually (without running a discovery job) associate the prohibited software with a device, which you can do in multiple ways like creating a new Software In Use record or new device with the prohibited software. In this example we'll edit an existing device to include the prohibited software.
196+
Next, manually associate (without running a discovery job) the prohibited software with a device. You can do this in multiple ways, such as by creating a new Software In Use record or a new device with the prohibited software. In this example, we'll edit an existing device to include the prohibited software:
189197

190-
1. Go to **Resources > Compute > All Devices** and select a device.
191-
2. Click **Edit** and scroll down to **Software In Use**.
192-
3. Click **+ Add New** and choose from the **Software** dropdown, select the prohibited software (`libsqlite3-0` in the example).
193-
4. **Save** the device to designate the software as prohibited and trigger the alert created in the steps above.
198+
- Go to **Resources > Compute > All Devices** and select a device.
199+
- Click **Edit** and scroll down to **Software In Use**.
200+
- Click **+ Add New** and choose from the **Software** dropdown, select the prohibited software (`libsqlite3-0` in the example).
201+
- **Save** the device to designate the software as prohibited and trigger the alert created in the steps above.
194202

195203
<ThemedImage
196204
alt="Add prohibited software to device"
@@ -208,48 +216,48 @@ You can view incident details in PagerDuty.
208216

209217
![PagerDuty incident details](/assets/images/pagerduty-integration/pagerduty-incident-details.png)
210218

211-
Remember to undo the changes you made in Device42 when testing the instance – change the prohibited software type on the Software Component you used and remove the Software In Use entry from the device.
219+
Remember to undo the changes you made in Device42 when testing the instance: Change the prohibited software type on the Software Component you used and remove the Software In Use entry from the device.
212220

213221
## How to Uninstall the Integration
214222

215-
To uninstall the integration, delete the Device42 integration in PagerDuty or disable its associated service, and in Device42 delete the External Integration.
223+
To uninstall the integration, delete the Device42 integration in PagerDuty or disable its associated service. Then, in Device42, delete the External Integration.
216224

217225
### Delete the Integration in PagerDuty
218226

219227
In PagerDuty, navigate to **Services > Service Directory** and click on the service with the Device42 integration:
220228

221-
1. Go to the **Integrations** tab and click the black **gear icon**.
222-
2. Select **Delete Integration**
223-
3. Confirm the deletion when prompted.
229+
- Go to the **Integrations** tab and click the black **gear icon**.
230+
- Select **Delete Integration**
231+
- Confirm the deletion when prompted.
224232

225233
![Delete Device42 integration](/assets/images/pagerduty-integration/pagerduty-delete-integration.png)
226234

227235
Alternatively, you can disable the service with the Device42 integration:
228236

229-
1. Go to **Services > Service Directory**.
230-
2. On the right side of the service you want to disable, click the **More** dropdown menu.
231-
3. Click **Disable Service** and click **Disable** on the confirmation dialog.
237+
- Go to **Services > Service Directory**.
238+
- On the right side of the service you want to disable, click the **More** dropdown menu.
239+
- Click **Disable Service** and click **Disable** on the confirmation dialog.
232240

233241
### Delete the Integration in Device42
234242

235-
In Device42 navigate to **Tools > Integrations > External Integrations** and select the checkbox next to the PagerDuty integration you want to remove.
243+
In Device42, navigate to **Tools > Integrations > External Integrations** and select the checkbox next to the PagerDuty integration you want to remove.
236244

237-
- From the **Actions** dropdown menu select **Delete with Detailed Confirmation**.
245+
From the **Actions** dropdown menu, select **Delete with Detailed Confirmation**.
238246

239-
<ThemedImage
240-
alt="Delete External Integration"
241-
sources={{
242-
light: useBaseUrl('/assets/images/pagerduty-integration/delete-external-integration-light.png'),
243-
dark: useBaseUrl('/assets/images/pagerduty-integration/delete-external-integration-dark.png'),
244-
}}
245-
/>
247+
<ThemedImage
248+
alt="Delete External Integration"
249+
sources={{
250+
light: useBaseUrl('/assets/images/pagerduty-integration/delete-external-integration-light.png'),
251+
dark: useBaseUrl('/assets/images/pagerduty-integration/delete-external-integration-dark.png'),
252+
}}
253+
/>
246254

247-
- On the confirmation screen, click **Delete**.
255+
On the confirmation screen, click **Delete**.
248256

249-
<ThemedImage
250-
alt="Confirm the deletion"
251-
sources={{
252-
light: useBaseUrl('/assets/images/pagerduty-integration/confirm-delete-external-integration-light.png'),
253-
dark: useBaseUrl('/assets/images/pagerduty-integration/confirm-delete-external-integration-dark.png'),
254-
}}
255-
/>
257+
<ThemedImage
258+
alt="Confirm the deletion"
259+
sources={{
260+
light: useBaseUrl('/assets/images/pagerduty-integration/confirm-delete-external-integration-light.png'),
261+
dark: useBaseUrl('/assets/images/pagerduty-integration/confirm-delete-external-integration-dark.png'),
262+
}}
263+
/>

0 commit comments

Comments
 (0)