Skip to content

Commit

Permalink
PORT-11542 Jira Integration guide refactoring (#1767)
Browse files Browse the repository at this point in the history
* - moved table below tabs
- included OceanRealtimeInstallation component
- added let's test it again

* - added intro statement to jira and pagerduty and the template

* - modified template and jira scheduled ci content to all have the same realtime update warning and consistent heading

* - removed ado admonition

* - fixed broken table
  • Loading branch information
kodjomiles authored Nov 28, 2024
1 parent 398fd6d commit 29efe34
Show file tree
Hide file tree
Showing 5 changed files with 341 additions and 79 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ Choose one of the following installation methods:

<TabItem value="real-time-self-hosted" label="Real-time (self-hosted)">

Using this installation option means that the integration will be able to update Port in real time using webhooks.


<h2> Prerequisites </h2>

<Prerequisites />
Expand All @@ -68,7 +71,7 @@ For details about the available parameters for the installation, see the table b

<TabItem value="helm" label="Helm" default>

<OceanRealtimeInstallation integration="pagerduty" />
<OceanRealtimeInstallation integration="PagerDuty" />

<PortApiRegionTip/>

Expand Down Expand Up @@ -183,13 +186,14 @@ This table summarizes the available parameters for the installation.
</TabItem>

<TabItem value="one-time-ci" label="Scheduled (CI)">
<Tabs groupId="cicd-method" queryString="cicd-method">
<TabItem value="github" label="GitHub">
This workflow will run the PagerDuty integration once and then exit, this is useful for **scheduled** ingestion of data.

:::warning
If you want the integration to update Port in real time using webhooks you should use the [Real Time & Always On](?installation-methods=real-time-always-on#installation) installation option
This workflow/pipeline will run the PagerDuty integration once and then exit, this is useful for **scheduled** ingestion of data.

:::warning Real-time updates
If you want the integration to update Port in real time using webhooks you should use the [Real Time & Always On](?installation-methods=real-time-always-on#installation) installation option.
:::
<Tabs groupId="cicd-method" queryString="cicd-method">
<TabItem value="github" label="GitHub">

Make sure to configure the following [Github Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions):

Expand Down Expand Up @@ -227,16 +231,11 @@ jobs:
</TabItem>
<TabItem value="jenkins" label="Jenkins">

This pipeline will run the PagerDuty integration once and then exit, this is useful for **scheduled** ingestion of data.

:::tip
Your Jenkins agent should be able to run docker commands.
:::

:::warning
If you want the integration to update Port in real time using webhooks you should use
the [Real Time & Always On](?installation-methods=real-time-always-on#installation) installation option.
:::

Make sure to configure the following [Jenkins Credentials](https://www.jenkins.io/doc/book/using/using-credentials/)
of `Secret Text` type:
Expand Down Expand Up @@ -290,7 +289,7 @@ pipeline {
</TabItem>

<TabItem value="azure" label="Azure Devops">
<AzurePremise name="PagerDuty" />
<AzurePremise />

<DockerParameters />

Expand Down Expand Up @@ -335,11 +334,6 @@ steps:

</TabItem>
<TabItem value="gitlab" label="GitLab">
This workflow will run the PagerDuty integration once and then exit, this is useful for **scheduled** ingestion of data.

:::warning Realtime updates in Port
If you want the integration to update Port in real time using webhooks you should use the [Real Time & Always On](?installation-methods=real-time-always-on#installation) installation option.
:::

Make sure to [configure the following GitLab variables](https://docs.gitlab.com/ee/ci/variables/#for-a-project):

Expand Down Expand Up @@ -772,7 +766,7 @@ To enrich your PagerDuty incident entities with analytics data, follow the steps

To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your [data sources page](https://app.getport.io/settings/data-sources). Find the integration in the list of data sources and click on it to open the playground.

Additional examples of blueprints and the relevant integration configurations can be found on the pagerduty [examples page](example.md)
Additional examples of blueprints and the relevant integration configurations can be found on the pagerduty [examples page](examples.md)


## Let's Test It
Expand Down
Loading

0 comments on commit 29efe34

Please sign in to comment.