Skip to content

Commit

Permalink
add oauth docs for pagerduty, add sso note in implementation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
hadar-co committed Jan 2, 2025
1 parent 66b2b8d commit f6738f8
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import PagerDutyWebhookConfig from "/docs/build-your-software-catalog/custom-int
import PagerDutyWebhookHistory from "/docs/build-your-software-catalog/custom-integration/webhook/examples/resources/pagerduty/\_example_pagerduty_webhook_history_config.mdx"
import PagerDutyScript from "/docs/build-your-software-catalog/custom-integration/webhook/examples/resources/pagerduty/\_example_pagerduty_shell_history_config.mdx"
import PortApiRegionTip from "/docs/generalTemplates/_port_region_parameter_explanation_template.md"
import OceanSaasInstallation from "/docs/build-your-software-catalog/sync-data-to-catalog/templates/_ocean_saas_installation.mdx"
import OceanSaasInstallation from "/docs/build-your-software-catalog/sync-data-to-catalog/templates/_ocean_saas_installation_oauth.mdx"
import OceanRealtimeInstallation from "/docs/build-your-software-catalog/sync-data-to-catalog/templates/_ocean_realtime_installation.mdx"


Expand Down Expand Up @@ -57,7 +57,7 @@ Choose one of the following installation methods:

<TabItem value="hosted-by-port" label="Hosted by Port" default>

<OceanSaasInstallation/>
<OceanSaasInstallation integration="PagerDuty" />

</TabItem>

Expand Down
4 changes: 4 additions & 0 deletions docs/guides/implementation-guide/plan/prepare-for-building.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ Read more about roles and permissions [here](https://docs.getport.io/sso-rbac/rb

Select the relevant [SSO provider](/sso-rbac/sso-providers/) and follow the instructions to set it up.

:::info Enterprise feature
Note that SSO support is an enterprise feature. If you are using the free tier, you can skip this step.
:::

## Next step - build

Once you have completed the planning phase, proceed to the [Build phase](/guides/implementation-guide/build/install-integrations) to start building components in your portal.
4 changes: 2 additions & 2 deletions docs/sso-rbac/rbac/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Team dropdown selector in the entity create/edit page:
Okta and AzureAD integrations are only available after configuring SSO from the relevant identity provider, refer to the [Single Sign-On (SSO)](../sso-providers/) section for more details
:::

<!-- ## Users and teams as blueprints
## Users and teams as blueprints

<BetaFeatureNotice />

Expand Down Expand Up @@ -397,4 +397,4 @@ Port service accounts are treated like any other users and extend the same RBAC
### Disabling service accounts
Service accounts can easily be disabled at any time. To disable a service account, update it's `status` property to `Disabled`.
Disabled service accounts can no longer generate new API tokens or use existing ones. Disabled service accounts can be re-enabled at any time by updating the `status` property back to `Active`.
-->

4 changes: 3 additions & 1 deletion src/components/ocean-saas-specifics/default-settings.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ const defaultSettings = {
GitLab:
'- `Resync interval`: Every 2 hours.' + '\n\n' +
'- `Send raw data examples`: Enabled.',

PagerDuty:
'- `Resync interval`: Every 1 hour.' + '\n\n' +
'- `Send raw data examples`: Enabled.',
};

const OceanSaasDefaultSettings = ({ id }) => {
Expand Down
3 changes: 3 additions & 0 deletions src/components/ocean-saas-specifics/integration-settings.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ const integrationSettings = {
'- `Token mapping`: Mapping of GitLab tokens to the group scopes to ingest data from into port.<br/>For example:<br/>```{"THE_GROUP_TOKEN":["getport-labs/**", "GROUP/PROJECT PATTERN TO RUN FOR"]}```.<br/>To create a group token, see the [GitLab documentation](https://docs.gitlab.com/ee/user/group/settings/group_access_tokens.html#create-a-group-access-token-using-ui).' + '\n\n' +
'- `Use system hook`: If enabled, the integration will use a system hook instead of project hooks.<br/>For a list of available system hooks, see the [GitLab documentation](https://docs.gitlab.com/ee/administration/system_hooks.html).' + '\n\n' +
'- `Token Group Hooks Override Mapping`: Mapping of Gitlab tokens to groups in which to create webhooks with specific events, if not set, it will create webhooks containing all the events, and only on root groups.<br/>For example:<br/>```{"THE_GROUP_ADMIN_TOKEN":{"GROUP1_FULL_PATH": {"events": ["merge-requests_events"]}, "GROUP2_FULL_PATH": {"events": ["push_events", "pipeline_events"]}}}.```<br/>Supported event types:<br/>```["push_events", "merge_requests_events", "issues_events", "job_events", "pipeline_events", "releases_events", "tag_push_events", "subgroup_events", "confidential_issues_events"]```',
PagerDuty:
'- `Token`: The API token used to query PagerDuty. To create a token, see the [PagerDuty documentation](https://support.pagerduty.com/docs/api-access-keys).' + '\n\n' +
'- `API URL`: The host of the PagerDuty instance. If not specified, the default will be `https://api.pagerduty.com` (or `https://api.eu.pagerduty.com` for EU customers).',
};

const OceanSaasIntegrationSettings = ({ id }) => {
Expand Down

0 comments on commit f6738f8

Please sign in to comment.