diff options
Diffstat (limited to 'integrations')
22 files changed, 44849 insertions, 57 deletions
diff --git a/integrations/cloud-authentication/integrations/oidc.md b/integrations/cloud-authentication/integrations/oidc.md new file mode 100644 index 0000000000..a9be92126f --- /dev/null +++ b/integrations/cloud-authentication/integrations/oidc.md @@ -0,0 +1,64 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/integrations/oidc.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/metadata.yaml" +sidebar_label: "OIDC" +learn_status: "Published" +learn_rel_path: "Netdata Cloud/Authentication & Authorization/Cloud Authentication & Authorization Integrations" +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE AUTHENTICATION'S metadata.yaml FILE" +endmeta--> + +# OIDC + + +<img src="https://netdata.cloud/img/openid.svg" width="150"/> + + +Integrate your organization's Authorization Servers with Netdata to better manage your team's access controls to Netdata Cloud. + + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Setup + +### Prerequisites +- Authorization Server with OIDC protocol supported +- A Netdata Cloud account +- Access to the Space as an **Admin** +- Space needs to be on a paid plan + +### Setting up Authorization Server +Your server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html). +In order to integrate your Authorization Server with Netdata the creation of a client is required. Clients are applications and services that can request authentication of a user. +The access settings for your client are the following: + +| field | value | +| :-- | :-- | +| Root URL | `https://app.netdata.cloud/`` | +| Home/Initiate login URL | `https://app.netdata.cloud/api/v2/auth/account/auth-server?iss={your-server-issuer-url}&redirect_uri=https://app.netdata.cloud/sign-in®ister_uri=https://app.netdata.cloud/sign-up/verify` | +| Redirect URL | `https://app.netdata.cloud/api/v2/auth/account/auth-server/callback` | + +### Netdata Configuration Steps +1. Click on the Space settings cog (located above your profile icon) +2. Click on the **Authentication** tab +3. On the OIDC card, click on **Configure** +4. Fill in the required credentials: + - **Issuer URL** the Authorization Server Issuer URL, e.g. `https://my-auth-server.com/` + - **Client ID** the Client ID from the created client + - **Client Secret** the Client Secret from the created client + - **Authorization URL** the Authorization Server authorization URL, e.g. `https://my-auth-server.com/openid-connect/auth` + - **Token URL** the Authorization Server token URL, e.g. `https://my-auth-server.com/openid-connect/token` + - **User URL** the Authorization Server user info URL, e.g. `https://my-auth-server.com/openid-connect/userinfo` + +### Supported features +* SP-initiated SSO (Single Sign-On) +* IdP-initiated SSO + +### SP-initiated SSO + +If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md#from-netdata-sign-up-page). + + +### Reference +https://openid.net/developers/how-connect-works/ + + diff --git a/integrations/cloud-authentication/integrations/okta_sso.md b/integrations/cloud-authentication/integrations/okta_sso.md index a7f416dea0..aeadec46a0 100644 --- a/integrations/cloud-authentication/integrations/okta_sso.md +++ b/integrations/cloud-authentication/integrations/okta_sso.md @@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/metadata.yaml" sidebar_label: "Okta SSO" learn_status: "Published" -learn_rel_path: "Authentication" +learn_rel_path: "Netdata Cloud/Authentication & Authorization/Cloud Authentication & Authorization Integrations" message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE AUTHENTICATION'S metadata.yaml FILE" endmeta--> @@ -23,8 +23,8 @@ Integrate your organization's Okta account with Netdata to better manage your te ### Prerequisites - An Okta account - A Netdata Cloud account -- Access to the Space as an administrator -- Space needs to be on the Business plan or higher +- Access to the Space as an **Admin** +- Space needs to be on a paid plan ### Setting up Okta Steps needed to be done on Okta Admin Portal: @@ -44,4 +44,12 @@ Steps needed to be done on Okta Admin Portal: - **Client ID** you can get it from **General** tab on application you configured on Okta - **Client Secret** you can get it from **General** tab on application you configured on Okta +### Supported features +* SP-initiated SSO (Single Sign-On) +* IdP-initiated SSO + +### SP-initiated SSO + +If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md#from-netdata-sign-up-page). + diff --git a/integrations/cloud-authentication/metadata.yaml b/integrations/cloud-authentication/metadata.yaml index 18925d5d53..8f461845bf 100644 --- a/integrations/cloud-authentication/metadata.yaml +++ b/integrations/cloud-authentication/metadata.yaml @@ -19,8 +19,8 @@ ### Prerequisites - An Okta account - A Netdata Cloud account - - Access to the Space as an administrator - - Space needs to be on the Business plan or higher + - Access to the Space as an **Admin** + - Space needs to be on a paid plan ### Setting up Okta Steps needed to be done on Okta Admin Portal: @@ -39,3 +39,67 @@ - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com` - **Client ID** you can get it from **General** tab on application you configured on Okta - **Client Secret** you can get it from **General** tab on application you configured on Okta + + ### Supported features + * SP-initiated SSO (Single Sign-On) + * IdP-initiated SSO + + ### SP-initiated SSO + + If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md#from-netdata-sign-up-page). + +- id: 'oidc-authentication' + meta: + name: 'OIDC' + link: 'https://netdata.cloud' + categories: + - auth + icon_filename: 'openid.svg' + keywords: + - sso + - oidc + overview: + authentication_description: "Integrate your organization's Authorization Servers with Netdata to better manage your team's access controls to Netdata Cloud." + authentication_limitations: '' + setup: + description: | + ### Prerequisites + - Authorization Server with OIDC protocol supported + - A Netdata Cloud account + - Access to the Space as an **Admin** + - Space needs to be on a paid plan + + ### Setting up Authorization Server + Your server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html). + In order to integrate your Authorization Server with Netdata the creation of a client is required. Clients are applications and services that can request authentication of a user. + The access settings for your client are the following: + + | field | value | + | :-- | :-- | + | Root URL | `https://app.netdata.cloud/`` | + | Home/Initiate login URL | `https://app.netdata.cloud/api/v2/auth/account/auth-server?iss={your-server-issuer-url}&redirect_uri=https://app.netdata.cloud/sign-in®ister_uri=https://app.netdata.cloud/sign-up/verify` | + | Redirect URL | `https://app.netdata.cloud/api/v2/auth/account/auth-server/callback` | + + ### Netdata Configuration Steps + 1. Click on the Space settings cog (located above your profile icon) + 2. Click on the **Authentication** tab + 3. On the OIDC card, click on **Configure** + 4. Fill in the required credentials: + - **Issuer URL** the Authorization Server Issuer URL, e.g. `https://my-auth-server.com/` + - **Client ID** the Client ID from the created client + - **Client Secret** the Client Secret from the created client + - **Authorization URL** the Authorization Server authorization URL, e.g. `https://my-auth-server.com/openid-connect/auth` + - **Token URL** the Authorization Server token URL, e.g. `https://my-auth-server.com/openid-connect/token` + - **User URL** the Authorization Server user info URL, e.g. `https://my-auth-server.com/openid-connect/userinfo` + + ### Supported features + * SP-initiated SSO (Single Sign-On) + * IdP-initiated SSO + + ### SP-initiated SSO + + If you start your authentication flow from Netdata sign-in page please check [these steps](/docs/netdata-cloud/authentication-and-authorization/enterprise-sso-authentication.md#from-netdata-sign-up-page). + + + ### Reference + https://openid.net/developers/how-connect-works/ diff --git a/integrations/cloud-notifications/integrations/amazon_sns.md b/integrations/cloud-notifications/integrations/amazon_sns.md index b0c8498944..45bf0f6da0 100644 --- a/integrations/cloud-notifications/integrations/amazon_sns.md +++ b/integrations/cloud-notifications/integrations/amazon_sns.md @@ -25,8 +25,8 @@ From the Cloud interface, you can manage your space's notification settings and To add AWS SNS notification you need: - A Netdata Cloud account -- Access to the space as an **administrator** -- Space needs to be on **Business** plan or higher +- Access to the space as an **Admin** +- The Space needs to be on a paid plan - Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns) ### Steps diff --git a/integrations/cloud-notifications/integrations/discord.md b/integrations/cloud-notifications/integrations/discord.md index 7b9d0ff0e1..3553d17be5 100644 --- a/integrations/cloud-notifications/integrations/discord.md +++ b/integrations/cloud-notifications/integrations/discord.md @@ -22,7 +22,7 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** +- Access to the Netdata Space as an **Admin** - You need to have a Discord server able to receive webhooks integrations. ### Discord Server Configuration diff --git a/integrations/cloud-notifications/integrations/mattermost.md b/integrations/cloud-notifications/integrations/mattermost.md index cc48921e58..4302a2e848 100644 --- a/integrations/cloud-notifications/integrations/mattermost.md +++ b/integrations/cloud-notifications/integrations/mattermost.md @@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** -- The Netdata Space needs to be on **Business** plan or higher +- Access to the Netdata Space as an **Admin** +- The Netdata Space needs to be on a paid plan - You need to have permissions on Mattermost to add new integrations. - You need to have a Mattermost app on your workspace to receive the webhooks. diff --git a/integrations/cloud-notifications/integrations/microsoft_teams.md b/integrations/cloud-notifications/integrations/microsoft_teams.md index e015114f5c..203118b3c4 100644 --- a/integrations/cloud-notifications/integrations/microsoft_teams.md +++ b/integrations/cloud-notifications/integrations/microsoft_teams.md @@ -25,8 +25,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and To add Microsoft Teams notifications integration to your Netdata Cloud space you will need the following: - A Netdata Cloud account. -- Access to the Netdata Cloud space as an **administrator**. -- The Space to be on **Business** plan or higher. +- Access to the Netdata Cloud space as an **Admin**. +- The Space to be on a paid plan. - A [Microsoft 365 for Business Account](https://www.microsoft.com/en-us/microsoft-365/business). Note that this is a **paid** account. ### Settings on Microsoft Teams diff --git a/integrations/cloud-notifications/integrations/netdata_mobile_app.md b/integrations/cloud-notifications/integrations/netdata_mobile_app.md index 71fc92c16a..93de1316b2 100644 --- a/integrations/cloud-notifications/integrations/netdata_mobile_app.md +++ b/integrations/cloud-notifications/integrations/netdata_mobile_app.md @@ -30,7 +30,7 @@ Steps to login to the Netdata Mobile Application to receive alert and reachabili 2. Open the App and Choose the Sign In Option - Sign In with Email Address: Enter the Email Address of your registered Netdata Cloud Account and Click on the Verification link received by Email on your mobile device. - Sign In with QR Code: Scan the QR Code from your `Netdata Cloud` UI under **User Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code** -3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Business Subscription** +3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Subscription plan** ### Netdata Configuration Steps 1. Click on the **User settings** on the bottom left of your screen (your profile icon) diff --git a/integrations/cloud-notifications/integrations/opsgenie.md b/integrations/cloud-notifications/integrations/opsgenie.md index 21c9162092..594945f4c6 100644 --- a/integrations/cloud-notifications/integrations/opsgenie.md +++ b/integrations/cloud-notifications/integrations/opsgenie.md @@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** -- The Netdata Space needs to be on **Business** plan or higher +- Access to the Netdata Space as an **Admin** +- The Netdata Space needs to be on a paid plan - You need to have permissions on Opsgenie to add new integrations. ### Opsgenie Server Configuration diff --git a/integrations/cloud-notifications/integrations/pagerduty.md b/integrations/cloud-notifications/integrations/pagerduty.md index 9d1f81ee1f..2749497304 100644 --- a/integrations/cloud-notifications/integrations/pagerduty.md +++ b/integrations/cloud-notifications/integrations/pagerduty.md @@ -22,8 +22,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** -- The Netdata Space needs to be on **Business** plan or higher +- Access to the Netdata Space as an **Admin** +- The Netdata Space needs to be on a paid plan - You need to have a PagerDuty service to receive events using webhooks. diff --git a/integrations/cloud-notifications/integrations/rocketchat.md b/integrations/cloud-notifications/integrations/rocketchat.md index 9f625f3f7b..3008482321 100644 --- a/integrations/cloud-notifications/integrations/rocketchat.md +++ b/integrations/cloud-notifications/integrations/rocketchat.md @@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** -- The Netdata Space needs to be on **Business** plan or higher +- Access to the Netdata Space as an **Admin** +- The Netdata Space needs to be on a paid plan - You need to have permissions on Mattermost to add new integrations. - You need to have a RocketChat app on your workspace to receive the webhooks. diff --git a/integrations/cloud-notifications/integrations/slack.md b/integrations/cloud-notifications/integrations/slack.md index 9bb5be2c8f..bed51b5ad6 100644 --- a/integrations/cloud-notifications/integrations/slack.md +++ b/integrations/cloud-notifications/integrations/slack.md @@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** -- The Netdata Space needs to be on **Business** plan or higher +- Access to the Netdata Space as an **Admin** +- The Netdata Space needs to be on a paid plan - You need to have a Slack app on your workspace to receive the Webhooks. ### Slack Server Configuration diff --git a/integrations/cloud-notifications/integrations/splunk.md b/integrations/cloud-notifications/integrations/splunk.md index 6cbf6b0422..b69032ba69 100644 --- a/integrations/cloud-notifications/integrations/splunk.md +++ b/integrations/cloud-notifications/integrations/splunk.md @@ -25,8 +25,8 @@ From the Cloud interface, you can manage your space's notification settings and To add Splunk notification you need: - A Netdata Cloud account -- Access to the space as an **administrator** -- Space needs to be on **Business** plan or higher +- Access to the space as an **Admin** +- The Space needs to be on a paid plan - URI and token for your Splunk HTTP Event Collector. Refer to the [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) for detailed instructions. ### Steps diff --git a/integrations/cloud-notifications/integrations/splunk_victorops.md b/integrations/cloud-notifications/integrations/splunk_victorops.md new file mode 100644 index 0000000000..f5d7932a01 --- /dev/null +++ b/integrations/cloud-notifications/integrations/splunk_victorops.md @@ -0,0 +1,46 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/splunk_victorops.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml" +sidebar_label: "Splunk VictorOps" +learn_status: "Published" +learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications" +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" +endmeta--> + +# Splunk VictorOps + + +<img src="https://netdata.cloud/img/victorops.svg" width="150"/> + + +From the Cloud interface, you can manage your space's notification settings and from there you can add a specific configuration to get notifications delivered on Splunk On-Call/VictorOps. + + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Setup + +### Prerequisites + +To add Splunk VictorOps notification (also known as Splunk On-Call) you need: + +- A Netdata Cloud account +- Access to the space as an **Admin** +- The Space needs to be on a paid plan +- Destination URL for your Splunk VictorOps REST Endpoint Integration. Refer to the [VictorOps documentation](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide) for detailed instructions. + +### Steps + +1. Click on the **Space settings** cog (located above your profile icon) +2. Click on the **Notification** tab +3. Click on the **+ Add configuration** button (near the top-right corner of your screen) +4. On the **Splunk VictorOps** card click on **+ Add** +5. A modal will be presented to you to enter the required details to enable the configuration: + - **Notification settings** are Netdata specific settings + - Configuration name - provide a descriptive name for your configuration to easily identify it. + - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about. + - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only. + - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk VictorOps: + - Destination URL - The URL provided by VictorOps of your REST endpoint. + + diff --git a/integrations/cloud-notifications/integrations/telegram.md b/integrations/cloud-notifications/integrations/telegram.md index 83d94ecca3..dfc8a4cdbd 100644 --- a/integrations/cloud-notifications/integrations/telegram.md +++ b/integrations/cloud-notifications/integrations/telegram.md @@ -25,8 +25,8 @@ From the Cloud interface, you can manage your space's notification settings and To add Telegram notification you need: - A Netdata Cloud account -- Access to the space as an **administrator** -- Space needs to be on **Business** plan or higher +- Access to the space as an **Admin** +- The Space needs to be on a paid plan - The Telegram bot token and chat ID ### Steps diff --git a/integrations/cloud-notifications/integrations/webhook.md b/integrations/cloud-notifications/integrations/webhook.md index f3caff5828..8d177f0cbe 100644 --- a/integrations/cloud-notifications/integrations/webhook.md +++ b/integrations/cloud-notifications/integrations/webhook.md @@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and ### Prerequisites - A Netdata Cloud account -- Access to the Netdata Space as an **administrator** -- The Netdata Space needs to be on **Pro** plan or higher +- Access to the Netdata Space as an **Admin** +- The Netdata Space needs to be on a paid plan - You need to have an app that allows you to receive webhooks following a predefined schema. ### Netdata Configuration Steps diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml index c7dc77d142..88bc9cc420 100644 --- a/integrations/cloud-notifications/metadata.yaml +++ b/integrations/cloud-notifications/metadata.yaml @@ -26,7 +26,7 @@ 2. Open the App and Choose the Sign In Option - Sign In with Email Address: Enter the Email Address of your registered Netdata Cloud Account and Click on the Verification link received by Email on your mobile device. - Sign In with QR Code: Scan the QR Code from your `Netdata Cloud` UI under **User Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code** - 3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Business Subscription** + 3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Subscription plan** ### Netdata Configuration Steps 1. Click on the **User settings** on the bottom left of your screen (your profile icon) @@ -50,7 +50,7 @@ description: | ### Prerequisites - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** + - Access to the Netdata Space as an **Admin** - You need to have a Discord server able to receive webhooks integrations. ### Discord Server Configuration @@ -91,8 +91,8 @@ description: | ### Prerequisites - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher + - Access to the Netdata Space as an **Admin** + - The Netdata Space needs to be on a paid plan - You need to have a PagerDuty service to receive events using webhooks. @@ -135,8 +135,8 @@ ### Prerequisites - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher + - Access to the Netdata Space as an **Admin** + - The Netdata Space needs to be on a paid plan - You need to have a Slack app on your workspace to receive the Webhooks. ### Slack Server Configuration @@ -185,8 +185,8 @@ ### Prerequisites - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher + - Access to the Netdata Space as an **Admin** + - The Netdata Space needs to be on a paid plan - You need to have permissions on Opsgenie to add new integrations. ### Opsgenie Server Configuration @@ -228,8 +228,8 @@ ### Prerequisites - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher + - Access to the Netdata Space as an **Admin** + - The Netdata Space needs to be on a paid plan - You need to have permissions on Mattermost to add new integrations. - You need to have a Mattermost app on your workspace to receive the webhooks. @@ -279,8 +279,8 @@ ### Prerequisites - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher + - Access to the Netdata Space as an **Admin** + - The Netdata Space needs to be on a paid plan - You need to have permissions on Mattermost to add new integrations. - You need to have a RocketChat app on your workspace to receive the webhooks. @@ -332,8 +332,8 @@ To add AWS SNS notification you need: - A Netdata Cloud account - - Access to the space as an **administrator** - - Space needs to be on **Business** plan or higher + - Access to the space as an **Admin** + - The Space needs to be on a paid plan - Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns) ### Steps @@ -381,8 +381,8 @@ To add Microsoft Teams notifications integration to your Netdata Cloud space you will need the following: - A Netdata Cloud account. - - Access to the Netdata Cloud space as an **administrator**. - - The Space to be on **Business** plan or higher. + - Access to the Netdata Cloud space as an **Admin**. + - The Space to be on a paid plan. - A [Microsoft 365 for Business Account](https://www.microsoft.com/en-us/microsoft-365/business). Note that this is a **paid** account. ### Settings on Microsoft Teams @@ -430,8 +430,8 @@ To add Telegram notification you need: - A Netdata Cloud account - - Access to the space as an **administrator** - - Space needs to be on **Business** plan or higher + - Access to the space as an **Admin** + - The Space needs to be on a paid plan - The Telegram bot token and chat ID ### Steps @@ -475,8 +475,8 @@ To add Splunk notification you need: - A Netdata Cloud account - - Access to the space as an **administrator** - - Space needs to be on **Business** plan or higher + - Access to the space as an **Admin** + - The Space needs to be on a paid plan - URI and token for your Splunk HTTP Event Collector. Refer to the [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) for detailed instructions. ### Steps @@ -494,6 +494,45 @@ - HTTP Event Collector URI - The URI of your HTTP event collector in Splunk - HTTP Event Collector Token - the token that Splunk provided to you when you created the HTTP Event Collector +- id: 'notify-cloud-victorops' + meta: + name: 'Splunk VictorOps' + link: 'https://www.splunk.com/en_us/about-splunk/acquisitions/splunk-on-call.html' + categories: + - notify.cloud + icon_filename: 'victorops.svg' + keywords: + - VictorOps + - Splunk + - On-Call + overview: + notification_description: "From the Cloud interface, you can manage your space's notification settings and from there you can add a specific configuration to get notifications delivered on Splunk On-Call/VictorOps." + notification_limitations: '' + setup: + description: | + ### Prerequisites + + To add Splunk VictorOps notification (also known as Splunk On-Call) you need: + + - A Netdata Cloud account + - Access to the space as an **Admin** + - The Space needs to be on a paid plan + - Destination URL for your Splunk VictorOps REST Endpoint Integration. Refer to the [VictorOps documentation](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide) for detailed instructions. + + ### Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **Splunk VictorOps** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + - **Notification settings** are Netdata specific settings + - Configuration name - provide a descriptive name for your configuration to easily identify it. + - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about. + - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only. + - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk VictorOps: + - Destination URL - The URL provided by VictorOps of your REST endpoint. + - id: 'notify-cloud-webhook' meta: name: 'Webhook' @@ -512,8 +551,8 @@ ### Prerequisites - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Pro** plan or higher + - Access to the Netdata Space as an **Admin** + - The Netdata Space needs to be on a paid plan - You need to have an app that allows you to receive webhooks following a predefined schema. ### Netdata Configuration Steps diff --git a/integrations/gen_docs_integrations.py b/integrations/gen_docs_integrations.py index 27d2ce72e3..2a35efb2b3 100644 --- a/integrations/gen_docs_integrations.py +++ b/integrations/gen_docs_integrations.py @@ -265,7 +265,7 @@ endmeta--> meta_yaml: "{meta_yaml}" sidebar_label: "{sidebar_label}" learn_status: "Published" -learn_rel_path: "{learn_rel_path.replace("authentication", "Authentication")}" +learn_rel_path: "{learn_rel_path.replace("authentication", "Netdata Cloud/Authentication & Authorization/Cloud Authentication & Authorization Integrations")}" message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE AUTHENTICATION'S metadata.yaml FILE" endmeta--> diff --git a/integrations/gen_integrations.py b/integrations/gen_integrations.py index c217c976db..9510fdc7f2 100755 --- a/integrations/gen_integratio |