Merge pull request #1683 from splunk/repo-sync

Pulling refs/heads/main into main

Author: aurbiztondo-splunk

alerts-detectors-notifications/alerts-and-detectors/alerts-detectors-notifications.rst

@@ -85,7 +85,7 @@ To learn more, see :ref:`condition-reference`.
       <h2>Alerts<a name="alerts" class="headerlink" href="#alerts" title="Permalink to this headline">¶</a></h2>
     </embed>
 
-When data in an input MTS matches a condition, the detector generates a trigger event and an alert that has a specific severity level. You can configure an alert to send a notification using Splunk On-Call. For more information, see the :new-page:`Splunk On-Call <https://help.victorops.com/>` documentation.
+When data in an input MTS matches a condition, the detector generates a trigger event and an alert that has a specific severity level. You can configure an alert to send a notification using Splunk On-Call. For more information, see the :ref:`about-spoc` documentation.
 
 Alert rules use settings you specify for built-in alert conditions to define thresholds that trigger alerts. When a detector determines that the conditions for a rule are met, it triggers an alert, creates an event, and sends notifications (if specified). Detectors can send notifications via email, as well as via other systems, such as Slack, or via a webhook.
 

gdi/opentelemetry/components/receiver-creator-receiver.rst

@@ -7,9 +7,9 @@ Receiver creator receiver
 .. meta::
       :description: Use the receiver creator to create receivers at runtime in the OpenTelemetry Collector based on rules. Read on to learn how to configure the component.
 
-The receiver creator receiver allows the Splunk Distribution of the OpenTelemetry Collector to create new receivers at runtime based on configured rules and observer extensions. The supported pipeline types are ``metrics``, ``traces``, and ``logs``. See :ref:`otel-data-processing` for more information.
+Use the Receiver creator receiver with the Splunk Distribution of the OpenTelemetry Collector to create new receivers at runtime based on configured rules and observer extensions. The supported pipeline types are ``metrics``, ``traces``, and ``logs``. See :ref:`otel-data-processing` for more information.
 
-You can use any of the following observer extensions as listeners for the receiver creator:
+You can use any of the following observer extensions as listeners for the Receiver creator:
 
 - ``docker_observer``: Detects and reports running container endpoints through the Docker API.
 - ``ecs_task_observer``: Detects and reports container endpoints for running ECS tasks.
@@ -29,17 +29,16 @@ Follow these steps to configure and activate the component:
    - :ref:`otel-install-windows`
    - :ref:`otel-install-k8s`
 
-2. Configure the receiver creator receiver as described in the next section.
+2. Configure the Receiver creator receiver as described in the next section.
 3. Restart the Collector.
 
-Sample configurations
+Sample configuration
 ----------------------
 
-To activate the receiver creator receiver, add the desired extensions to the ``extensions`` section of your configuration file, followed by ``receiver_creator`` instances in the ``receivers`` section. For example:
+To activate the Receiver creator receiver add the desired extensions to the ``extensions`` section of your configuration file, followed by ``receiver_creator`` instances in the ``receivers`` section. For example:
 
 .. code-block:: yaml
 
-
    extensions:
       # Configures the Kubernetes observer to watch for pod start and stop events.
       k8s_observer:
@@ -76,16 +75,10 @@ To activate the receiver creator receiver, add the desired extensions to the ``e
 
 You can nest and configure any supported receiver inside the ``receivers`` section of a ``receiver_creator`` configuration. Which receiver you can nest depends on the type of infrastructure the receiver creator is watching through the extensions defined in ``watch_observers``.
 
-Rules expressions
-------------------------------------
-
-New receivers are created dynamically based on rules. Each rule must start with ``type == ("pod"|"port"|"hostport"|"container"|"k8s.node") &&`` such that the rule matches only one endpoint type. For a list of variable available to each endpoint type, see :new-page:`Rules expressions <https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/receivercreator/README.md#rule-expressions>` on GitHub.
-
-
-Docker observer example
+Example: Docker observer 
 ------------------------------------
 
-The following example shows how to configure the receiver creator using the Docker observer:
+The following example shows how to configure the Receiver creator receiver using the Docker observer:
 
 .. code-block:: yaml
 
@@ -113,10 +106,10 @@ The following example shows how to configure the receiver creator using the Dock
 
 .. note:: See :new-page:`https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/observer/dockerobserver/README.md` for a complete list of settings.
 
-Kubernetes observer example
+Example: Kubernetes observer 
 ------------------------------------
 
