GITBOOK-9140: Broker: move Essentials and AppRisk to common pp, both work with Classic and UB

Author: awileysnyk

docs/SUMMARY.md

@@ -101,9 +101,8 @@
       * [Restart your Broker for a new environment variable](enterprise-setup/snyk-broker/universal-broker/restart-your-broker-for-a-new-environment-variable.md)
       * [Disconnect and clean up](enterprise-setup/snyk-broker/universal-broker/disconnect-and-clean-up.md)
       * [Using the API to set up Univeral Broker](enterprise-setup/snyk-broker/universal-broker/using-the-api-to-set-up-univeral-broker/README.md)
-        * [Using the API to set up a GitHub connection ](enterprise-setup/snyk-broker/universal-broker/using-the-api-to-set-up-univeral-broker/using-the-api-to-set-up-a-github-connection.md)
+        * [Using the API to set up a GitHub connection](enterprise-setup/snyk-broker/universal-broker/using-the-api-to-set-up-univeral-broker/using-the-api-to-set-up-a-github-connection.md)
         * [Universal Broker workflow diagrams](enterprise-setup/snyk-broker/universal-broker/using-the-api-to-set-up-univeral-broker/universal-broker-workflow-diagrams.md)
-      * [Snyk Broker - AppRisk](enterprise-setup/snyk-broker/universal-broker/snyk-broker-apprisk.md)
       * [Upgrade an Organization integration from Classic Broker to Universal Broker](enterprise-setup/snyk-broker/universal-broker/upgrade-an-organization-integration-from-classic-broker-to-universal-broker.md)
     * [Classic Broker](enterprise-setup/snyk-broker/classic-broker/README.md)
       * [Prepare Snyk Broker for deployment](enterprise-setup/snyk-broker/classic-broker/prepare-snyk-broker-for-deployment/README.md)
@@ -170,13 +169,14 @@
           * [Insecure Downstream Mode](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-helm-chart-installation/insecure-downstream-mode.md)
       * [Clone an integration across your Snyk Organizations](enterprise-setup/snyk-broker/classic-broker/clone-an-integration-across-your-snyk-organizations.md)
       * [Snyk Broker - Infrastructure as Code detection](enterprise-setup/snyk-broker/classic-broker/snyk-broker-infrastructure-as-code-detection.md)
-      * [Snyk Broker - Essentials](enterprise-setup/snyk-broker/classic-broker/snyk-broker-essentials.md)
     * [Broker inbound and outbound connections and allowed requests](enterprise-setup/snyk-broker/broker-inbound-and-outbound-connections-and-allowed-requests.md)
     * [Snyk Broker - Container Registry Agent](enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/README.md)
       * [Setting up the Container Registry Agent for a brokered ECR integration](enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/setting-up-the-container-registry-agent-for-a-brokered-ecr-integration.md)
       * [Install Broker for Container Registry Agent using Helm](enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/install-broker-for-container-registry-agent-using-helm.md)
       * [Container Registry Agent advanced configuration using Docker](enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/container-registry-agent-advanced-configuration-using-docker.md)
       * [Integrate with self-hosted container registries](enterprise-setup/snyk-broker/snyk-broker-container-registry-agent/integrate-with-self-hosted-container-registries-broker.md)
+    * [Snyk Broker - Essentials](enterprise-setup/snyk-broker/snyk-broker-essentials.md)
+    * [Snyk Broker - AppRisk](enterprise-setup/snyk-broker/snyk-broker-apprisk.md)
     * [High availability mode](enterprise-setup/snyk-broker/high-availability-mode.md)
     * [Snyk Broker - commit signing](enterprise-setup/snyk-broker/snyk-broker-commit-signing.md)
     * [Verifying Broker image signatures](enterprise-setup/snyk-broker/verifying-broker-image-signatures.md)

docs/enterprise-setup/snyk-broker/classic-broker/README.md

@@ -8,5 +8,5 @@ This section provides information about the classic Snyk Broker:
 * [Clone an ntegration across your Snyk Organizations](clone-an-integration-across-your-snyk-organizations.md)
 * [Snyk Broker - Container Registry Agent](../snyk-broker-container-registry-agent/)
 * [Snyk Broker - Infrastructure as Code detection](snyk-broker-infrastructure-as-code-detection.md)
-* [Snyk Broker - Essentials](snyk-broker-essentials.md)
-* [Snyk Broker - AppRisk](../universal-broker/snyk-broker-apprisk.md)
+* [Snyk Broker - Essentials](../snyk-broker-essentials.md)
+* [Snyk Broker - AppRisk](../snyk-broker-apprisk.md)

docs/enterprise-setup/snyk-broker/classic-broker/snyk-broker-essentials.md

@@ -13,15 +13,15 @@ The third-party integrations are available only for Snyk AppRisk, with Enterpris
 Follow these steps to install and run Snyk Broker for the Snyk AppRisk third-party integrations.
 
 1. Ensure you have the Snyk Broker token for the Snyk AppRisk integration. The Snyk support team can provide the needed token. 
