Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: service dependency sync #81

Merged
merged 6 commits into from
Jul 25, 2024
Merged

feat: service dependency sync #81

merged 6 commits into from
Jul 25, 2024

Conversation

t1agob
Copy link
Contributor

@t1agob t1agob commented Jul 25, 2024

Description

This PR introduces a set of features that were in a way dependent on each other which makes it quite large when compared to a typical PR.

  • Automated Backstage integration setup for mapped entities: With the goal of simplifying the setup process for mapped entities we introduced a feature that automatically creates a integration on the corresponding PagerDuty service when a pagerduty.com/service-id property is available.

    With this feature, admins can skip the step of creating an integration in PagerDuty and copy the integration key to each Backstage entity file. They can now simply add the pagerduty.com/service-id annotation to their service, or simply use the PagerDutyPage to map existing PagerDuty services to Backstage entities and the plugin will take care of the rest. This change is related to Automatically create a Backstage integration when service gets mapped #80.

  • Plugin configuration persistence layer: To support two-way sync for service dependencies we decided to give the admins the option of choosing which is their main source of truth and for that reason we introduced a new section in PagerDutyPage where you can specify your preferences. The backend centralises all the persistence layer and this PR includes all the necessary methods for it.

  • Two-way service dependency sync: This PR introduces a way to keep your service dependencies in sync between PagerDuty and Backstage. Admins will be able to choose which source is the main one (Backstage, PagerDuty, or both). This is an opt-in feature that you can enable on the PagerDutyPage under the configuration tab.

Issue number: #111 from @pagerduty/backstage-plugin

Type of change

  • New feature (non-breaking change which adds functionality)
  • Fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented
  • Changes generate no new warnings
  • PR title follows conventional commit semantics

If this is a breaking change 👇

  • I have documented the migration process
  • I have implemented necessary warnings (if it can live side by side)

Acknowledgement

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@t1agob t1agob added the enhancement New feature or request label Jul 25, 2024
@t1agob t1agob merged commit 19c6375 into next Jul 25, 2024
4 checks passed
@t1agob t1agob deleted the feat/service-dependency-sync branch July 25, 2024 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant