Deprecated doc (#398)

* deprecated integrations doc * tech review fixes * change to python 3.8 * python 3.8 * ignore test_data dir for pytest * use python 3.8 * gen deprecated doc * fix pool to work with macos python 3.8 * fix mypy * pipfile lock * mypy comment * more logic for deprecated doc * detect blame * use doc_files in example so relative paths are maintained * deprecated docs * add support for static deprecated info * updsate secdo and magnifier * update pytest. fix mypy * flake8 fix * fix json in assets. fix phishme note * support "no available replacement" test * Update content-repo/extra-docs/articles/deprecated_info.json Co-authored-by: Itay Keren <[email protected]> * Update content-repo/extra-docs/articles/deprecated_info.json Co-authored-by: Itay Keren <[email protected]> * Update content-repo/extra-docs/articles/deprecated.md Co-authored-by: Itay Keren <[email protected]> * mypy error code * lint * add eol minemeld Co-authored-by: Itay Keren <[email protected]>
demisto · Jan 13, 2021 · 59b12c1 · 59b12c1
1 parent 8ae7585
commit 59b12c1
Show file tree

Hide file tree

Showing 33 changed files with 12,996 additions and 173 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -66,7 +66,7 @@ jobs:
 
   deploy:
     docker:
-      - image: circleci/python:3.7.9-buster-node
+      - image: circleci/python:3.8.3-buster-node
     resource_class: small
     steps:
       - checkout

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -35,7 +35,7 @@ jobs:
     - run: npm install
     - uses: actions/setup-python@v1
       with:
-        python-version: '3.7'
+        python-version: '3.8'
     - name: Setup pipenv
       run: |
         pip install pipenv

diff --git a/.gitignore b/.gitignore
@@ -35,3 +35,4 @@ docs/reference
 content-repo/extra-docs/articles/demisto-class.md
 .pytest_cache
 docs/doc_imgs/reference/relative
+static/assets/deprecated*.json
diff --git a/Pipfile b/Pipfile
@@ -20,4 +20,4 @@ pydoc-markdown = "*"
 python-dateutil = "*"
 
 [requires]
-python_version = "3.7"
+python_version = "3.8"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/content-repo/extra-docs/articles/deprecated.md b/content-repo/extra-docs/articles/deprecated.md
@@ -0,0 +1,16 @@
+---
+id: deprecated
+title: Deprecated Integrations
+description: Support dates and End of Life notices for Deprecated Integrations. 
+---
+For various reasons, Integrations reach a deprecated status. In most cases, the reason an Integration is deprecated is that a new version replaces the deprecated Integration. For Cortex XSOAR supported Integrations, the deprecation process involves the Integration entering a **Maintenance Mode** period and finally an **End-Of-Life** declaration. Cortex XSOAR tries to make this process as seamless as possible for our customers and partners while providing visibility into what can be expected during this process.
+
+#### Maintenance Mode
+After an Integration is declared deprecated, it enters a phase of maintenance mode. During this period, support and maintenance are provided for the Integration. This includes bug fixes, maintenance releases, workarounds, and patches for critical bugs (whenever this is technically possible).
+
+New features will not be added to an Integration in **Maintenance Mode**. If there is a replacement or alternative version for the Integration, customers are encouraged during this time period to migrate to the replacement Integration. **Maintenance Mode** will usually be a period of 6 months but that period might be extended as needed. If the Integration is deprecated as a result of a vendor's end-of-life of a product/service/API, the **Maintenance Mode** period might be shorter.
+
+#### End-Of-Life
+After the **Maintenance Mode** period ends, the Integration will be declared **End-Of-Life**. This is the last day that the Integration will be supported by Palo Alto Networks.
+
+**Note**: This article applies to Cortex XSOAR Supported Packs only. Palo Alto Networks is not liable for and does not warrant or support any content pack produced by a third-party Publisher. For more info about Content Packs Support Types see: https://docs.paloaltonetworks.com/cortex/cortex-xsoar/6-0/cortex-xsoar-admin/marketplace/marketplace-overview/content-packs-support-types.html .
diff --git a/content-repo/extra-docs/articles/deprecated_info.json b/content-repo/extra-docs/articles/deprecated_info.json
@@ -0,0 +1,249 @@
+{
+  "$schema": "./deprecated_info.schema.json",
+  "integrations": [
+    {
+      "id": "RSA Archer",
+      "note": "We recommend using RSA Archer v2 instead. To allow adoption and a smooth transition, maintanence mode has been extended to 12 months.",
+      "maintenance_start": "Nov 01, 2020",
+      "eol_start": "Nov 01, 2021"
+    },
+    {
+      "id": "Phishme Intelligence",
+      "note": "Use the Cofense Intelligence integration instead."      
+    },
+    {
+      "id": "Amazon Web Services",
+      "note": "Use the AWS - EC2 integration instead."
+    },
+    {
+      "id": "ArcSight ESM",
+      "note": "Use the ArcSight ESM v2 integration instead."
+    },
+    {
+      "id": "jira",
+      "note": "Use the Atlassian Jira v2 integration instead."
+    },
+    {
+      "id": "Azure Compute",
+      "note": "Use the Azure Compute v2 integration instead."
+    },
+    {
+      "id": "Azure Security Center",
+      "note": "Use the Azure Security Center v2 integration instead."
+    },
+    {
+      "id": "FalconIntel",
+      "note": "Useg the CrowdStrike Falcon Intel v2 integration instead."
+    },
+    {
+      "id": "CVE Search",
+      "note": "Use the CVE Search v2 integration instead."
+    },
+    {
+      "id": "CyberArkAIM",
+      "note": "Use the CyberArk AIM v2 integration instead."
+    },
+    {
+      "id": "Cylance Protect",
+      "note": "Use the Cylance Protect v2 integration instead."
+    },
+    {
+      "id": "Cymon",
+      "note": "Service has been discontinued by the vendor."
+    },
+    {
+      "id": "EWS",
+      "note": "Use the EWS v2 or the EWS O365 integrations instead."
+    },
+    {
+      "id": "Feodo Tracker Hashes Feed",
+      "eol_start": "Dec 01, 2020",
+      "note": "EOL by vendor. Feodo Tracker no longer supports this feed."
+    },
+    {
+      "id": "XFE",
+      "note": "Use the IBM X-Force Exchange v2 integration instead."
+    },
+    {
+      "id": "Intezer",
+      "note": "Use the Intezer v2 integration instead."
+    },
+    {
+      "id": "Kenna",
+      "note": "Use the Kenna v2 integration instead."
+    },
+    {
+      "id": "Lastline",
+      "note": "Use the Lastline v2 integration instead."
+    },
+    {
+      "id": "Lockpath KeyLight",
+      "note": "Use the Lockpath KeyLight v2 integration instead."
+    },
+    {
+      "id": "Mimecast",
+      "note": "Use the Mimecast v2 integration instead."
+    },
+    {
+      "id": "Mimecast Authentication",
+      "note": "Use the Mimecast v2 integration instead."
+    },
+    {
+      "id": "MISP",
+      "note": "Use the MISP v2 integration instead."
+    },
+    {
+      "id": "OPSWAT-Metadefender",
+      "note": "Use the OPSWAT-Metadefender v2 integration instead."
+    },
+    {
+      "id": "LightCyber Magna",
+      "note": "Product has been replaced by Cortex XDR."
+    },
+    {
+      "id": "Palo Alto Minemeld",
+      "eol_start": "Sep 1, 2021",
+      "note": ""
+    },
+    {
+      "id": "WildFire",
+      "note": "Use the Palo Alto Networks WildFire v2 integration instead."
+    },
+    {
+      "id": "Proofpoint TAP",
+      "note": "Use the Proofpoint TAP v2 integration instead."
+    },
+    {
+      "id": "SafeBreach",
+      "note": "Use the SafeBreach v2 integration instead."
+    },
+    {
+      "id": "Secdo",
+      "note": "Product has been replaced by Cortex XDR."
+    },
+    {
+      "id": "ThreatConnect",
+      "note": "Use the ThreatConnect v2 integration instead."
+    },
+    {
+      "id": "activedir",
+      "name": "Active Directory Query",
+      "description": "Query LDAP directory servers",
+      "maintenance_start": "Apr 01, 2019",
+      "eol_start": "Apr 01, 2020",
+      "note": "Use the Active Directory Query v2 integration instead."
+    },
+    {
+      "id": "carbonblackprotection",
+      "name": "Carbon Black Enterprise Protection",
+      "description": "Carbon Black Enterprise Protection is a next-generation endpoint threat prevention solution to deliver a portfolio of protection policies, real-time visibility across environments, and comprehensive compliance rule sets in a single platform.",
+      "maintenance_start": "May 01, 2019",
+      "eol_start": "May 01, 2020",
+      "note": "Use the VMware Carbon Black App Control v2 integration instead."
+    },
+    {
+      "id": "carbonblack",
+      "name": "Carbon Black Enterprise Response",
+      "description": "Query and response with Carbon black endpoint detection and response",
+      "maintenance_start": "May 01, 2019",
+      "eol_start": "May 01, 2020",
+      "note": "Use the VMware Carbon Black EDR integration instead."
+    },
+    {
+      "id": "crowdstrike-streaming-api",
+      "name": "CrowdStrike Falcon Streaming",
+      "description": "Deprecated - We recommend using CrowdStrike Falcon Streaming v2 instead. The Falcon Streaming API (formerly known as the Falcon Firehose API)",
+      "maintenance_start": "May 01, 2020",
+      "eol_start": "May 01, 2021",
+      "note": "Use the CrowdStrike Falcon Streaming v2 integration instead."
+    },
+    {
+      "id": "cylance",
+      "name": "CylanceINFINITY",
+      "description": "File threat intelligence",
+      "maintenance_start": "Jun 01, 2019",
+      "eol_start": "Aug 01, 2020",
+      "note": "This service has been discontinued for external users by Cylance."
+    },
+    {
+      "id": "elasticsearch",
+      "name": "Elasticsearch",
+      "description": "Deprecated. Use the Elasticsearch v2 integration instead. Search & Analyze Data in Real Time",
+      "maintenance_start": "Sep 01, 2019",
+      "eol_start": "Sep 01, 2020",
+      "note": "Use the Elasticsearch v2 integration instead."
+    },
+    {
+      "id": "kafka",
+      "name": "Kafka",
+      "description": "The Open source distributed streaming platform",
+      "maintenance_start": "Oct 01, 2019",
+      "eol_start": "Oct 01, 2020",
+      "note": "Use the Kafka v2 integration instead."
+    },
+    {
+      "id": "mail-sender",
+      "name": "Mail Sender",
+      "description": "Send e-mail notifications to users",
+      "maintenance_start": "Jun 01, 2019",
+      "eol_start": "Jun 01, 2020",
+      "note": "Use the Mail Sender (New) integration instead."
+    },
+    {
+      "id": "esm",
+      "name": "McAfee ESM",
+      "description": "Run queries and receive alarms from Intel Security ESM up to version 9.X. Does NOT support version 10 and above",
+      "maintenance_start": "Sep 01, 2020",
+      "eol_start": "Sep 01, 2021",
+      "note": "Use the McAfee ESM v2 integration instead."
+    },
+    {
+      "id": "mysql",
+      "name": "MySQL",
+      "description": "Deprecated. Use The Generic SQL integration instead.",
+      "maintenance_start": "May 01, 2020",
+      "eol_start": "May 01, 2021",
+      "note": "Use the Generic SQL integration instead."
+    },
+    {
+      "id": "nexpose",
+      "name": "Nexpose",
+      "description": "Receive vulnerability details",
+      "maintenance_start": "Aug 01, 2019",
+      "eol_start": "Aug 01, 2020",
+      "note": "Use the Rapid7 Nexpose integration instead."
+    },
+    {
+      "id": "pagerduty",
+      "name": "PagerDuty",
+      "description": "Alert and notify users using PagerDuty",
+      "maintenance_start": "Feb 01, 2019",
+      "eol_start": "Feb 01, 2020",
+      "note": "Use the PagerDuty v2 integration instead."
+    },
+    {
+      "id": "Autofocus",
+      "name": "Palo Alto AutoFocus",
+      "description": "Deprecated. Use the Palo Alto Networks AutoFocus v2 integration instead. Palo Alto Networks AutoFocus enables you to distinguish the most important threats from everyday commodity attacks.",
+      "maintenance_start": "Jun 01, 2019",
+      "eol_start": "Jun 01, 2020",
+      "note": "Use the Palo Alto Networks AutoFocus v2 integration instead."
+    },
+    {
+      "id": "slack",
+      "name": "Slack",
+      "description": "Deprecated - We recommend using Slack v2 instead. Send messages and notifications to your Slack Team.",
+      "maintenance_start": "Sep 01, 2019",
+      "eol_start": "Sep 01, 2020",
+      "note": "Use the Slack v2 integration instead."
+    },
+    {
+      "id": "mssql",
+      "name": "SQL Server",
+      "description": "Deprecated. Use The Generic SQL integration instead.",
+      "maintenance_start": "May 01, 2020",
+      "eol_start": "May 01, 2021",
+      "note": "Use the Generic SQL integration instead."
+    }
+  ]
+}
diff --git a/content-repo/extra-docs/articles/deprecated_info.schema.json b/content-repo/extra-docs/articles/deprecated_info.schema.json
@@ -0,0 +1,57 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "http://demisto.com/schemas/deprecated_info.schema.json",
+    "type": "object",
+    "properties": {
+        "integrations": {
+            "description": "Array of deprecated integrations",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "description": "Display name of the integration"
+                    },
+                    "id": {
+                        "type": "string",
+                        "description": "ID of the integration"
+                    },
+                    "description": {
+                        "type": "string"
+                    },
+                    "comment": {
+                        "type": "string"
+                    },
+                    "note": {
+                        "type": "string"
+                    },
+                    "maintenance_start": {
+                        "type": "string"
+                    },
+                    "eol_start": {
+                        "type": "string"
+                    }
+                },
+                "defaultSnippets": [
+                    {
+                        "label": "Add Integration",
+                        "description": "Add a deprecated integration",
+                        "body": {
+                            "id": "$1",
+                            "note": "Use the $2 integration instead.",
+                            "maintenance_start": "$3",
+                            "eol_start": "$4"
+                        }
+                    }
+                ],
+                "required": [
+                    "id"                    
+                ]
+            }
+        }
+    },
+    "required": [
+        "integrations"
+    ]
+}