Skip to content

Commit 83eee45

Browse files
committed
add upstream content and parent about page
fix links correct links
1 parent 7ca4cd0 commit 83eee45

11 files changed

Lines changed: 49 additions & 42 deletions

File tree

docs/config/_default/menus/menus.en.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
[[main]]
2222
name = "Connections"
23-
url = "/connections/about_connections/"
23+
url = "/connections/about/"
2424
weight = 13
2525

2626
[[main]]
@@ -35,7 +35,7 @@
3535

3636
[[main]]
3737
name = "Issue Tracking"
38-
url = "/connections/downstream/downstream_connections/"
38+
url = "/connections/downstream/about/"
3939
weight = 15
4040

4141
[[main]]

docs/content/asset_modelling/PRO_hierarchy/assets_organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Core Application [Organization]
8282
└── nginx
8383
```
8484

85-
In this diagram, every element under "Core Application" could be recorded as a separate Asset, with unique business criticality (see: [Priority & Risk](/asset_modelling/pro_hierarchy/priority_sla/#prioritization-engines/)), RBAC, and corresponding Engagements and Tests. You could continue to test, and store results, on the parent Asset (for example, `webapp-backend`), but you could also run isolated testing on a particular child Asset (for example, `database`).
85+
In this diagram, every element under "Core Application" could be recorded as a separate Asset, with unique business criticality (see: [Priority & Risk](/asset_modelling/pro_hierarchy/priority_sla/#prioritization-engines)), RBAC, and corresponding Engagements and Tests. You could continue to test, and store results, on the parent Asset (for example, `webapp-backend`), but you could also run isolated testing on a particular child Asset (for example, `database`).
8686

8787
### Pen Tests: Isolated RBAC
8888

docs/content/connections/about_connections.md renamed to docs/content/connections/about.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ On the **Downstream Connections** page:
6060

6161
## Next Steps
6262

63-
* Read [About Connectors](/import_data/pro/connectors/about_connectors/) and [add your first Upstream Connection](/import_data/pro/connectors/add_edit_connectors/) to start importing findings automatically.
64-
* Read the [Downstream Connections guide](/connections/downstream/downstream_connections/) to push findings to your issue trackers.
63+
* Read [About Upstream Connections](/connections/upstream/about/) and [add your first Upstream Connection](/connections/upstream/add_edit/) to start importing findings automatically.
64+
* Read the [Downstream Connections guide](/connections/downstream/about/) to push findings to your issue trackers.

docs/content/connections/downstream/about.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,16 @@ Each vendor will have varying requirements for how DefectDojo will need to inter
7575

7676
For the complete list of requirements, please open the vendor specific pages below:
7777

78-
- [Azure Devops](/connections/downstream/downstream_connections_toolreference/#azure-devops-boards)
79-
- [Bitbucket](/connections/downstream/downstream_connections_toolreference/#bitbucket)
80-
- [Freshservice](/connections/downstream/downstream_connections_toolreference/#freshservice)
81-
- [GitHub](/connections/downstream/downstream_connections_toolreference/#github)
82-
- [GitLab Boards](/connections/downstream/downstream_connections_toolreference/#gitlab)
83-
- [Jira](/connections/downstream/downstream_connections_toolreference/#jira)
84-
- [ServiceDesk Plus](/connections/downstream/downstream_connections_toolreference/#servicedesk-plus)
85-
- [ServiceNow](/connections/downstream/downstream_connections_toolreference/#servicenow)
86-
- [Shortcut](/connections/downstream/downstream_connections_toolreference/#shortcut)
87-
- [Zendesk](/connections/downstream/downstream_connections_toolreference/#zendesk)
78+
- [Azure Devops](/connections/downstream/downstream_toolreference/#azure-devops-boards)
79+
- [Bitbucket](/connections/downstream/downstream_toolreference/#bitbucket)
80+
- [Freshservice](/connections/downstream/downstream_toolreference/#freshservice)
81+
- [GitHub](/connections/downstream/downstream_toolreference/#github)
82+
- [GitLab Boards](/connections/downstream/downstream_toolreference/#gitlab)
83+
- [Jira](/connections/downstream/downstream_toolreference/#jira)
84+
- [ServiceDesk Plus](/connections/downstream/downstream_toolreference/#servicedesk-plus)
85+
- [ServiceNow](/connections/downstream/downstream_toolreference/#servicenow)
86+
- [Shortcut](/connections/downstream/downstream_toolreference/#shortcut)
87+
- [Zendesk](/connections/downstream/downstream_toolreference/#zendesk)
8888

8989
## Error Handling and Debugging
9090

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: "Connectors"
2+
title: "Upstream Connections"
33
description: "Seamlessly connect DefectDojo to your security tools suite"
44
summary: ""
55
date: 2023-09-07T16:06:50+02:00
66
lastmod: 2023-09-07T16:06:50+02:00
77
draft: false
8-
weight: 4
8+
weight: 2
99
chapter: true
1010
seo:
1111
title: "" # custom title (optional)
@@ -14,4 +14,6 @@ seo:
1414
robots: "" # custom robot tags (optional)
1515
audience: pro
1616
exclude_search: true
17+
aliases:
18+
- /import_data/pro/connectors/
1719
---

docs/content/import_data/pro/connectors/about_connectors.md renamed to docs/content/connections/upstream/about.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "About Connectors"
2+
title: "Upstream Connections"
33
description: "Seamlessly connect DefectDojo to your security tools suite"
44
summary: ""
55
date: 2023-09-07T16:06:50+02:00
@@ -16,15 +16,16 @@ seo:
1616
robots: "" # custom robot tags (optional)
1717
pro-feature: true
1818
aliases:
19+
- /import_data/pro/connectors/about_connectors/
1920
- /en/connecting_your_tools/connectors/about_connectors
2021
---
21-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Connectors are a DefectDojo Pro-only feature.</span>
22+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Upstream Connections are a DefectDojo Pro-only feature.</span>
2223

2324
DefectDojo allows users to build sophisticated API integrations, and gives users full control over how their vulnerability data is organized.
2425

25-
But everyone needs a starting point, and that's where Connectors come in. Connectors are designed to get your security tools connected and importing data to DefectDojo as quickly as possible.
26+
But everyone needs a starting point, and that's where Upstream Connections come in. Upstream Connections (formerly known as **API Connectors**) are designed to get your security tools connected and importing data to DefectDojo as quickly as possible.
2627

27-
We currently support Connectors for the following tools, with more on the way:
28+
We currently support Upstream Connections for the following tools, with more on the way:
2829

2930
* **Akamai API Security**
3031
* **Anchore**
@@ -43,19 +44,19 @@ We currently support Connectors for the following tools, with more on the way:
4344
* **Tenable**
4445
* **Wiz**
4546

46-
These Connectors provide an API\-speed integration with DefectDojo, and can be used to automatically ingest and organize vulnerability data from the tool.
47+
These connections provide an API\-speed integration with DefectDojo, and can be used to automatically ingest and organize vulnerability data from the tool.
4748

48-
## Connectors Quick\-Start
49+
## Upstream Connections Quick\-Start
4950

5051
If you're using DefectDojo's **Auto\-Map** settings, you can have your first Connector up and running in no time.
5152

52-
1. Set up a [Connector](../add_edit_connectors/) from a supported tool.
53+
1. Set up a [Connector](../add_edit/) from a supported tool.
5354
2. [Discover](../manage_operations/#discover-operations) your tool's data hierarchy.
5455
3. [Sync](../manage_operations/#sync-operations) the vulnerabilities found with your tool into DefectDojo.
5556

5657
That's all, really! And remember, even if you create your Connector the 'easy' way, you can easily change the way things are set up later, without losing any of your work.
5758

58-
## How Connectors Work
59+
## How Upstream Connections Work
5960

6061
As long as you have the API key from the tool you're trying to connect, a connector can be added in just a few minutes. Once the connection is working, DefectDojo will **Discover** your tool's environment to see how you're organizing your scan data.
6162

@@ -73,6 +74,6 @@ Fortunately, DefectDojo can still handle manual import for a wide range of secur
7374

7475
# **Next Steps**
7576

76-
* Check out the Connectors page by switching to DefectDojo's **Pro UI**.
77-
* Follow our guide to [create your first Connector](../add_edit_connectors/).
77+
* Check out the **Upstream Connections** page by switching to DefectDojo's **Pro UI** and opening **Connections \> Upstream Connections** under the **Import** header.
78+
* Follow our guide to [create your first Connector](../add_edit/).
7879
* Check out the process of [Running Operations](../manage_operations/) with your Connected security tools and see how they can be configured to import data.

docs/content/import_data/pro/connectors/add_edit_connectors.md renamed to docs/content/connections/upstream/add_edit.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,32 @@
11
---
2-
title: "Add or Edit a Connector"
2+
title: "Add or Edit Upstream Connections"
33
description: "Connect to a supported security tool"
44
aliases:
5+
- /import_data/pro/connectors/add_edit_connectors/
56
- /en/connecting_your_tools/connectors/add_edit_connectors
67
---
7-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Connectors are a DefectDojo Pro-only feature.</span>
8+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Upstream Connections are a DefectDojo Pro-only feature.</span>
89

9-
The process for adding and configuring a connector is similar, regardless of the tool you’re trying to connect. However, certain tools may require you to create API keys or complete additional steps.
10+
The process for adding and configuring an Upstream Connection is similar, regardless of the tool you’re trying to connect. However, certain tools may require you to create API keys or complete additional steps.
1011

11-
Before you begin this process, we recommend checking our [Tool-Specific Reference](../connectors_tool_reference/) to find the API resources for the tool you're trying to connect.
12+
Before you begin this process, we recommend checking our [Tool-Specific Reference](../toolreference/) to find the API resources for the tool you're trying to connect.
1213

1314
1. If you haven't already, start by **switching to the Pro UI** in DefectDojo.
14-
2. From the left\-side menu, click on the **API Connectors** menu item. This is nested under the **Import** header.
15+
2. From the left\-side menu, open the **Connections** group nested under the **Import** header, and click **Upstream Connections**.
1516
1617
![image](images/add_edit_connectors.png)
1718

18-
3. Choose a new Connector you want to add to DefectDojo in **Available Connections**, and click the **Add Configuration** underneath the tool.
19+
3. Choose a new Connector you want to add to DefectDojo in **Available Connections**, and click the **Add Configuration** button on the tool's tile. You can use the **Search Connections** box to filter each section by tool name, or the **All / Asset / Finding** toggle in the page header to filter by connector type.
1920
2021
You can also edit an existing Connection under the **Configured Connections** header. Click **Manage Configuration \> Edit Configuration** for the Configured Connection you want to Edit.
2122
2223
![image](images/add_edit_connectors_2.png)
2324

24-
4. You will need an accessible URL **Location** for the tool, along with an API **Secret** key. The location of the API key will depend on the tool you are trying to configure. See our [Tool\-Specific Reference](../connectors_tool_reference/) for more details.
25+
4. You will need an accessible **Location URL** for the tool, along with an API **Secret** key. The location of the API key will depend on the tool you are trying to configure. See our [Tool\-Specific Reference](../toolreference/) for more details.
2526
2627
5. Set a **Label** for this connection to help you identify it in DefectDojo.
2728
28-
6. Schedule the **Connector’s** automatic Discovery and Synchronization activities. These can be changed later.
29+
6. Schedule the Connector's automatic discovery and sync using the **Discovery Configuration** and **Synchronization Configuration** schedules. These can be changed later.
2930
3031
7. Select whether you wish to **Enable Auto\-Mapping**. Enable Auto\-Mapping will create a new Product in DefectDojo to store the data from this connector. Auto\-Mapping can be turned on or off at any time.
3132

docs/content/import_data/pro/connectors/manage_operations.md renamed to docs/content/connections/upstream/manage_operations.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
title: "Managing Operations"
33
description: "Check the status of your Connector's Discover & Sync Operations"
44
aliases:
5+
- /import_data/pro/connectors/manage_operations/
56
- /en/connecting_your_tools/connectors/manage_operations
67
---
7-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Connectors are a DefectDojo Pro-only feature.</span>
8+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Upstream Connections are a DefectDojo Pro-only feature.</span>
89

9-
Once an API connector is set up, it will run two Operations on a recurring basis:
10+
Once an Upstream Connection is set up, it will run two Operations on a recurring basis:
1011

1112
* **Discover** will learn the connected tool's structure, and will create records in DefectDojo of any unmapped data;
1213
* **Sync** will import new Findings from the tool based on your mappings.
@@ -73,7 +74,7 @@ To learn more about Products, Engagements, Tests and Findings, see our [Product
7374

7475
To have DefectDojo run a Sync operation off\-schedule:
7576

76-
1. Navigate to the **Manage Records \& Operations** page for the connector you want to use. From the **API Connectors** page, click the drop\-down menu on the Connector you wish to work with, and select Manage Records \& Operations.
77+
1. Navigate to the **Manage Records \& Operations** page for the connector you want to use. From the **Upstream Connections** page, click the **Manage Configuration** drop\-down menu on the Connector you wish to work with, and select **Manage Records \& Operations**.
7778
7879
2. From this page, click the **Sync** button. This button is located next to the **Mapped Records** header.
7980

docs/content/import_data/pro/connectors/manage_records.md renamed to docs/content/connections/upstream/manage_records.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
title: "Managing Records"
33
description: "Direct the flow of data from your tool into DefectDojo"
44
aliases:
5+
- /import_data/pro/connectors/manage_records/
56
- /en/connecting_your_tools/connectors/manage_records
67
---
7-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Connectors are a DefectDojo Pro-only feature.</span>
8+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Upstream Connections are a DefectDojo Pro-only feature.</span>
89

910
Once you have run your first Discover operation, you should see a list of Mapped or Unmapped records on the **Manage Records and Operations** page.
1011

docs/content/import_data/pro/connectors/connectors_tool_reference.md renamed to docs/content/connections/upstream/toolreference.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: "Tool-Specific Connector Setup"
2+
title: "Upstream Connections Tool Reference"
33
description: "Our list of supported Connector tools, and how to set them up with DefectDojo"
44
aliases:
5+
- /import_data/pro/connectors/connectors_tool_reference/
56
- /en/connecting_your_tools/connectors/connectors_tool_reference
67
---
7-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Connectors are a DefectDojo Pro-only feature.</span>
8+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: Upstream Connections are a DefectDojo Pro-only feature.</span>
89

910
When setting up a Connector for a supported tool, you'll need to give DefectDojo specific information related to the tool's API. At a base level, you'll need:
1011

0 commit comments

Comments
 (0)