@backstage-community/plugin-ilert 0.2.24

package/README.md

@@ -0,0 +1,127 @@
+# @backstage-community/plugin-ilert
+
+## Introduction
+
+[iLert](https://www.ilert.com) is a platform for alerting, on-call management and uptime monitoring. It helps teams to reduce response times to critical incidents by extending monitoring tools with reliable alerting, automatic escalations, on-call schedules and other features to support the incident response process, such as informing stakeholders or creating tickets in external incident management tools.
+
+## Overview
+
+This plugin gives an overview about ongoing iLert incidents, on-call and uptime monitor status.
+See who is on-call, which incidents are active and trigger incidents directly from backstage for the configured alert sources.
+
+In detail this plugin provides:
+
+- Information details about the person on-call (all escalation levels of the current time)
+- A way to override the current on-call person
+- A list of active incidents
+- A way to trigger a new incident
+- A way to reassign/acknowledge/resolve an incident
+- A way to trigger an incident action
+- A way to trigger an immediate maintenance
+- A way to disable/enable an alert source
+- A list of uptime monitors
+
+## Setup instructions
+
+Install the plugin:
+
+```bash
+# From your Backstage root directory
+yarn --cwd packages/app add @backstage-community/plugin-ilert
+```
+
+Add it to the `EntityPage.tsx`:
+
+```ts
+import {
+  isPluginApplicableToEntity as isILertAvailable,
+  EntityILertCard,
+} from '@backstage-community/plugin-ilert';
+
+// ...
+<EntitySwitch>
+  <EntitySwitch.Case if={isILertAvailable}>
+    <Grid item sm={6}>
+      <EntityILertCard />
+    </Grid>
+  </EntitySwitch.Case>
+</EntitySwitch>;
+// ...
+```
+
+> To force an iLert card for each entity just add the `<EntityILertCard />` component. An instruction card will appear if no integration key is set.
+
+## Add iLert explorer to the app sidebar
+
+Modify your app routes in [`App.tsx`](https://github.com/backstage/backstage/blob/master/packages/app/src/App.tsx) to include the Router component exported by the plugin - for example:
+
+```tsx
+import { ILertPage } from '@backstage-community/plugin-ilert';
+<FlatRoutes>
+  // ...
+  <Route path="/ilert" element={<ILertPage />} />
+  // ...
+</FlatRoutes>;
+```
+
+Modify your sidebar in [`Root.tsx`](https://github.com/backstage/backstage/blob/master/packages/app/src/components/Root/Root.tsx) to include the icon component exported by the plugin - for example:
+
+```tsx
+import { ILertIcon } from '@backstage-community/plugin-ilert';
+<Sidebar>
+  // ...
+  <SidebarItem icon={ILertIcon} to="ilert" text="iLert" />
+  // ...
+</Sidebar>;
+```
+
+## Client configuration
+
+If you want to override the default URL for api calls and detail pages, you can add it to `app-config.yaml`.
+
+In `app-config.yaml`:
+
+```yaml
+ilert:
+  baseUrl: https://my-org.ilert.com/
+```
+
+## Providing the Authorization Header
+
+In order to make the API calls, you need to provide a new proxy config which will redirect to the [iLert API](https://api.ilert.com/api-docs/) endpoint. It needs an [Authorization Header](https://api.ilert.com/api-docs/#section/Authentication).
+
+Add the proxy configuration in `app-config.yaml`
+
+```yaml
+proxy:
+  ...
+  '/ilert':
+    target: https://api.ilert.com
+    allowedMethods: ['GET', 'POST', 'PUT']
+    allowedHeaders: ['Authorization']
+    headers:
+      Authorization: ${ILERT_AUTH_HEADER}
+```
+
+Then start the backend, passing the authorization header (bearer token or basic auth) as environment variable:
+
+```bash
+$ ILERT_AUTH_HEADER='<ILERT_AUTH>' yarn start
+```
+
+## Integration Key
+
+The information displayed for each entity is based on the alert source integration key.
+
+### Adding the integration key to the entity annotation
+
+If you want to use this plugin for an entity, you need to label it with the below annotation:
+
+```yml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: example
+  annotations:
+    ilert.com/integration-key: [INTEGRATION_KEY]
+```

package/config.d.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface Config {
+  ilert?: {
+    /**
+     * Domain used by users to access iLert web UI.
+     * Example: https://my-app.ilert.com/
+     * @visibility frontend
+     */
+    baseUrl: string;
+
+    /**
+     * Path to use for requests via the proxy, defaults to /ilert/api
+     * @visibility frontend
+     */
+    proxyPath?: string;
+  };
+}

package/dist/esm/index-D2_Gjvjx.esm.js

@@ -0,0 +1,58 @@
+export { ILertCard, Router as ILertPage, isPluginApplicableToEntity } from '../index.esm.js';
+import '@backstage/core-plugin-api';
+import '@backstage/errors';
+import 'luxon';
+import '@backstage/core-components';
+import 'react';
+import '@material-ui/core/Button';
+import '@material-ui/icons/Add';
+import 'react-use/esm/useAsyncRetry';
+import '@backstage/catalog-model';
+import '@material-ui/core/Typography';
+import '@material-ui/core/Dialog';
+import '@material-ui/core/DialogActions';
+import '@material-ui/core/DialogContent';
+import '@material-ui/core/DialogTitle';
+import '@material-ui/core/styles';
+import '@material-ui/core/TextField';
+import '@material-ui/core/useMediaQuery';
+import '@material-ui/lab/Alert';
+import '@material-ui/lab/Autocomplete';
+import 'humanize-duration';
+import '@material-ui/core/IconButton';
+import '@material-ui/core/Menu';
+import '@material-ui/core/MenuItem';
+import '@material-ui/icons/MoreVert';
+import '@material-ui/core/Grid';
+import '@material-ui/core/Chip';
+import '@material-ui/core/Checkbox';
+import '@material-ui/core/FormControl';
+import '@material-ui/core/ListItemText';
+import '@material-ui/core/Select';
+import '@material-ui/core/Card';
+import '@material-ui/core/CardContent';
+import '@material-ui/core/CardHeader';
+import '@material-ui/icons/Repeat';
+import '@material-ui/pickers/DateTimePicker';
+import '@material-ui/pickers/MuiPickersUtilsProvider';
+import '@date-io/luxon';
+import '@material-ui/core/Divider';
+import '@backstage/plugin-catalog-react';
+import '@material-ui/icons/AlarmAdd';
+import '@material-ui/icons/Build';
+import '@material-ui/icons/Pause';
+import '@material-ui/icons/PlayArrow';
+import '@material-ui/icons/Web';
+import '@material-ui/core/DialogContentText';
+import '@material-ui/core/List';
+import '@material-ui/core/ListItem';
+import '@material-ui/core/ListItemIcon';
+import '@material-ui/core/ListSubheader';
+import '@material-ui/icons/Replay';
+import '@material-ui/core/Avatar';
+import '@material-ui/core/ListItemSecondaryAction';
+import '@material-ui/core/Tooltip';
+import '@material-ui/icons/Email';
+import '@material-ui/icons/Phone';
+import '@material-ui/core/SvgIcon';
+//# sourceMappingURL=index-D2_Gjvjx.esm.js.map

package/dist/esm/index-D2_Gjvjx.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-D2_Gjvjx.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/index-aory7UQN.esm.js

@@ -0,0 +1,58 @@
+export { ILertCard, isPluginApplicableToEntity } from '../index.esm.js';
+import '@backstage/core-plugin-api';
+import '@backstage/errors';
+import 'luxon';
+import '@backstage/core-components';
+import 'react';
+import '@material-ui/core/Button';
+import '@material-ui/icons/Add';
+import 'react-use/esm/useAsyncRetry';
+import '@backstage/catalog-model';
+import '@material-ui/core/Typography';
+import '@material-ui/core/Dialog';
+import '@material-ui/core/DialogActions';
+import '@material-ui/core/DialogContent';
+import '@material-ui/core/DialogTitle';
+import '@material-ui/core/styles';
+import '@material-ui/core/TextField';
+import '@material-ui/core/useMediaQuery';
+import '@material-ui/lab/Alert';
+import '@material-ui/lab/Autocomplete';
+import 'humanize-duration';
+import '@material-ui/core/IconButton';
+import '@material-ui/core/Menu';
+import '@material-ui/core/MenuItem';
+import '@material-ui/icons/MoreVert';
+import '@material-ui/core/Grid';
+import '@material-ui/core/Chip';
+import '@material-ui/core/Checkbox';
+import '@material-ui/core/FormControl';
+import '@material-ui/core/ListItemText';
+import '@material-ui/core/Select';
+import '@material-ui/core/Card';
+import '@material-ui/core/CardContent';
+import '@material-ui/core/CardHeader';
+import '@material-ui/icons/Repeat';
+import '@material-ui/pickers/DateTimePicker';
+import '@material-ui/pickers/MuiPickersUtilsProvider';
+import '@date-io/luxon';
+import '@material-ui/core/Divider';
+import '@backstage/plugin-catalog-react';
+import '@material-ui/icons/AlarmAdd';
+import '@material-ui/icons/Build';
+import '@material-ui/icons/Pause';
+import '@material-ui/icons/PlayArrow';
+import '@material-ui/icons/Web';
+import '@material-ui/core/DialogContentText';
+import '@material-ui/core/List';
+import '@material-ui/core/ListItem';
+import '@material-ui/core/ListItemIcon';
+import '@material-ui/core/ListSubheader';
+import '@material-ui/icons/Replay';
+import '@material-ui/core/Avatar';
+import '@material-ui/core/ListItemSecondaryAction';
+import '@material-ui/core/Tooltip';
+import '@material-ui/icons/Email';
+import '@material-ui/icons/Phone';
+import '@material-ui/core/SvgIcon';
+//# sourceMappingURL=index-aory7UQN.esm.js.map

package/dist/esm/index-aory7UQN.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-aory7UQN.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}