From f6738f846957128f9246cc9d794577b243d6a74a Mon Sep 17 00:00:00 2001 From: Hadar Date: Thu, 2 Jan 2025 10:27:33 +0200 Subject: [PATCH] add oauth docs for pagerduty, add sso note in implementation guide --- .../incident-management/pagerduty/pagerduty.md | 4 ++-- docs/guides/implementation-guide/plan/prepare-for-building.md | 4 ++++ docs/sso-rbac/rbac/rbac.md | 4 ++-- src/components/ocean-saas-specifics/default-settings.jsx | 4 +++- src/components/ocean-saas-specifics/integration-settings.jsx | 3 +++ 5 files changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/incident-management/pagerduty/pagerduty.md b/docs/build-your-software-catalog/sync-data-to-catalog/incident-management/pagerduty/pagerduty.md index 3a1f638dd..b0a19a19e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/incident-management/pagerduty/pagerduty.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/incident-management/pagerduty/pagerduty.md @@ -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" @@ -57,7 +57,7 @@ Choose one of the following installation methods: - + diff --git a/docs/guides/implementation-guide/plan/prepare-for-building.md b/docs/guides/implementation-guide/plan/prepare-for-building.md index 8978740ab..a9752a554 100644 --- a/docs/guides/implementation-guide/plan/prepare-for-building.md +++ b/docs/guides/implementation-guide/plan/prepare-for-building.md @@ -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. \ No newline at end of file diff --git a/docs/sso-rbac/rbac/rbac.md b/docs/sso-rbac/rbac/rbac.md index 798e3b818..2c110e3a3 100644 --- a/docs/sso-rbac/rbac/rbac.md +++ b/docs/sso-rbac/rbac/rbac.md @@ -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 ::: - + diff --git a/src/components/ocean-saas-specifics/default-settings.jsx b/src/components/ocean-saas-specifics/default-settings.jsx index 95ba903bc..f09bcc541 100644 --- a/src/components/ocean-saas-specifics/default-settings.jsx +++ b/src/components/ocean-saas-specifics/default-settings.jsx @@ -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 }) => { diff --git a/src/components/ocean-saas-specifics/integration-settings.jsx b/src/components/ocean-saas-specifics/integration-settings.jsx index 5d9341e76..b069d6cf0 100644 --- a/src/components/ocean-saas-specifics/integration-settings.jsx +++ b/src/components/ocean-saas-specifics/integration-settings.jsx @@ -10,6 +10,9 @@ const integrationSettings = { '- `Token mapping`: Mapping of GitLab tokens to the group scopes to ingest data from into port.
For example:
```{"THE_GROUP_TOKEN":["getport-labs/**", "GROUP/PROJECT PATTERN TO RUN FOR"]}```.
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.
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.
For example:
```{"THE_GROUP_ADMIN_TOKEN":{"GROUP1_FULL_PATH": {"events": ["merge-requests_events"]}, "GROUP2_FULL_PATH": {"events": ["push_events", "pipeline_events"]}}}.```
Supported event types:
```["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 }) => {