@pagerduty/backstage-plugin 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1390 -0
- package/LICENSE +201 -0
- package/README.md +258 -0
- package/assets/emptystate.svg +1 -0
- package/config.d.ts +28 -0
- package/dist/assets/emptystate.svg +1 -0
- package/dist/esm/index-308a2487.esm.js +29 -0
- package/dist/esm/index-308a2487.esm.js.map +1 -0
- package/dist/esm/index-7a206e9e.esm.js +777 -0
- package/dist/esm/index-7a206e9e.esm.js.map +1 -0
- package/dist/index.d.ts +202 -0
- package/dist/index.esm.js +23 -0
- package/dist/index.esm.js.map +1 -0
- package/package.json +79 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
# PagerDuty plugin for Backstage
|
|
2
|
+
|
|
3
|
+
[](https://github.com/PagerDuty/backstage-plugin/actions/workflows/on_release_created.yml)
|
|
4
|
+
[](https://badge.fury.io/js/@pagerduty%2Fbackstage-plugin)
|
|
5
|
+
[](https://opensource.org/licenses/Apache-2.0)
|
|
6
|
+
|
|
7
|
+
**Note:** If you are migrating from *@backstage/plugin-pagerduty* you can follow these instructions [here](https://github.com/PagerDuty/backstage-plugin?tab=readme-ov-file#how-to-migrate-from-backstageplugin-pagerduty).
|
|
8
|
+
|
|
9
|
+
## Integration Benefits
|
|
10
|
+
|
|
11
|
+
- Display relevant PagerDuty information about an entity within Backstage, such as the active incidents or recent changes.
|
|
12
|
+
- Quickly check who is on call for a service.
|
|
13
|
+
- Trigger an incident to the currently on-call responder(s) for a service.
|
|
14
|
+
|
|
15
|
+
## How it Works
|
|
16
|
+
|
|
17
|
+
- The Backstage PagerDuty plugin allows PagerDuty information about a Backstage entity to be displayed within Backstage. This includes active incidents, recent change events, as well as the current on-call responders' names, email addresses, and links to their profiles in PagerDuty.
|
|
18
|
+
- Incidents can be manually triggered via the plugin with a user-provided description, which will in turn notify the current on-call responders. Alternatively, the plugin can be configured with an optional `readOnly` property to suppress the ability to trigger incidents from the plugin.
|
|
19
|
+
- **Note:** This feature is only available when providing the *`pagerduty.com/integration-key`* annotation.
|
|
20
|
+
- Change events will be displayed in a separate tab. If the change event payload has additional links, only the first link will be rendered.
|
|
21
|
+
|
|
22
|
+
## Requirements
|
|
23
|
+
|
|
24
|
+
- Setup of the PagerDuty plugin for Backstage requires a PagerDuty Admin role in order to generate the necessary authorizations, such as the API token. If you do not have this role, please reach out to a **Global Admin** or **Account Owner** within your organization to request configuration of this plugin.
|
|
25
|
+
|
|
26
|
+
## Feature Overview
|
|
27
|
+
|
|
28
|
+
### View any open incidents
|
|
29
|
+
|
|
30
|
+

|
|
31
|
+
|
|
32
|
+
### Email link, and view contact information for staff on call
|
|
33
|
+
|
|
34
|
+

|
|
35
|
+
|
|
36
|
+
### Trigger an incident for a service
|
|
37
|
+
|
|
38
|
+

|
|
39
|
+
|
|
40
|
+

|
|
41
|
+
|
|
42
|
+
## Integration Walk-through
|
|
43
|
+
|
|
44
|
+
### In PagerDuty
|
|
45
|
+
|
|
46
|
+
#### Integrating With a PagerDuty Service
|
|
47
|
+
|
|
48
|
+
1. From the **Configuration** menu, select **Services**.
|
|
49
|
+
2. There are two ways to add an integration to a service:
|
|
50
|
+
- **If you are adding your integration to an existing service**: Click the **name** of the service you want to add the integration to. Then, select the **Integrations** tab and click the **New Integration** button.
|
|
51
|
+
- **If you are creating a new service for your integration**: Please read the documentation in section [Configuring Services and Integrations](https://support.pagerduty.com/docs/services-and-integrations#section-configuring-services-and-integrations) and follow the steps outlined in the [Create a Service](https://support.pagerduty.com/docs/services-and-integrations#create-a-service) section, selecting **Backstage** as the **Integration Type** in step 5. Continue with the [*"In Backstage"*](https://github.com/PagerDuty/backstage-plugin?tab=readme-ov-file#in-backstage) section (below) once you have finished these steps.
|
|
52
|
+
3. Enter an **Integration Name** in the format `monitoring-tool-service-name` (e.g. `Backstage-Shopping-Cart`) and select **Backstage** from the Integration Type menu.
|
|
53
|
+
4. Click the **Add Integration** button to save your new integration. You will be redirected to the Integrations tab for your service.
|
|
54
|
+
5. An **Integration Key** will be generated on this screen. Keep this key saved in a safe place, as it will be used when you configure the integration with **Backstage** in the next section.
|
|
55
|
+

|
|
56
|
+
|
|
57
|
+
### In Backstage
|
|
58
|
+
|
|
59
|
+
#### Install the plugin
|
|
60
|
+
|
|
61
|
+
The file paths mentioned in the following steps are relative to your app's root directory — for example, the directory created by following the [Getting Started](https://backstage.io/docs/getting-started/) guide and creating your app with `npx @backstage/create-app`.
|
|
62
|
+
|
|
63
|
+
First, from your Backstage root directory, install the PagerDuty plugin via CLI:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
yarn add --cwd packages/app @pagerduty/backstage-plugin
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Next, add the plugin to `EntityPage.tsx` in `packages/app/src/components/catalog` by adding the following code snippets.
|
|
70
|
+
|
|
71
|
+
Add the following imports to the top of the file:
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
import {
|
|
75
|
+
isPluginApplicableToEntity as isPagerDutyAvailable,
|
|
76
|
+
EntityPagerDutyCard,
|
|
77
|
+
} from '@pagerduty/backstage-plugin';
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Find `const overviewContent` in `EntityPage.tsx`, and add the following snippet inside the outermost `Grid` defined there, just before the closing `</Grid>` tag:
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
<EntitySwitch>
|
|
84
|
+
<EntitySwitch.Case if={isPagerDutyAvailable}>
|
|
85
|
+
<Grid item md={6}>
|
|
86
|
+
<EntityPagerDutyCard />
|
|
87
|
+
</Grid>
|
|
88
|
+
</EntitySwitch.Case>
|
|
89
|
+
</EntitySwitch>
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
When you're done, the `overviewContent` definition should look something like this:
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
const overviewContent = (
|
|
96
|
+
<Grid ...>
|
|
97
|
+
...
|
|
98
|
+
<EntitySwitch>
|
|
99
|
+
<EntitySwitch.Case if={isPagerDutyAvailable}>
|
|
100
|
+
<Grid item md={6}>
|
|
101
|
+
<EntityPagerDutyCard />
|
|
102
|
+
</Grid>
|
|
103
|
+
</EntitySwitch.Case>
|
|
104
|
+
</EntitySwitch>
|
|
105
|
+
</Grid>
|
|
106
|
+
);
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
#### Configure the plugin
|
|
110
|
+
|
|
111
|
+
First, [annotate](https://backstage.io/docs/features/software-catalog/descriptor-format#annotations-optional) the appropriate entity with the PagerDuty integration key in its `.yaml` configuration file:
|
|
112
|
+
|
|
113
|
+
```yaml
|
|
114
|
+
annotations:
|
|
115
|
+
pagerduty.com/integration-key: [INTEGRATION_KEY]
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### The homepage component
|
|
119
|
+
|
|
120
|
+
You may also add the component to the homepage of Backstage. Edit the `HomePage.tsx` file, import `PagerDutyHomepageCard` and add it to the home page. e.g.
|
|
121
|
+
|
|
122
|
+
```typescript jsx
|
|
123
|
+
...
|
|
124
|
+
export const homePage = (
|
|
125
|
+
<Page themeId="home">
|
|
126
|
+
...
|
|
127
|
+
<Content>
|
|
128
|
+
<CustomHomepageGrid config={defaultConfig}>
|
|
129
|
+
...
|
|
130
|
+
<PagerDutyHomepageCard
|
|
131
|
+
name="My Service"
|
|
132
|
+
serviceId="<service id>"
|
|
133
|
+
integrationKey="<integration key>"
|
|
134
|
+
readOnly={false}
|
|
135
|
+
/>
|
|
136
|
+
</CustomHomepageGrid>
|
|
137
|
+
</Content>
|
|
138
|
+
</Page>
|
|
139
|
+
);
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Next, provide the [API token](https://support.pagerduty.com/docs/generating-api-keys#generating-a-general-access-rest-api-key) that the client will use to make requests to the [PagerDuty API](https://developer.pagerduty.com/docs/rest-api-v2/rest-api/).
|
|
143
|
+
|
|
144
|
+
Add the proxy configuration in `app-config.yaml`:
|
|
145
|
+
|
|
146
|
+
```yaml
|
|
147
|
+
proxy:
|
|
148
|
+
...
|
|
149
|
+
'/pagerduty':
|
|
150
|
+
target: https://api.pagerduty.com
|
|
151
|
+
headers:
|
|
152
|
+
Authorization: Token token=${PAGERDUTY_TOKEN}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Then, start the backend, passing the PagerDuty API token as an environment variable:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
PAGERDUTY_TOKEN='<TOKEN>' yarn start
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
This will proxy the request by adding an `Authorization` header with the provided token.
|
|
162
|
+
|
|
163
|
+
#### Optional configuration
|
|
164
|
+
|
|
165
|
+
##### Annotating with Service ID
|
|
166
|
+
|
|
167
|
+
If you want to integrate a PagerDuty service with Backstage but don't want to use an integration key, you can also [annotate](https://backstage.io/docs/features/software-catalog/descriptor-format#annotations-optional) the appropriate entity with a PagerDuty Service ID instead
|
|
168
|
+
|
|
169
|
+
```yaml
|
|
170
|
+
annotations:
|
|
171
|
+
pagerduty.com/service-id: [SERVICE_ID]
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
This service ID can be found by navigating to a Service within PagerDuty and pulling the ID value out of the URL.
|
|
175
|
+
|
|
176
|
+
1. From the **Configuration** menu within PagerDuty, select **Services**.
|
|
177
|
+
2. Click the **name** of the service you want to represent for your Entity.
|
|
178
|
+
|
|
179
|
+
Your browser URL should now be located at `https://pagerduty.com/service-directory/[SERVICE_ID]`.
|
|
180
|
+
|
|
181
|
+
**Note:** *When annotating with `pagerduty.com/service-id`, the feature to Create Incidents is not currently supported*.
|
|
182
|
+
|
|
183
|
+
##### Custom Events URL
|
|
184
|
+
|
|
185
|
+
If you want to override the default URL used for events, you can add it to `app-config.yaml`:
|
|
186
|
+
|
|
187
|
+
```yaml
|
|
188
|
+
pagerDuty:
|
|
189
|
+
eventsBaseUrl: 'https://events.pagerduty.com/v2'
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
> **Note:** PagerDuty accounts based in Europe use a different url so you need to override it here if that is your case.
|
|
193
|
+
|
|
194
|
+
To suppress the rendering of the actionable incident-creation button, the `PagerDutyCard` can also be instantiated in `readOnly` mode:
|
|
195
|
+
|
|
196
|
+
```ts
|
|
197
|
+
<PagerDuty readOnly />
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
**WARNING**: In current implementation, the PagerDuty plugin requires the `/pagerduty` proxy endpoint be exposed by the Backstage backend as an unprotected endpoint, in effect enabling PagerDuty API access using the configured `PAGERDUTY_TOKEN` for any user or process with access to the `/pagerduty` Backstage backend endpoint. If you regard this as problematic, consider using the plugin in `readOnly` mode (`<PagerDutyCard readOnly />`) using the following proxy configuration:
|
|
201
|
+
|
|
202
|
+
```yaml
|
|
203
|
+
proxy:
|
|
204
|
+
'/pagerduty':
|
|
205
|
+
target: https://api.pagerduty.com
|
|
206
|
+
headers:
|
|
207
|
+
Authorization: Token token=${PAGERDUTY_TOKEN}
|
|
208
|
+
# prohibit the `/pagerduty` proxy endpoint from servicing non-GET requests
|
|
209
|
+
allowedMethods: ['GET']
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
## How to Uninstall
|
|
213
|
+
|
|
214
|
+
1. Remove any configuration added in Backstage yaml files, such as the proxy configuration in `app-config.yaml` and the integration key in an entity's annotations.
|
|
215
|
+
2. Remove the added code snippets from `EntityPage.tsx`
|
|
216
|
+
3. Remove the plugin package:
|
|
217
|
+
|
|
218
|
+
```bash
|
|
219
|
+
# From your Backstage root directory
|
|
220
|
+
yarn remove --cwd packages/app @pagerduty/backstage-plugin
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
4. [Delete the integration](https://support.pagerduty.com/docs/services-and-integrations#delete-an-integration-from-a-service) from the service in PagerDuty
|
|
224
|
+
|
|
225
|
+
## How to migrate from @backstage/plugin-pagerduty
|
|
226
|
+
|
|
227
|
+
If you are migrating from the Pagerduty plugin that was maintained by Spotify, the steps to migrate are pretty simple.
|
|
228
|
+
|
|
229
|
+
1. Remove the Backstage package from your project
|
|
230
|
+
|
|
231
|
+
```bash
|
|
232
|
+
# From your Backstage root directory
|
|
233
|
+
yarn remove --cwd packages/app @backstage/plugin-pagerduty
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
2. Install the new PagerDuty plugin for Backstage
|
|
237
|
+
|
|
238
|
+
```bash
|
|
239
|
+
# From your Backstage root directory
|
|
240
|
+
yarn add --cwd packages/app @pagerduty/backstage-plugin
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
3. Replace all occurrences of **@backstage/plugin-pagerduty** with **@pagerduty/backstage-plugin** in your components
|
|
244
|
+
|
|
245
|
+
4. Re-install dependencies and run Backstage locally to test that everything is working
|
|
246
|
+
|
|
247
|
+
```bash
|
|
248
|
+
# From your Backstage root directory
|
|
249
|
+
yarn install && yarn dev
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
## Support
|
|
253
|
+
|
|
254
|
+
If you need help with this plugin, please open an issue in [GitHub](https://github.com/PagerDuty/backstage-plugin), reach out on the [Backstage Discord server](https://discord.gg/backstage-687207715902193673) or [PagerDuty's community forum](https://community.pagerduty.com).
|
|
255
|
+
|
|
256
|
+
## Contributing
|
|
257
|
+
|
|
258
|
+
If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/PagerDuty/backstage-plugin/blob/main/CONTRIBUTING.md).
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="282" height="173" fill="none" viewBox="0 0 282 173"><path fill="#000" fill-opacity=".05" fill-rule="evenodd" d="M16.4571 45.1637C11.0514 46.1711 7.48574 51.3699 8.49306 56.7756C9.50039 62.1814 14.6992 65.747 20.105 64.7397L27.5528 63.3518C25.4791 65.5835 24.4525 68.7347 25.0535 71.9596C26.0608 77.3653 31.2596 80.931 36.6654 79.9236L89.691 70.0427C89.7016 70.1067 89.7129 70.1708 89.7249 70.2349C90.3258 73.4598 92.4185 76.0298 95.1569 77.3647L91.9031 77.971C86.4974 78.9784 82.9318 84.1772 83.9391 89.583C84.9464 94.9887 90.1452 98.5543 95.551 97.547L250.098 68.7482C255.504 67.7409 259.069 62.5421 258.062 57.1363C257.461 53.9114 255.368 51.3414 252.63 50.0065L257.835 49.0366C263.241 48.0292 266.807 42.8304 265.799 37.4247C264.792 32.0189 259.593 28.4533 254.187 29.4606L161.492 46.7338C161.481 46.6697 161.47 46.6056 161.458 46.5415C160.857 43.3166 158.764 40.7466 156.026 39.4117L165.025 37.7347C170.431 36.7274 173.997 31.5286 172.989 26.1228C171.982 20.7171 166.783 17.1514 161.378 18.1588L16.4571 45.1637ZM24.3031 122.54C23.2958 117.134 26.8614 111.936 32.2672 110.928L190.856 81.3762C196.262 80.3688 201.461 83.9345 202.468 89.3402C203.476 94.746 199.91 99.9448 194.504 100.952L189.963 101.798C190.493 102.057 190.999 102.362 191.474 102.708L246.43 92.4677C251.835 91.4604 257.034 95.026 258.041 100.432C258.642 103.657 257.616 106.808 255.542 109.04L256.649 108.833C262.055 107.826 267.253 111.392 268.261 116.797C269.268 122.203 265.702 127.402 260.297 128.409L95.5591 159.107C90.1534 160.114 84.9545 156.549 83.9472 151.143C82.9399 145.737 86.5055 140.538 91.9113 139.531L103.94 137.29C103.41 137.031 102.904 136.726 102.429 136.38L29.1002 150.044C23.6944 151.051 18.4956 147.486 17.4882 142.08C16.4809 136.674 20.0465 131.475 25.4523 130.468L29.7352 129.67C26.9967 128.335 24.904 125.765 24.3031 122.54Z" clip-rule="evenodd"/><circle cx="188" cy="55" r="6" fill="#69DDC7"/><circle cx="91" cy="92" r="6" fill="#69DDC7"/><path fill="#69DDC7" d="M121 114L95.5 88L86.5 96L121 130L192.5 59L183.5 51L121 114Z"/></svg>
|
package/config.d.ts
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2023 The Backstage Authors
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
export interface Config {
|
|
17
|
+
/**
|
|
18
|
+
* Configuration for the PagerDuty plugin
|
|
19
|
+
* @visibility frontend
|
|
20
|
+
*/
|
|
21
|
+
pagerDuty?: {
|
|
22
|
+
/**
|
|
23
|
+
* Optional Events Base URL to override the default.
|
|
24
|
+
* @visibility frontend
|
|
25
|
+
*/
|
|
26
|
+
eventsBaseUrl?: string;
|
|
27
|
+
};
|
|
28
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="282" height="173" fill="none" viewBox="0 0 282 173"><path fill="#000" fill-opacity=".05" fill-rule="evenodd" d="M16.4571 45.1637C11.0514 46.1711 7.48574 51.3699 8.49306 56.7756C9.50039 62.1814 14.6992 65.747 20.105 64.7397L27.5528 63.3518C25.4791 65.5835 24.4525 68.7347 25.0535 71.9596C26.0608 77.3653 31.2596 80.931 36.6654 79.9236L89.691 70.0427C89.7016 70.1067 89.7129 70.1708 89.7249 70.2349C90.3258 73.4598 92.4185 76.0298 95.1569 77.3647L91.9031 77.971C86.4974 78.9784 82.9318 84.1772 83.9391 89.583C84.9464 94.9887 90.1452 98.5543 95.551 97.547L250.098 68.7482C255.504 67.7409 259.069 62.5421 258.062 57.1363C257.461 53.9114 255.368 51.3414 252.63 50.0065L257.835 49.0366C263.241 48.0292 266.807 42.8304 265.799 37.4247C264.792 32.0189 259.593 28.4533 254.187 29.4606L161.492 46.7338C161.481 46.6697 161.47 46.6056 161.458 46.5415C160.857 43.3166 158.764 40.7466 156.026 39.4117L165.025 37.7347C170.431 36.7274 173.997 31.5286 172.989 26.1228C171.982 20.7171 166.783 17.1514 161.378 18.1588L16.4571 45.1637ZM24.3031 122.54C23.2958 117.134 26.8614 111.936 32.2672 110.928L190.856 81.3762C196.262 80.3688 201.461 83.9345 202.468 89.3402C203.476 94.746 199.91 99.9448 194.504 100.952L189.963 101.798C190.493 102.057 190.999 102.362 191.474 102.708L246.43 92.4677C251.835 91.4604 257.034 95.026 258.041 100.432C258.642 103.657 257.616 106.808 255.542 109.04L256.649 108.833C262.055 107.826 267.253 111.392 268.261 116.797C269.268 122.203 265.702 127.402 260.297 128.409L95.5591 159.107C90.1534 160.114 84.9545 156.549 83.9472 151.143C82.9399 145.737 86.5055 140.538 91.9113 139.531L103.94 137.29C103.41 137.031 102.904 136.726 102.429 136.38L29.1002 150.044C23.6944 151.051 18.4956 147.486 17.4882 142.08C16.4809 136.674 20.0465 131.475 25.4523 130.468L29.7352 129.67C26.9967 128.335 24.904 125.765 24.3031 122.54Z" clip-rule="evenodd"/><circle cx="188" cy="55" r="6" fill="#69DDC7"/><circle cx="91" cy="92" r="6" fill="#69DDC7"/><path fill="#69DDC7" d="M121 114L95.5 88L86.5 96L121 130L192.5 59L183.5 51L121 114Z"/></svg>
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { P as PagerDutyCard } from './index-7a206e9e.esm.js';
|
|
3
|
+
import '@backstage/core-plugin-api';
|
|
4
|
+
import '@backstage/errors';
|
|
5
|
+
import '@backstage/plugin-home-react';
|
|
6
|
+
import '@backstage/plugin-catalog-react';
|
|
7
|
+
import '@material-ui/core';
|
|
8
|
+
import '@material-ui/icons/Done';
|
|
9
|
+
import '@material-ui/icons/Warning';
|
|
10
|
+
import 'luxon';
|
|
11
|
+
import '@material-ui/icons/OpenInBrowser';
|
|
12
|
+
import '@backstage/core-components';
|
|
13
|
+
import '../assets/emptystate.svg';
|
|
14
|
+
import 'react-use/lib/useAsyncFn';
|
|
15
|
+
import '@material-ui/lab';
|
|
16
|
+
import '@material-ui/core/Avatar';
|
|
17
|
+
import '@material-ui/icons/Email';
|
|
18
|
+
import 'react-use/lib/useAsync';
|
|
19
|
+
import '@material-ui/icons/AlarmAdd';
|
|
20
|
+
import '@material-ui/icons/Web';
|
|
21
|
+
import '@material-ui/icons/DateRange';
|
|
22
|
+
import '@backstage/catalog-model';
|
|
23
|
+
|
|
24
|
+
const Content = (props) => {
|
|
25
|
+
return /* @__PURE__ */ React.createElement(PagerDutyCard, { ...props });
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
export { Content };
|
|
29
|
+
//# sourceMappingURL=index-308a2487.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index-308a2487.esm.js","sources":["../../src/components/HomePagePagerDutyCard/Content.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n// eslint-disable-next-line @backstage/no-undeclared-imports\nimport React from 'react';\n\nimport { PagerDutyEntity } from '../../types';\nimport { PagerDutyCard } from '../PagerDutyCard';\n\n/** @public */\nexport type HomePagePagerDutyCardProps = PagerDutyEntity & {\n readOnly?: boolean;\n};\n\n/** @public */\nexport const Content = (props: HomePagePagerDutyCardProps) => {\n return <PagerDutyCard {...props} />;\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA2Ba,MAAA,OAAA,GAAU,CAAC,KAAsC,KAAA;AAC5D,EAAO,uBAAA,KAAA,CAAA,aAAA,CAAC,aAAe,EAAA,EAAA,GAAG,KAAO,EAAA,CAAA,CAAA;AACnC;;;;"}
|