Skip to content

Commit

Permalink
Cases slice 5 (#345)
Browse files Browse the repository at this point in the history 
* overview and setups

* overview and setups - images

* fix image ref

* just pushing this to work on another branch

* document what's there now

* add new images
  • Loading branch information
@misterpantz
misterpantz authored Sep 18, 2024
1 parent 23a6de5 commit e4dde9f
Show file tree
Hide file tree
Showing 32 changed files with 313 additions and 66 deletions.
2 changes: 1 addition & 1 deletion docs/intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The Mondoo unified security platform finds and prioritizes vulnerabilities and m

#### [Compliance](/platform/compliance/overview/)

#### [Track and Fix Findings with Cases and Jira](/platform/cases/overview/)
#### [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/)

#### [Asset Intelligence](/platform/intel/overview/)

Expand Down
38 changes: 28 additions & 10 deletions docs/platform/cases/advisories.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
---
title: Create Cases from Advisories
sidebar_label: Create Cases from Advisories
sidebar_position: 3
description: Cases, which integrate with Atlassian Jira, allow you to track remediation of important security findings. Create a case from an advisory.
sidebar_position: 5
description: Cases, which integrate with your ticket system, allow you to track remediation of important security findings. Create a case from an advisory to track work on that advisory within your existing workflow.
image: /img/featured_img/mondoo-feature.jpg
---

Use cases to track the work of fixing advisories in your existing workflow. When a Mondoo space has the [cases feature configured](/platform/cases/setup/), any team member can create a case from an advisory. Creating a case creates a new a Jira issue directly from the Mondoo Console.
Use cases to track the work of fixing advisories in your existing workflow. When a Mondoo space has the [cases feature configured](/platform/cases/overview/), any team member can create a case from an advisory. Creating a case can:

- Create a new a Jira issue

- Create a new Zendesk ticket

- Send an email message to the recipient of your choice, such as a listener for your ticket, issue tracking, or project management software

For an overview of cases, read [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/).

import Partial from "../partials/_editor-owner.mdx";

Expand All @@ -16,32 +24,42 @@ import Partial from "../partials/_editor-owner.mdx";

2. In the side navigation bar, under **Vulnerabilities**, select **Advisories**.

3. Select the advisory you want to track using a case and a corresponding issue in Jira.
3. Select the advisory you want to track using a case and a corresponding issue in your ticket system.

![Add a case in Mondoo](/img/platform/cases/add-case-advisory.png)

4. To the right of the asset name, select the **CREATE CASE** button and select **Selected Assets** to jump to the bottom of the page and see all assets affected by the advisory.
4. To the right of the advisory name, select the **CREATE CASE** button and select **Selected Assets** to jump to the bottom of the page and see all assets affected by the advisory. (You can also select **All Assets** to create a case for all assets affected by the advisory.)

![Create a new Jira issue in Mondoo](/img/platform/cases/select-asset.png)

5. Check the boxes beside all the assets for which you want to track this advisory. Note that this creates a single case (and therefore a single Jira issue) for all the assets you choose. (If you want to track assets separately, create a new case for each asset.)
5. Check the boxes beside all the assets for which you want to track this advisory. Note that this creates a single case (and therefore a single ticket in your ticket system) for all the assets you choose. (If you want to track assets separately, create a new case for each asset.)

Select the **CREATE CASE** button.

![Create a new case in Mondoo](/img/platform/cases/new-case.png)

6. Select the Jira project in which you want Mondoo to add the issue. Edit the issue name and description as you wish and select the **CREATE CASE** button.
6. In the **Integration** box, select the where you want Mondoo to add or send the case information and provide a specific destination:

- If you select a direct Jira integration, in the **Project** box, select the name of the project where you want to create an issue.

Mondoo creates a new case in the space and a corresponding Jira issue in the project you selected.
- If you select an email integration, in the **Recipient** box, select where to send an email message with the case details.

7. Edit the issue summary as you wish and select the **CREATE CASE** button.

Mondoo creates a new case in the space and then creates a corresponding Jira issue or Zendesk ticket or sends email to the selected recipient.

## Learn more

- [Track and Fix Findings with Cases and Jira](/platform/cases/overview/)
- [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/)

- [Set up Cases and Jira](/platform/cases/setup/)

- [Set up Cases and Zendesk](/platform/cases/setup-zendesk/)

- [Set up Cases to Email Your Ticket System](/platform/cases/setup-email/)

- [Create Cases from Checks](/platform/cases/checks/)

- [View and Close Cases](/platform/cases/manage/)
- [Manage Cases](/platform/cases/manage/)

---
44 changes: 30 additions & 14 deletions docs/platform/cases/checks.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
---
title: Create Cases from Checks
sidebar_label: Create Cases from Checks
sidebar_position: 4
description: Cases, which integrate with Atlassian Jira, allow you to track remediation of important security findings. Create a case from a check.
sidebar_position: 6
description: Cases, which integrate with your ticket system, allow you to track remediation of important security findings. Create a case from a check to track work on that check within your existing workflow.
image: /img/featured_img/mondoo-feature.jpg
---

Use cases to track the work of fixing failed checks in your existing workflow. When a Mondoo space has the [cases feature configured](/platform/cases/setup/), any team member can create a case from a check. Creating a case creates a new a Jira issue directly from the Mondoo Console.
Use cases to track the work of fixing failed checks in your existing workflow. When a Mondoo space has the [cases feature configured](/platform/cases/overview/), any team member can create a case from an advisory. Creating a case can either:

- Create a new a Jira issue

- Create a new Zendesk ticket

- Send an email message to the recipient of your choice, such as a listener for your ticket, issue tracking, or project management software

For an overview of cases, read [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/).

import Partial from "../partials/_editor-owner.mdx";

Expand All @@ -16,34 +24,42 @@ import Partial from "../partials/_editor-owner.mdx";

2. In the side navigation bar, under **Security**, select **Checks**.

![Add a case in Mondoo](/img/platform/cases/checks.png)

3. Select the check you want to track using a case and a corresponding issue in Jira.
3. Select the check you want to track using a case and a corresponding issue in your ticket system.

![Add a case in Mondoo](/img/platform/cases/check-case.png)

4. To the right of the check name, select the **CREATE CASE** button and select **Selected Assets** to jump to the bottom of the page and see all assets failing the check.
4. To the right of the check name, select the **CREATE CASE** button and select **Selected Assets** to jump to the bottom of the page and see all assets affected by the advisory. (You can also select **All Assets** to create a case for all assets affected by the advisory.)

![Create a new Jira issue in Mondoo](/img/platform/cases/select-asset.png)
![Create a new cAW in Mondoo](/img/platform/cases/affected-assets.png)

5. Check the boxes beside all the assets for which you want to track this check. Note that this creates a single case (and therefore a single Jira issue) for all the assets you choose. (If you want to track assets separately, create a new case for each asset.)
5. Check the boxes beside all the assets for which you want to track this advisory. Note that this creates a single case (and therefore a single ticket in your ticket system) for all the assets you choose. (If you want to track assets separately, create a new case for each asset.)

Select the **CREATE CASE** button.

![Create a new case in Mondoo](/img/platform/cases/new-case.png)
![Create a new case in Mondoo](/img/platform/cases/new-case-check.png)

6. Select the Jira project in which you want Mondoo to add the issue. Edit the issue name and description as you wish and select the **CREATE CASE** button.
6. In the **Integration** box, select the where you want Mondoo to add or send the case information and provide a specific destination:

Mondoo creates a new case in the space and a corresponding Jira issue in the project you selected.
- If you select a direct Jira integration, in the **Project** box, select the name of the project where you want to create an issue.

- If you select an email integration, in the **Recipient** box, select where to send an email message with the case details.

7. Edit the issue summary as you wish and select the **CREATE CASE** button.

Mondoo creates a new case in the space and then creates a corresponding Jira issue or Zendesk ticket or sends email to the selected recipient.

## Learn more

- [Track and Fix Findings with Cases and Jira](/platform/cases/overview/)
- [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/)

- [Set up Cases and Jira](/platform/cases/setup/)

- [Set up Cases and Zendesk](/platform/cases/setup-zendesk/)

- [Set up Cases to Email Your Ticket System](/platform/cases/setup-email)

- [Create Cases from Advisories](/platform/cases/advisories/)

- [View and Close Cases](/platform/cases/manage/)
- [Manage Cases](/platform/cases/manage/)

---
83 changes: 65 additions & 18 deletions docs/platform/cases/manage.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,53 +1,100 @@
---
title: View and Close Cases
sidebar_label: View and Close Cases
sidebar_position: 5
description: Cases, which integrate with Atlassian Jira, allow you to track remediation of important security findings. View cases and close them in Mondoo or Jira.
title: Manage Cases
sidebar_label: Manage Cases
sidebar_position: 7
description: Cases, which integrate with Atlassian Jira, allow you to track remediation of important security findings. View cases and close them in Mondoo or Jira. Change cases settings in the Mondoo space settings.
image: /img/featured_img/mondoo-feature.jpg
---

## View cases and Jira issues
Managing cases includes:

On the Cases page in the Mondoo Console, you can view all the cases in a space.
- Viewing open and closed cases

![Cases in Mondoo](/img/platform/cases/cases-list.png)
- Examining case details and progress

Select a case to open its corresponding issue in Jira.
- Closing cases

![Jira issue created by Mondoo](/img/platform/cases/issue-in-jira.png)
- Changing settings that control how cases work in a space

### View cases

On the Cases page in the Mondoo Console, you can view all the open and closed cases in a space and see the progress made toward fixing the assets they track. To view cases in a space:

1. In the [Mondoo Console](https://console.mondoo.com), [navigate](/platform/start/navigate) to the space.

2. In the side navigation bar, select **Cases**.

Status bars show progress made by fixing the assets tracked in each case.

![Cases in Mondoo](/img/platform/cases/cases-list.png)

3. Select a case to see its details.

![Case details in Mondoo](/img/platform/cases/case-detail.png)

:::note

Updating a Jira issue that Mondoo created from a case does not make any changes to the case.
Changes you make to a Mondoo-case-based ticket in your ticket system do not affect the case in Mondoo. Similarly, making progress on a case in Mondoo doesn't update the corresponding ticket in your ticket system.

:::

## Close a case

Close a case to indicate that the work is completed or to stop tracking it. By default, when you close a case in the Mondoo Console, Mondoo also closes the corresponding Jira issue. However, you can change this when you first set up cases for the space. To learn how, read [Set up Cases and Jira](/platform/cases/setup/).
Close a case to indicate that the work is completed or to stop tracking it. You can close a case from the list of cases or from the case detail page.

import Partial from "../partials/_editor-owner.mdx";

<Partial />{" "}

1. In the [Mondoo Console](https://console.mondoo.com), [navigate](/platform/start/navigate) to the space.

2. In the side navigation bar, select **Cases**.

Status bars show progress made by fixing the assets tracked in each case.

![Cases in Mondoo](/img/platform/cases/cases-list.png)

3. To close the case, either:

- Select the **CLOSE CASE** button on the row of the case you want to close

![Close a case in Mondoo from the open cases list](/img/platform/cases/cases-list-close.png)

or

- select the case you want to close and then select the **CLOSE CASE** button near the top-right corner of the case detail page.

![Close a case in Mondoo from the case detail](/img/platform/cases/cases-list-close.png)

:::note

Closing an issue in Jira does not close the corresponding case in Mondoo.
Closing an ticket or issue in your ticket system or does not close the corresponding case in Mondoo. If you create cases using a direct Jira or Zendesk integration, a space-wide setting controls whether closing a case in Mondoo automatically closes the corresponding issue in Jira. To learn more, read the section below.

:::

import Partial from "../partials/_editor-owner.mdx";
### Choose whether to closes tickets/issues when you close cases

<Partial />{" "}
![Space-wide cases settings](/img/platform/cases/space-settings.png)

You can choose whether to close the corresponding Jira issue or Zendesk ticket when you close a case in the Mondoo Console. This setting applies only to direct Jira or Zendesk integrations, not to email integrations.

1. In the Mondoo Console's side navigation bar, select **Cases**.
1. Navigate to the space where you want to change the closing behavior.

![Configure cases in Mondoo](/img/platform/cases/cases-list.png)
2. In the navigation sidebar, select **Settings**.

3. Enable or disable **Automatically close tickets**.

2. Select the **CLOSE CASE** button beside on the row of the case you want to close.

## Learn more

- [Track and Fix Findings with Cases and Jira](/platform/cases/overview/)
- [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/)

- [Set up Cases and Jira](/platform/cases/setup/)

- [Set up Cases and Zendesk](/platform/cases/setup-zendesk/)

- [Set up Cases to Email Your Ticket System](/platform/cases/setup-email)

- [Create Cases from Advisories](/platform/cases/advisories/)

- [Create Cases from Checks](/platform/cases/checks/)
Expand Down
42 changes: 32 additions & 10 deletions docs/platform/cases/overview.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,55 @@
---
title: Track and Fix Findings with Cases and Jira
title: Track and Fix Findings with Cases and Your Ticket System
sidebar_label: Overview
sidebar_position: 1
description: Cases, which integrate with Atlassian Jira, allow you to track remediation of important security findings.
description: Cases allow you to track remediation of important security findings in your Ticket system of choice, such as Jira or Zendesk.
image: /img/featured_img/mondoo-feature.jpg
---

The work of improving your security posture can be daunting. Mondoo finds security issues in your infrastructure and prioritizes them so you know what problems to fix first. But how do you track the fixes and ensure that the work is completed? How do you communicate the most important tasks to your team?

*Cases* allow you to turn security findings into tasks to complete. They integrate with Atlassian Jira to fit into your existing workflow.
*Cases* allow you to turn security findings into tasks to complete. They integrate with your ticket system (issue tracking software), such as Zendesk or Atlassian Jira, to fit into your existing workflow.

When you see a security finding that requires fixing, you create a case for that finding. Mondoo automatically includes the details of the finding, information on the asset(s) that contain the finding, and instructions for fixing it. When you save the case, Mondoo automatically creates an issue containing all the same information in your Jira project.
When you see a security finding that requires fixing, you create a case for that finding.In the new case, Mondoo automatically includes the details of the finding, information on the asset(s) that contain the finding, and instructions for fixing it. When you save the case, Mondoo can do any of these actions:

![Cases in Mondoo and issues in Jira](/img/platform/cases/cases-diagram.png)
- Directly create a Jira issue
- Directly create a Zendesk ticket
- Send an email message to your ticket system (or any destination)

Once Mondoo creates an issue directly in Jira, you can plan, schedule, and track remediation work within your team's existing project workflow. The Jira issues that Mondoo creates from cases include all the details necessary for infrastructure owners to remediate findings, even if they don't have access to Mondoo.
## Directly integrate cases with Jira

If you directly configure cases with your Jira instance, Mondoo creates a corresponding Jira issue for every new case. Once Mondoo creates an issue in Jira, you can plan, schedule, and track remediation work within your team's existing project workflow.

![Cases in Mondoo and issues in Jira](/img/platform/cases/cases-jira-diagram.png)

## Directly integrate cases with Zendesk

If you directly configure cases with your Zendesk account, Mondoo creates a corresponding Zendesk ticket for every new case. Once Mondoo creates a ticket in Zendesk, you can plan, schedule, and track remediation work within your team's existing project workflow.

![Cases in Mondoo and tickets in Zendesk](/img/platform/cases/cases-zendesk-diagram.png)

## Integrate cases with your ticket system using email

If you configure cases to send email to your ticket system, each time you create a new case, Mondoo sends an email message to the recipient you choose. Typically, this is the email address set up as a listener (or similar service) for your ticket, project management, or issue tracking software. Some examples are the Zendesk email channel, ServiceNow inbound email, and the Jira incoming mail handler.

![Cases in Mondoo and issues in Jira](/img/platform/cases/cases-email-diagram.png)

## Track and fix findings

In the Mondoo Console, if a security finding or an asset has a case associated with it, you can view the case from the finding or the asset. You can also see a list of all cases in a space.

You can also close cases in the Mondoo Console. When you set up cases in a Mondoo space, you choose whether closing a case in the space closes the corresponding issue in Jira.
You can view and close cases in the Mondoo Console. When you set up cases in a Mondoo space, you choose whether closing a case in the space closes the corresponding issue in Jira (with a direct Jira integration only).

The email messages or Jira issues that Mondoo creates based on cases include all the details necessary for infrastructure owners to remediate findings. This gives all team members the information they need to address security issues, even if they don't have access to Mondoo.

Tracking and fixing issues with cases and Jira involves:
Tracking and fixing findings with cases and your Ticket system involve:

- [Setting up cases with a Jira integration](/platform/cases/setup/)
- Setting up cases with a [direct Jira integration](/platform/cases/setup/), a [direct Zendesk integration](/platform/cases/setup-zendesk/), or an [email integration](/platform/cases/setup-email/)

- [Creating cases from advisories](/platform/cases/advisories/)

- [Creating cases from checks](/platform/cases/checks/)

- [Viewing and closing cases](/platform/cases/manage/)
- [Viewing and closing cases and managing cases settings](/platform/cases/manage/)

---
Loading

0 comments on commit e4dde9f

Please sign in to comment.