-   * Generate your Broker token by following the instructions from the [Obtain your Broker token for Snyk Broker ](../classic-broker/prepare-snyk-broker-for-deployment/obtain-the-tokens-required-to-set-up-snyk-broker.md#obtain-your-broker-token-from-the-web-ui)page. 
+   * Generate your Broker token by following the instructions from the [Obtain your Broker token for Snyk Broker ](classic-broker/prepare-snyk-broker-for-deployment/obtain-the-tokens-required-to-set-up-snyk-broker.md#obtain-your-broker-token-from-the-web-ui)page. 
    * Copy and paste the Broker token on the integration setup menu from the Integration Hub.
 2. Pull the latest Broker image by running this command:
 
 ```docker
 docker pull snyk/broker:universal
 ```
 
-3. Configure your Snyk AppRisk connection type using the `snyk-broker-config` command, as explained on the page [Basic steps to install and configure Universal Broker](basic-steps-to-install-and-configure-universal-broker.md).
+3. Configure your Snyk AppRisk connection type using the `snyk-broker-config` command, as explained on the page [Basic steps to install and configure Universal Broker](universal-broker/basic-steps-to-install-and-configure-universal-broker.md).
 
 ## Checkmarx SAST integration
 

docs/enterprise-setup/snyk-broker/universal-broker/snyk-broker-apprisk.md renamed to docs/enterprise-setup/snyk-broker/snyk-broker-apprisk.md

@@ -0,0 +1,42 @@
+# Snyk Broker - Essentials
+
+## Prerequisites
+
+If your SCM instance is not publicly accessible, you need Snyk Broker. You can install and configure Snyk Broker using Docker or Helm. The minimum supported Broker version for Snyk Essentials is [4.171.0](https://github.com/snyk/broker/releases/tag/v4.171.0).
+
+Ensure you have the Snyk Broker token for the Snyk Essentials integration. The Snyk support team can provide the needed token, or you can generate it yourself by following these instructions:
+
+* Generate your Broker token by following the instructions from the [Obtain your Broker token for Snyk Broker ](classic-broker/prepare-snyk-broker-for-deployment/obtain-the-tokens-required-to-set-up-snyk-broker.md#obtain-your-broker-token-from-the-web-ui)page. 
+* Copy and paste the Broker token on the integration setup menu from the Integration Hub.
+
+## SCM integrations
+
+* GitHub - install and configure Snyk Broker 
+  * [using Docker](classic-broker/install-and-configure-snyk-broker/github-prerequisites-and-steps-to-install-and-configure-broker/github-install-and-configure-using-docker.md#docker-run-command-to-set-up-a-broker-client-for-github)
+  * [using Helm](classic-broker/install-and-configure-snyk-broker/github-prerequisites-and-steps-to-install-and-configure-broker/github-install-and-configure-using-helm.md)
+  * [environment variables](classic-broker/install-and-configure-snyk-broker/github-prerequisites-and-steps-to-install-and-configure-broker/github-environment-variables-for-snyk-broker.md)
+* GitHub Enterprise - install and configure Snyk Broker:
+  * [using Docker](classic-broker/install-and-configure-snyk-broker/github-enterprise-prerequisites-and-steps-to-install-and-configure-broker/github-enterprise-install-and-configure-using-docker.md#docker-run-command-to-set-up-a-broker-client-for-github-enterprise)
+  * [using Helm](classic-broker/install-and-configure-snyk-broker/github-enterprise-prerequisites-and-steps-to-install-and-configure-broker/github-enterprise-install-and-configure-using-helm.md)
+  * [environment variables](classic-broker/install-and-configure-snyk-broker/github-enterprise-prerequisites-and-steps-to-install-and-configure-broker/github-enterprise-environment-variables-for-snyk-broker.md)
+* BitBucket - install and configure Snyk Broker:
+  * [using Docker](classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/data-center.md#docker-run-command-to-set-up-a-broker-client-for-bitbucket)
+  * [using Helm](classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/bitbucket-server-data-center-install-and-configure-using-helm.md)
+  * [environment variables](classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/bitbucket-server-data-center-environment-variables-for-snyk-broker-basic-auth.md)
+* GitLab - install and configure Snyk Broker:
+  * [using Docker](classic-broker/install-and-configure-snyk-broker/gitlab-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-gitlab.md#docker-run-command-to-set-up-a-broker-client-for-gitlab)
+  * [using Helm](classic-broker/install-and-configure-snyk-broker/gitlab-prerequisites-and-steps-to-install-and-configure-broker/gitlab-install-and-configure-using-helm.md)
+  * [environment variables](classic-broker/install-and-configure-snyk-broker/gitlab-prerequisites-and-steps-to-install-and-configure-broker/gitlab-environment-variables-for-snyk-broker.md)
+* Azure - install and configure Snyk Broker:
+  * [using Docker](classic-broker/install-and-configure-snyk-broker/azure-repos-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-azure-repos.md#docker-run-command-to-set-up-a-broker-client-for-azure-repos)
+  * [using Helm](classic-broker/install-and-configure-snyk-broker/azure-repos-prerequisites-and-steps-to-install-and-configure-broker/azure-repos-install-and-configure-and-configure-using-helm.md)
+  * [environment variables](classic-broker/install-and-configure-snyk-broker/azure-repos-prerequisites-and-steps-to-install-and-configure-broker/azure-repos-environment-variables-for-snyk-broker.md)
+
+You can find on [GitHub](https://github.com/snyk/broker/tree/565242baf003f06f445489dd96cc68c8386ede38/defaultFilters/apprisk) all the updated `.json` files that include the allowed list of accessible endpoints for the integrations.
+
+As the final step following a completed Broker setup, for any brokered integration you want to add to Snyk Essentials, you must obtain the Broker token. You can find the Broker token in your Organization integration general settings for your integration type, for example, GitHub, GitLab, and so on, as shown in the following image. For third-party integrations, see the next section.
+
+<figure><img src="../../.gitbook/assets/Screenshot 2024-11-01 at 1.05.55 PM.png" alt="&#x22;&#x22;"><figcaption><p>Broker token in GitLab integration general settings</p></figcaption></figure>
+
+
+

docs/enterprise-setup/snyk-broker/snyk-broker-essentials.md

@@ -76,7 +76,7 @@ If you answered Yes to any of the above questions, then you need to deploy a new
 Snyk recommends creating a new Organization in Snyk specifically for the Snyk Essentials Broker.
 {% endhint %}
 
-Navigate to the [Snyk Broker](../../../enterprise-setup/snyk-broker/classic-broker/snyk-broker-essentials.md) page for more details about installing and configuring Snyk Essentials using Snyk Broker.
+Navigate to the [Snyk Broker](../../../enterprise-setup/snyk-broker/snyk-broker-essentials.md) page for more details about installing and configuring Snyk Essentials using Snyk Broker.
 
 ### Application context for SCM Integrations
 

docs/implement-snyk/enterprise-implementation-guide/phase-2-configure-account/configure-asset-management-with-snyk-essentials.md

@@ -36,7 +36,7 @@ Navigate to the [Snyk SCM Integrations](../../../scm-ide-and-ci-cd-integrations/
 
 ### Brokered SCM integration <a href="#brokered-scm-integration" id="brokered-scm-integration"></a>
 
-Navigate to the [Snyk Broker - SCM integrations](../../../enterprise-setup/snyk-broker/classic-broker/snyk-broker-essentials.md#scm-integrations) page for more details about installing and configuring Snyk AppRisk using Snyk Broker.
+Navigate to the [Snyk Broker - SCM integrations](../../../enterprise-setup/snyk-broker/snyk-broker-essentials.md#scm-integrations) page for more details about installing and configuring Snyk AppRisk using Snyk Broker.
 
 ### Third-party integrations
 

docs/implement-snyk/enterprise-implementation-guide/phase-2-configure-account/configure-snyk-apprisk-integrations.md

@@ -83,7 +83,7 @@ After the integration is validated, a card is displayed on the Integrations page
 
 ### Using Snyk Broker
 
-If your SCM instance is not publicly accessible, you need Snyk Broker. You can install and configure your Snyk Broker using Docker or Helm. For more information about Snyk Broker, see the Snyk Broker documentation, including [Snyk Broker](../enterprise-setup/snyk-broker/classic-broker/snyk-broker-essentials.md).
+If your SCM instance is not publicly accessible, you need Snyk Broker. You can install and configure your Snyk Broker using Docker or Helm. For more information about Snyk Broker, see the Snyk Broker documentation, including [Snyk Broker](../enterprise-setup/snyk-broker/snyk-broker-essentials.md).
 
 {% hint style="info" %}
 Enable the Snyk Essentials flag in your Snyk Broker deployment environment before running the commands.

docs/integrate-with-snyk/README.md

@@ -79,7 +79,7 @@ Snyk AppRisk does not support the Checkmarx One integration.
 
 ### Prerequisites <a href="#checkmarx-prerequisites" id="checkmarx-prerequisites"></a>
 
-* Install and configure your [Snyk Broker](../../../enterprise-setup/snyk-broker/classic-broker/snyk-broker-essentials.md#checkmarx-sast-integration) connection for Snyk AppRisk.&#x20;
+* Install and configure your [Snyk Broker](../../../enterprise-setup/snyk-broker/snyk-broker-essentials.md#checkmarx-sast-integration) connection for Snyk AppRisk.&#x20;
 * Ensure you have properly used Git Setting for your Checkmarx Project. Access the Checkmarx [Set project's remote source settings as GIT](https://checkmarx.stoplight.io/docs/checkmarx-sast-api-reference-guide/8312d35369b9b-set-project-s-remote-source-settings-as-git) documentation page for more details.&#x20;
 
 ### Required parameters <a href="#checkmarx-required-parameters" id="checkmarx-required-parameters"></a>