Skip to content

Commit

Permalink
docs: updating service dependency docs after enabling pagerduty option
Browse files Browse the repository at this point in the history
Signed-off-by: Tiago Barbosa <[email protected]>
  • Loading branch information
t1agob committed Aug 21, 2024
1 parent c28af0f commit 2879f49
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 5 deletions.
11 changes: 7 additions & 4 deletions docs/advanced/configure-service-dependency-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ This feature is very powerfull for users that want to leverage [PagerDuty Status

This feature is **disabled** by default but can easily be enabled on the PagerDuty advanced configuration page. If you haven't enabled it yet you can do so by following the instructions in [here](/backstage-plugin-docs/advanced/service-entity-mapping/#adding-the-pagerdutypage-component).

![on-call-engineer](https://github.com/user-attachments/assets/f8332378-2439-4b7d-b130-b73acccd666b)
![dependency-sync-strategy](../images/dependency-sync-strategy.png)

Here you can choose to use Backstage as the main source and the plugin will automatically add/remove service dependencies to your mapped entities in PagerDuty. You can optionally choose to merge service dependencies from Backstage and PagerDuty or even keep it disabled.
Here you can choose:

- to use **Backstage as the main source** and the plugin will automatically add/remove service dependencies to your mapped entities in PagerDuty
- to set **PagerDuty as the main source** and the plugin will automatically add/remove entity relations in Backstage
- to **merge service dependencies** from Backstage and PagerDuty
- to keep it **disabled**.

!!! note
The syncing mechanism will overwrite all services on the destination so use this mechanism carefully.

**Example:** You set Backstage as your main source and you already have service dependencies in PagerDuty. Those will be overwritten has Backstage is now configured as the source of thruth.

‼️ **Important**: Due to a Backstage design decision it is not possible to fully overwrite the relations specified in each entity's configuration file. For that reason the option to synchronise strictly from PagerDuty side is not available.
Binary file added docs/images/dependency-sync-strategy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/release-notes/entity-processor.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Release notes for Entity Processor module

## > 0.3.1

[GitHub release](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.1)

### Summary

Release **0.3.1** removes a limitation that prevented users from enabling PagerDuty as their main source for syncing service dependencies.

With the help of the Backstage team, we were able to implement a few changes that overcome this limitation and users are now able to set PagerDuty as their main source for service dependencies and get their dependencies sync to Backstage for all mapped entities.

### Changes

- feat: enable pagerduty service dependency sync

### Dependencies

- `@pagerduty/backstage-plugin-common: 0.2.1`

## > 0.3.0

[GitHub release](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.0)
Expand Down
20 changes: 20 additions & 0 deletions docs/release-notes/frontend.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Release notes for Frontend plugin

## > 0.15.1

[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.15.1)

### Summary

This release enables the `PagerDuty` option in the PagerDutyPage component settings which allows users to set PagerDuty as their main source for syncing service dependencies to Backstage.

This feature was disabled due to a limitation on version [0.3.0](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.0) of `@pagerduty/backstage-plugin-entity-processor` which is now fixed and released on version [0.3.1](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.1).

### Changes

- refactor: enable PagerDuty option on PagerDutyPage

### Dependencies

- `@pagerduty/backstage-plugin-backend: 0.9.0`
- `@pagerduty/backstage-plugin-common: 0.2.1`
- `@pagerduty/backstage-plugin-entity-provider: 0.3.1`

## > 0.15.0

[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.15.0)
Expand Down
2 changes: 1 addition & 1 deletion overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% block announce %}
<div>
<p>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/backstage-plugin-docs/release-notes/frontend/#0150">0.15.0</a>), Backend(<a href="/backstage-plugin-docs/release-notes/backend/#091">0.9.1</a>), Common(<a href="/backstage-plugin-docs/release-notes/common/#021">0.2.1</a>), Scaffolder Actions(<a href="/backstage-plugin-docs/release-notes/scaffolder-actions/#021">0.2.1</a>) and Entity Processor(<a href="/backstage-plugin-docs/release-notes/entity-processor/#030">0.3.0</a>) </span>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/backstage-plugin-docs/release-notes/frontend/#0151">0.15.1</a>), Backend(<a href="/backstage-plugin-docs/release-notes/backend/#091">0.9.1</a>), Common(<a href="/backstage-plugin-docs/release-notes/common/#021">0.2.1</a>), Scaffolder Actions(<a href="/backstage-plugin-docs/release-notes/scaffolder-actions/#021">0.2.1</a>) and Entity Processor(<a href="/backstage-plugin-docs/release-notes/entity-processor/#031">0.3.1</a>) </span>
</p>
</div>
{% endblock %}

0 comments on commit 2879f49

Please sign in to comment.