-The following example shows how to configure the receiver creator using the Kubernetes observer:
+The following example shows how to configure the receiver creator receiver using the Kubernetes observer:
 
 .. code-block:: yaml
 
@@ -149,10 +142,18 @@ The following example shows how to configure the receiver creator using the Kube
 
 .. note:: See :new-page:`https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/observer/k8sobserver/README.md` for a complete list of settings.
 
+Rules to create new receivers
+============================================
+
+You can use this receiver to dynamically create new receivers based on rules. Each rule must start with ``type == ("pod"|"port"|"hostport"|"container"|"k8s.node") &&`` such that the rule matches only one endpoint type. 
+
+For a list of variables available to each endpoint type, see :new-page:`Rules expressions <https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/receivercreator/README.md#rule-expressions>` on GitHub.
+
+
 Settings
 ======================
 
-The following table shows the configuration options for the receiver creator receiver:
+The following table shows the configuration options for the Receiver creator receiver:
 
 .. raw:: html
 
@@ -161,8 +162,6 @@ The following table shows the configuration options for the receiver creator rec
 Troubleshooting
 ======================
 
-
-
 .. raw:: html
 
    <div class="include-start" id="troubleshooting-components.rst"></div>

get-started/overview.rst

@@ -105,7 +105,7 @@ For more information, see :ref:`logs-intro-logconnect`.
 
 Splunk On-Call incident response software aligns log management, monitoring, chat tools, and more, for a single-pane of glass into system health. Splunk On-Call automates delivery of alerts to get the right alert, to the right person, at the right time.
 
-For more information, see the :new-page:`Splunk On-Call documentation <https://help.victorops.com/>`.
+For more information, see the :ref:`about-spoc`.
 
 .. raw:: html
 

sp-oncall/admin/get-started/admin-getting-started.rst

@@ -57,7 +57,7 @@ The Team page is your central location for configuring teams, schedules, rotatio
 :ref:`Create Escalation Policies <team-escalation-policy>` - Escalation policies determine which incidents are routed, to whom they are routed, and how they are escalated. Essentially, an escalation policy is how Splunk On-Call escalates a triggered event.
 
 -  Best practice for setting up your escalation policy is to establish a minimum of three escalation paths: on-duty user, previous or next user in a rotation, and manager or team lead.
--  :ref:`Read this post <mult-escalation-policies>` for more tips and tricks on how to manage multiple alert behaviors within a single team.
+-  :ref:`Read this post <multi-escalation-policies>` for more tips and tricks on how to manage multiple alert behaviors within a single team.
 
 - :ref:`Configure Routing Keys <spoc-routing-keys>` - Routing keys tie the alerts from your monitoring tools to the specific team (or escalation policy) in Splunk On-Call. This helps get the right person on the problem and reduce alert noise for those unrelated to a specific incident. These can be found by navigating to :menuselection:`Settings` then :menuselection:`Routing Keys`.
 

sp-oncall/admin/get-started/api.rst

@@ -1,5 +1,3 @@
-
-
 .. _spoc-api:
 
 ************************************************************************

sp-oncall/admin/get-started/onboarding-milestones.rst

@@ -49,7 +49,7 @@ Team milestones include the following:
    - :ref:`schedule-examples`
 #. Implementation of Team Workflows, including:
    - :ref:`Create escalation policies <team-escalation-policy>`.
-   - :ref:`Tips and tricks for multiple escalation policies <mult-escalation-policies>`.
+   - :ref:`Tips and tricks for multiple escalation policies <multi-escalation-policies>`.
 
 
 Integration milestones

sp-oncall/admin/get-started/team-dashboard.rst

@@ -1,23 +1,23 @@
 .. _team-dashboard:
 
 ************************************************************************
-Splunk On-Call Team dashboard
+Splunk On-Call 
 ************************************************************************
 
 .. meta::
    :description: Splunk On-Call system requirements, including browsers, mobile support, and incident requirements.
 
 
 
-The Splunk On-Call Team Dashboard provides a comprehensive overview of incidents. This view automatically defaults to the teams that you are a member of and allows teams to dive into the details and understand the status of alerts or incidents. 
+The Splunk On-Call  provides a comprehensive overview of incidents. This view automatically defaults to the teams that you are a member of and allows teams to dive into the details and understand the status of alerts or incidents. 
 
 All incidents derived from integrated monitoring tools in the incident table include  their respective logos to help you rapidly identify the source of an alert. Manually created incidents, along with incidents originating from the Email Endpoint or the REST API integrations, will remain logo free.
 
 Information Alerts can still be found on the Timeline Page.
 
 .. image:: /_images/spoc/team-dashboard.png
     :width: 100%
