Error | +Description | +
---|---|
`run_exhausted` | +Action run has already finished execution | +
Error | +Description | +
---|---|
`required_relation` | +Relation cannot be deleted because it is a `required relation` | +
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
`not_found` | +An entity with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`identifier_taken` | +The provided `identifier` already exists, identifiers must be unique | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
`team_inheritance_enabled` | +The blueprint's entities inherite their team from other entities through an existing relation | +
`blueprint_schema_mismatch` | +The provided entity does not match the blueprint's schema | +
`required_relation` | +A relation is required | +
`relation_many_violation` | +A provided relation cannot contain more than one entity | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`bad_request` | +The json provided does not match the route's schema | +
`run_exhausted` | +The action run with the provided `runId` has already finished execution | +
Error | +Description | +
---|---|
`required_relation` | +Relation cannot be deleted because it is a `required relation` | +
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
Error | +Description | +
---|---|
`not_found` | +A resource with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`identifier_taken` | +The provided `identifier` already exists, identifiers must be unique | +
Error | +Description | +
---|---|
`team_inheritance_enabled` | +The blueprint's entities inherite their team from other entities through an existing relation | +
`blueprint_schema_mismatch` | +The provided entity does not match the blueprint's schema | +
`required_relation` | +A relation is required | +
`relation_many_violation` | +A provided relation cannot contain more than one entity | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
`has_dependents` | +The entity has dependent entities that must be deleted along with it. To do that, use "delete_dependents=true" | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
`has_dependents` | +The entity has dependent entities that must be deleted along with it. To do that, use "delete_dependents=true" | +
Error | +Description | +
---|---|
`not_found` | +An entity with the provided `identifier` was not found | +
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`not_found` | +An entity with the provided `identifier` was not found | +
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`run_exhausted` | +Action run has already finished execution | +
Error | +Description | +
---|---|
`required_relation` | +Relation cannot be deleted because it is a `required relation` | +
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
`not_found` | +An entity with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`identifier_taken` | +The provided `identifier` already exists, identifiers must be unique | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
`team_inheritance_enabled` | +The blueprint's entities inherite their team from other entities through an existing relation | +
`blueprint_schema_mismatch` | +The provided entity does not match the blueprint's schema | +
`required_relation` | +A relation is required | +
`relation_many_violation` | +A provided relation cannot contain more than one entity | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
+ +
+ +4. Navigate to your [runs audit page](https://app.getport.io/settings/AuditLog?activeTab=5). You should see a new `Automation` run was triggered. + + ++ +
+ +5. Click on the run and view the logs. Wait for the run to be in `Success` state. + + ++ +
+ +6. Navigate back to your [PagerDuty Incidents](https://app.getport.io/pagerdutyIncidents) page. Click on the incident entity you ingested. +7. You should notice that the `Slack Channel URL` property, and the `GitHub Issue` relation are populated. + + ++ +
+ +8. Click the `Slack Channel URL`. This will allow you to join the dedicated Slack channel created for this incident. +9. Navigate to the `GitHub Issue` through the relation. Then navigate to the `Link` to view the GitHub issue created as part of the automation. + +## Summary +Using Port as the automation orchestrator, we created an incident management flow which helps us keep a high standard when facing new incidents. +This automation will enable faster notification and response time when handling new incidents, and create a dedicated place to keep track of the troubleshooting process and any relevant updates. + +## Next Steps +This guide can be enhanced to further meet your organization's needs. Here are some ideas you can implement: +- Add a DAY-2 `Resolve incident` Port action to the `PagerDuty incident` which resolves the GitHub issue and sends an update in the Slack channel. You can use the following [guide](https://docs.getport.io/guides-and-tutorials/resolve-pagerduty-incident). +- Add a mirror property in the `PagerDuty incident` blueprint, to show the GitHub issue `Link` in the PagerDuty entity page. +- Filter the automation tirgger to only run for `High` urgency incidents. +- Add the Port service owner to the Slack channel as part of the automation. + diff --git a/docs/guides-and-tutorials/ensure-production-readiness.md b/docs/guides-and-tutorials/ensure-production-readiness.md index 583f75e30..a66b4059d 100644 --- a/docs/guides-and-tutorials/ensure-production-readiness.md +++ b/docs/guides-and-tutorials/ensure-production-readiness.md @@ -6,6 +6,7 @@ title: Ensure production readiness import Tabs from "@theme/Tabs" import TabItem from "@theme/TabItem" import PortTooltip from "/src/components/tooltip/tooltip.jsx" +import PortApiRegionTip from "/docs/generalTemplates/_port_region_parameter_explanation_template.md" # Ensure production readiness @@ -102,6 +103,7 @@ helm repo add port-labs https://port-labs.github.io/helm-charts helm upgrade --install my-pagerduty-integration port-labs/port-ocean \ --set port.clientId="CLIENT_ID" \ # REPLACE VALUE --set port.clientSecret="CLIENT_SECRET" \ # REPLACE VALUE + --set port.baseUrl="https://api.getport.io" \ --set initializePortResources=true \ --set integration.identifier="my-pagerduty-integration" \ --set integration.type="pagerduty" \ @@ -110,6 +112,8 @@ helm upgrade --install my-pagerduty-integration port-labs/port-ocean \ --set integration.config.apiUrl="https://api.pagerduty.com" ``` +Error | +Description | +
---|---|
`bad_request` | +The json provided does not match the route's schema | +
`run_exhausted` | +The action run with the provided `runId` has already finished execution | +
Error | +Description | +
---|---|
`required_relation` | +Relation cannot be deleted because it is a `required relation` | +
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
Error | +Description | +
---|---|
`not_found` | +A resource with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`identifier_taken` | +The provided `identifier` already exists, identifiers must be unique | +
Error | +Description | +
---|---|
`team_inheritance_enabled` | +The blueprint's entities inherite their team from other entities through an existing relation | +
`blueprint_schema_mismatch` | +The provided entity does not match the blueprint's schema | +
`required_relation` | +A relation is required | +
`relation_many_violation` | +A provided relation cannot contain more than one entity | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`run_exhausted` | +Action run has already finished execution | +
Error | +Description | +
---|---|
`required_relation` | +Relation cannot be deleted because it is a `required relation` | +
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
`not_found` | +An entity with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`identifier_taken` | +The provided `identifier` already exists, identifiers must be unique | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
`team_inheritance_enabled` | +The blueprint's entities inherite their team from other entities through an existing relation | +
`blueprint_schema_mismatch` | +The provided entity does not match the blueprint's schema | +
`required_relation` | +A relation is required | +
`relation_many_violation` | +A provided relation cannot contain more than one entity | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`run_exhausted` | +Action run has already finished execution | +
Error | +Description | +
---|---|
`required_relation` | +Relation cannot be deleted because it is a `required relation` | +
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
`not_found` | +An entity with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`identifier_taken` | +The provided `identifier` already exists, identifiers must be unique | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
`team_inheritance_enabled` | +The blueprint's entities inherite their team from other entities through an existing relation | +
`blueprint_schema_mismatch` | +The provided entity does not match the blueprint's schema | +
`required_relation` | +A relation is required | +
`relation_many_violation` | +A provided relation cannot contain more than one entity | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`not_found` | +An entity with the provided `identifier` was not found | +
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
`has_dependents` | +The entity has dependent entities that must be deleted along with it. To do that, use "delete_dependents=true" | +
Error | +Description | +
---|---|
`not_found` | +An entity with the provided `identifier` was not found | +
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`missing_permissions` | +You do not have permissions to perform the requested operation. For further details, please contact your admin | +
`has_dependents` | +The entity has dependent entities that must be deleted along with it. To do that, use "delete_dependents=true" | +
Error | +Description | +
---|---|
`not_found` | +A blueprint with the provided `identifier` was not found | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +
Error | +Description | +
---|---|
`invalid_request` | +The provided data does not match the route schema | +
Error | +Description | +
---|---|
`internal_error` | +An internal error occurred | +