-    :alt: An image of the team dashboard. On-Call individuals listed on the left; Team incidents are shown in the main pane.
+    :alt: An image of the . On-Call individuals listed on the left; Team incidents are shown in the main pane.
 
 
 Filters
@@ -44,12 +44,12 @@ Quickly identify responsible parties during a firefight by easily seeing which p
 Manual Incident Creation
 ----------------------------
 
-You can create a manual incident from the team dashboard by selecting :guilabel:`Create Incident` in the top right corner.  For instructions, see :ref:`manual-incident`.
+You can create a manual incident from the  by selecting :guilabel:`Create Incident` in the top right corner.  For instructions, see :ref:`manual-incident`.
 
 Incident War Rooms
 ----------------------------
 
-Access Incident Details directly from the Team Dashboard by selecting the incident number link. This will expand the incident and its event history in the :ref:`Incident War Room <war-room>`. 
+Access Incident Details directly from the  by selecting the incident number link. This will expand the incident and its event history in the :ref:`Incident War Room <war-room>`. 
 
 People Table
 ==================

sp-oncall/admin/sso/single-sign-sso.rst

@@ -10,13 +10,17 @@ Configure Single Sign-On for Splunk On-Call
 .. toctree::
    :hidden: 
 
-   sp-sso-okta
-   sp-sso-google
-   sp-sso-adfs
+   Configure SSO for Okta<sp-sso-okta>
+   Configure SSO for Google<sp-sso-google>
+   Configure SSO for ADFS<sp-sso-adfs>
+   Configure SSO for other IDPs<sp-sso-other>
    sp-sso-users
 
-Requirements
-==================
+.. raw:: html
+
+  <embed>
+    <h2>Requirements<a name="requirements" class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
+  </embed>
 
 This integration is compatible with the following versions of Splunk On-Call:
 
@@ -25,18 +29,16 @@ This integration is compatible with the following versions of Splunk On-Call:
 To enable single sign-on (SSO) for your organization, you will need to provide an updated metadata file and your IDP. If you are
 interested in setting up SSO, please contact :ref:`Splunk On-Call Support <spoc-support>`.
 
-
-
 Configure Single Sign On (SSO) between your Identity Provider (IDP) and  Splunk On-Call. Our standard SSO setup uses SAML 2.0 protocol. As long as your IDP can use SAML 2.0 protocol, it can integrate with Splunk On-Call. The exact steps differ depending on which IDP you use, but the process typically involves exporting a .XML metadata file and sending it to our Support team. Once you have sent the .xml file, a Splunk On-Call support specialist will
 complete the setup on the back-end and respond with confirmation.
 
 If your IDP does not have SAML capability, please contact Splunk On-Call Support to explore what alternative options may be available. For details on how to contact Splunk On-Call Support, see :ref:`spoc-support`.
 
-
-
-
-Administrator Setup
-==========================
+.. raw:: html
+   
+  <embed>
+    <h2>Configure SSO: Admin guides<a name="admin-setup" class="headerlink" href="#admin-setup" title="Permalink to this headline">¶</a></h2>
+  </embed>
 
 Instructions to complete the SSO configuration with Splunk On-Call and your IDP are provided for:
 
@@ -46,51 +48,10 @@ Instructions to complete the SSO configuration with Splunk On-Call and your IDP
 - :ref:`sso-azure-spoc`
 - :ref:`sso-aws-spoc`
 
+.. raw:: html
+   
+  <embed>
+    <h2>Sign in to Splunk On-Call through SSO: User guide<a name="user-guide" class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h2>
+  </embed>
 
-
-.. _sso-onelogin-spoc:
-
-
-OneLogin
--------------
-
-If you are configuring SSO for OneLogin, the Default relay state is:
-
-   https://portal.victorops.com/auth/sso/<<org-slug-here>>
-
-
-.. _sso-azure-spoc:
-
-
-Azure Active Directory (SAML-based Sign-on)
--------------------------------------------------------
-
-If you are configuring SSO for Azure Active Directory, use the following values:
-
--  Identifier: :samp:`https://victorops.com`
--  Reply URL: :samp:`https://sso.victorops.com/sp/ACS.saml2`
--  Sign on URL: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>`
--  Relay State: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>`
-
-
-.. _sso-aws-spoc:
-
-AWS IAM Identity Center - SAML
--------------------------------------------------------
-
-If you are configuring SSO for AWS IAM Identity Center:
-
-
-#. In the IAM Identity Center console find the :guilabel:`Applications` tab.
-#.  Select :guilabel:`Add Application` and look for VictorOps.
-#.  In the configuration settings ensure you set the fields as follows:
-
-   -  Important: Ensure the Session Duration is set to 1hour.
-
-.. image:: /_images/spoc/sso-aws1.png
-    :width: 100%
-    :alt: Application properties page.
-
-.. image:: /_images/spoc/sso-aws2.png
-    :width: 100%
-    :alt: Application metadata page.
+See :ref:`sp-sso-users`.

sp-oncall/admin/sso/sp-sso-google.rst

@@ -1,44 +1,12 @@
-.. _single-sign-sso-google:
+.. _sso-google-spoc:
 
 ************************************************************************
-Configure Single Sign-On for Splunk On-Call
+Configure Single Sign-On for Splunk On-Call using Google Apps
 ************************************************************************
 
 .. meta::
    :description: Enable Splunk On-Call SSO for your organization. 
 
-Requirements
-==================
-
-This integration is compatible with the following versions of Splunk On-Call:
-
-- Full-Stack
-
-To enable single sign-on (SSO) for your organization, you will need to provide an updated metadata file and your IDP. If you are interested in setting up SSO, please contact :ref:`Splunk On-Call Support <spoc-support>`.
-
-
-
-Configure Single Sign On between your Identity Provider (IDP) and  Splunk On-Call. Our standard SSO setup uses SAML 2.0 protocol. As long as your IDP can use SAML 2.0 protocol, it can integrate with Splunk On-Call. The exact steps differ depending on which IDP you use, but the process typically involves exporting a .XML metadata file and sending it to our Support team. Once you have sent the .xml file, a Splunk On-Call support specialist will
-complete the setup on the back-end and respond with confirmation.
-
-If your IDP does not have SAML capability, please contact Splunk On-Call Support to explore what alternative options may be available. For details on how to contact Splunk On-Call Support, see :ref:`spoc-support`.
-
-
-Administrator Setup
-==========================
-
-Instructions to complete the SSO configuration with Splunk On-Call and your IDP are provided for:
-
-- :ref:`sso-okta-spoc`
-- :ref:`sso-google-spoc`
-- 
-
-
-.. _sso-google-spoc:
-
-Google Apps
-================
-
 To configure SSO for Splunk On-Call using Google Apps:
 
 #. Access the Admin portal for Google Apps and navigate to :guilabel:`Apps` then :guilabel:`SAML Apps`.
@@ -53,7 +21,7 @@ To configure SSO for Splunk On-Call using Google Apps:
        :width: 100%
        :alt: Splunk On-Call SSO Google Apps Setup 2
 
-#. From Step 2 of the wizard, select :guilabel:`Option 2` to download IDP metadata in XML format. Attach and send the downloaded .xml file to :ref:`Splunk On-Call Support <spoc-support>`.
+#. From step 2 of the guided setup, select :guilabel:`Option 2` to download IDP metadata in XML format. Attach and send the downloaded .xml file to :ref:`Splunk On-Call Support <spoc-support>`.
 
    .. image:: /_images/spoc/sso-google3.png
        :width: 100%
@@ -67,11 +35,8 @@ To configure SSO for Splunk On-Call using Google Apps:
        :alt: Splunk On-Call SSO Google Apps Setup 5
 
 #. In the :guilabel:`Service Provider Details` step, enter the following values:
-   - in the :guilabel:`ACS URL` field: :samp:`https://sso.victorops.com:443/sp/ACS.saml2`
-   - in the :guilabel:`Entity ID` field: :samp:`victorops.com`
-   - in the :guilabel:`Start URL` field, enter the following with the correct Organization Slug at the end: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>.`
-
-
-#. Skip the attribute mapping step and select :guilabel:`Finish`.
-
+   - In the :guilabel:`ACS URL` field: :samp:`https://sso.victorops.com:443/sp/ACS.saml2`
+   - In the :guilabel:`Entity ID` field: :samp:`victorops.com`
+   - In the :guilabel:`Start URL` field, enter the following with the correct Organization Slug at the end: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>.`
 
+#. Skip the attribute mapping step and select :guilabel:`Finish`.