diff --git a/docs/intro.md b/docs/intro.md index ecc615d8..df2a063e 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -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/) diff --git a/docs/platform/cases/advisories.mdx b/docs/platform/cases/advisories.mdx index 22cc5727..6e3551be 100644 --- a/docs/platform/cases/advisories.mdx +++ b/docs/platform/cases/advisories.mdx @@ -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"; @@ -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/) --- diff --git a/docs/platform/cases/checks.mdx b/docs/platform/cases/checks.mdx index 1805f863..bbd8d829 100644 --- a/docs/platform/cases/checks.mdx +++ b/docs/platform/cases/checks.mdx @@ -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"; @@ -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/) --- diff --git a/docs/platform/cases/manage.mdx b/docs/platform/cases/manage.mdx index 01a372d1..70b1a517 100644 --- a/docs/platform/cases/manage.mdx +++ b/docs/platform/cases/manage.mdx @@ -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"; + +{" "} + +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 -{" "} +![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/) diff --git a/docs/platform/cases/overview.mdx b/docs/platform/cases/overview.mdx index d9fcb398..30f312f1 100644 --- a/docs/platform/cases/overview.mdx +++ b/docs/platform/cases/overview.mdx @@ -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/) --- diff --git a/docs/platform/cases/setup-email.mdx b/docs/platform/cases/setup-email.mdx new file mode 100644 index 00000000..c00f7bb4 --- /dev/null +++ b/docs/platform/cases/setup-email.mdx @@ -0,0 +1,59 @@ +--- +title: Set up Cases to Email Your Ticket System +sidebar_label: Set up Cases with Email +sidebar_position: 4 +description: Mondoo cases, which you can integrate with your ticket, issue tracking, or project management software, allow you to track remediation of important security findings. Set up an integration to start using cases and include Mondoo data in your regular project workflow. +image: /img/featured_img/mondoo-feature.jpg +--- + +Set up cases in a space to allow users in the space to keep track of security tasks from within the Mondoo Console. Create an email integration to automatically send email to your ticket, issue tracking, or project management system when you create a new case. Your ticket system's email listener or service receives the email and generates a ticket using the information Mondoo includes in the email. + +For an overview of cases, read [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/). + +You can set up multiple recipients for case email messages. When you create a new case, a drop-down lets you choose the recipient for that case. This is helpful for teams with different methods for tracking different types of tasks. + +## Prerequisites + +- Owner or Editor access to the Mondoo space + +- A listener or similar service set up in your ticket system, such as the Zendesk email channel, ServiceNow inbound email, or the Jira incoming mail handler. + +## Add an email integration for cases + +1. In the Mondoo Console, navigate to the space where you want to set up cases and, in the side navigation bar, select **Cases**. + + ![Configure cases in Mondoo](/img/platform/cases/cases-blank.png) + +2. Select the **ADD INTEGRATION** button. + + ![Configure cases in Mondoo](/img/platform/cases/cases-integrations.png) + +3. Select **Ticketing via email**. + + ![Configure cases in Mondoo](/img/platform/cases/cases-add-email.png) + +4. In the **Choose an integration name** box, enter a name for the integration. Make it a name that clearly shows the purpose of the integration. + +5. Under **Recipient 1**, provide information about where to send case email messages: + + - The **Name** identifies the recipient. This displays in the recipients drop-down list when you add a new case. + + - The **Email address** is where Mondoo directs the email message. + + - You can include a **Reference link** to provide a link to the ticket system from the case details page in Mondoo. + +6. To add another option for where to send case email messages, select ***ADD A RECIPIENT** and provide the details for Recipient 2, 3, and so on. + +7. Select the **CREATE INTEGRATION** button. + +## Learn more + +- [Create Cases from Advisories](/platform/cases/advisories/) + +- [Create Cases from Checks](/platform/cases/checks/) + +- [Manage Cases](/platform/cases/manage/) + +- [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/) + +--- diff --git a/docs/platform/cases/setup-zendesk.mdx b/docs/platform/cases/setup-zendesk.mdx new file mode 100644 index 00000000..a7d3b624 --- /dev/null +++ b/docs/platform/cases/setup-zendesk.mdx @@ -0,0 +1,69 @@ +--- +title: Set up Cases and Zendesk +sidebar_label: Set up Cases and Zendesk +sidebar_position: 3 +description: Mondoo cases, which you can directly integrate with Zendesk, allow you to track remediation of important security findings. Set up an integration with Zendesk to start using cases and include Mondoo data in your Zendesk tickets. +image: /img/featured_img/mondoo-feature.jpg +--- + +Set up cases in a space to allow users in the space to keep track of security tasks and add Zendesk tickets directly from within the Mondoo Console. Cases setup involves configuring Mondoo to integrate with Zendesk. + +For an overview of cases, read [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/). + +:::note + +Mondoo offers an alternative method for sharing cases with Zendesk: an email integration. This approach lets you tap into the automation features of [Zendesk email channel](https://support.zendesk.com/hc/en-us/sections/5437005103002-Setting-up-your-email-channel). To learn how to create an email integration for cases, read [Set up Cases to Email Your Ticket System](/platform/cases/setup-email). + +::: + +## Prerequisites + +- Owner or Editor access to the Mondoo space + +- A Zendesk account with access to the channel where you want Mondoo to add tickets + +- An API token for Zendesk account access + + To learn how to create and copy an API token, read [Managing API token access to the API](https://support.zendesk.com/hc/en-us/articles/4408889192858-Managing-access-to-the-Zendesk-API#topic_tcb_fk1_2yb) in the Atlassian documentation. + +## Add a Zendesk integration + +1. In the Mondoo Console, navigate to the space where you want to set up cases and, in the side navigation bar, select **Cases**. + + ![Configure cases in Mondoo](/img/platform/cases/cases-blank.png) + +2. Select the **ADD INTEGRATION** button. + + ![Configure cases in Mondoo](/img/platform/cases/cases-integrations.png) + +3. Select **Zendesk**. + + ![Configure cases in Mondoo](/img/platform/cases/cases-add-zendesk.png) + +4. In the **Choose an integration name** box, enter a name for the integration. Make it a name that clearly shows this is a Zendesk integration. + +5. In the **Zendesk domain** box, your Zendesk subdomain. This is the custom part of the URL you use to access Zendesk. For example, if your Zendesk URL is `lunalectric.zendesk.com` then enter `lunalectric` in this box. + +6. In the **Email address** box, enter the email address you use to log into your Zendesk instance. + +7. In the **API Token** box, paste your API token for access to your Zendesk account. To learn how to create and copy an API token, read [Managing API token access to the API](https://support.zendesk.com/hc/en-us/articles/4408889192858-Managing-access-to-the-Zendesk-API#topic_tcb_fk1_2yb) in the Atlassian documentation. + +8. Select the **CREATE INTEGRATION** button. + + ![Configure cases in Mondoo](/img/platform/cases/cases-preferences.png) + +9. To close a case in Mondoo when the corresponding Zendesk ticket closes, enable **Automatically close cases**. + +10. Select the **FINALIZE UPDATE** button. + +## Learn more + +- [Create Cases from Advisories](/platform/cases/advisories/) + +- [Create Cases from Checks](/platform/cases/checks/) + +- [Manage Cases](/platform/cases/manage/) + +- [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/) + +--- diff --git a/docs/platform/cases/setup.mdx b/docs/platform/cases/setup.mdx index 0ce192a6..b9cf51ff 100644 --- a/docs/platform/cases/setup.mdx +++ b/docs/platform/cases/setup.mdx @@ -2,13 +2,19 @@ title: Set up Cases and Jira sidebar_label: Set up Cases and Jira sidebar_position: 2 -description: Cases, which integrate with Atlassian Jira, allow you to track remediation of important security findings. Set up an integration with Jira to start using cases. +description: Mondoo cases, which you can directly integrate with Atlassian Jira, allow you to track remediation of important security findings. Set up an integration with Jira to start using cases and include Mondoo data in your Jira issues. image: /img/featured_img/mondoo-feature.jpg --- -Set up cases in a space to allow users in the space to add Jira issues from within the Mondoo Console. Cases setup involves configuring Mondoo to integrate with Jira. +Set up cases in a space to allow users in the space to keep track of security tasks and add Jira issues directly from within the Mondoo Console. Cases setup involves configuring Mondoo to integrate with Jira. -For an overview of cases, read [Track and Fix Findings with Cases and Jira](/platform/cases/overview/). +For an overview of cases, read [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/). + +:::note + +Mondoo offers an alternative method for sharing cases with Jira: an email integration. Although email integrations with Jira don't let you automatically close Jira issues when you close a case, they do let you tap into the automation features of [Jira's incoming mail handler](https://support.atlassian.com/jira-cloud-administration/docs/create-issues-and-comments-from-email/). To learn how to create an email integration for cases, read [Set up Cases to Email Your Ticket System](/platform/cases/setup-email). + +::: ## Prerequisites @@ -28,26 +34,36 @@ For an overview of cases, read [Track and Fix Findings with Cases and Jira](/pla 2. Select the **ADD INTEGRATION** button. - ![Configure cases in Mondoo](/img/platform/cases/cases-add-jira.png) + ![Configure cases in Mondoo](/img/platform/cases/cases-integrations.png) + +3. Select **Atlassian Jira**. -3. In the **Choose an integration name** box, enter a name for the integration. Make it a name that clearly shows this is a Jira integration. + ![Configure cases in Mondoo](/img/platform/cases/cases-add-jira.png) -4. In the **Jira Host** box, type the domain for your Jira instance. Do not include a slash at the end of the domain. Example: `https://lunalectric-workspace.atlassian.net` +4. In the **Choose an integration name** box, enter a name for the integration. Make it a name that clearly shows this is a Jira integration. -5. In the **Email address** box, enter the email address you use to log into your Jira instance. +5. In the **Jira host** box, type the domain for your Jira instance. Do not include a slash at the end of the domain. Example: `https://lunalectric-workspace.atlassian.net` -6. In the **API Token** box, paste your API token for access to your Jira account. To learn how to create and copy an API token, read [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) in the Atlassian documentation. +6. In the **Email address** box, enter the email address you use to log into your Jira instance. -7. By default, when you close a case in the Mondoo Console, Mondoo also closes the corresponding Jira issue. To stop Mondoo from closing Jira issues, disable **Automatically close cases**. +7. In the **API token** box, paste your API token for access to your Jira account. To learn how to create and copy an API token, read [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) in the Atlassian documentation. 8. Select the **CREATE INTEGRATION** button. -## Learn more + ![Configure cases in Mondoo](/img/platform/cases/cases-preferences.png) + +9. To close a case in Mondoo when the corresponding Jira issue closes, enable **Automatically close cases**. + +10. Select the **FINALIZE UPDATE** button. -- [Track and Fix Findings with Cases and Jira](/platform/cases/overview/) +## Learn more - [Create Cases from Advisories](/platform/cases/advisories/) - [Create Cases from Checks](/platform/cases/checks/) +- [Manage Cases](/platform/cases/manage/) + +- [Track and Fix Findings with Cases and Your Ticket System](/platform/cases/overview/) + --- diff --git a/docs/platform/home.md b/docs/platform/home.md index cb87e1f8..95aa1448 100644 --- a/docs/platform/home.md +++ b/docs/platform/home.md @@ -32,7 +32,7 @@ The Mondoo unified security platform finds and prioritizes vulnerabilities and m ### [Reach Continuous 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/) ### [Gain Asset Intelligence](/platform/intel/overview/) diff --git a/docs/platform/start/organize/overview.md b/docs/platform/start/organize/overview.md index 19c3ba65..e7c4c0ab 100644 --- a/docs/platform/start/organize/overview.md +++ b/docs/platform/start/organize/overview.md @@ -24,7 +24,7 @@ This is an example of an infrastructure organization: - [Spaces](/platform/start/organize/spaces) are collections of assets, policies, and reports that you manage together. -You can organize your infrastructure in as complex or simple a structure as you need. All security, compliance, and asset intelligence reports, data exports, and ticketing system exports are organized in the structure you create. +You can organize your infrastructure in as complex or simple a structure as you need. All security, compliance, and asset intelligence reports, data exports, and Ticket system exports are organized in the structure you create. ![Organize a small infrastructure with Mondoo](/img/platform/start/org-complex.png) diff --git a/static/img/platform/cases/add-case-advisory.png b/static/img/platform/cases/add-case-advisory.png index 7cf45c64..3207ac82 100644 Binary files a/static/img/platform/cases/add-case-advisory.png and b/static/img/platform/cases/add-case-advisory.png differ diff --git a/static/img/platform/cases/affected-assets.png b/static/img/platform/cases/affected-assets.png new file mode 100644 index 00000000..7e8e8ae4 Binary files /dev/null and b/static/img/platform/cases/affected-assets.png differ diff --git a/static/img/platform/cases/case-detail.png b/static/img/platform/cases/case-detail.png new file mode 100644 index 00000000..5a49b057 Binary files /dev/null and b/static/img/platform/cases/case-detail.png differ diff --git a/static/img/platform/cases/cases-add-email-bottom.png b/static/img/platform/cases/cases-add-email-bottom.png new file mode 100644 index 00000000..556f2677 Binary files /dev/null and b/static/img/platform/cases/cases-add-email-bottom.png differ diff --git a/static/img/platform/cases/cases-add-email.png b/static/img/platform/cases/cases-add-email.png new file mode 100644 index 00000000..3d404632 Binary files /dev/null and b/static/img/platform/cases/cases-add-email.png differ diff --git a/static/img/platform/cases/cases-add-jira.png b/static/img/platform/cases/cases-add-jira.png index ea935de4..d3aa2da3 100644 Binary files a/static/img/platform/cases/cases-add-jira.png and b/static/img/platform/cases/cases-add-jira.png differ diff --git a/static/img/platform/cases/cases-add-zendesk.png b/static/img/platform/cases/cases-add-zendesk.png new file mode 100644 index 00000000..3ac68412 Binary files /dev/null and b/static/img/platform/cases/cases-add-zendesk.png differ diff --git a/static/img/platform/cases/cases-blank.png b/static/img/platform/cases/cases-blank.png index 555bd684..255b74b7 100644 Binary files a/static/img/platform/cases/cases-blank.png and b/static/img/platform/cases/cases-blank.png differ diff --git a/static/img/platform/cases/cases-diagram.png b/static/img/platform/cases/cases-diagram.png deleted file mode 100644 index 36ddab2f..00000000 Binary files a/static/img/platform/cases/cases-diagram.png and /dev/null differ diff --git a/static/img/platform/cases/cases-email-diagram.png b/static/img/platform/cases/cases-email-diagram.png new file mode 100644 index 00000000..2ff97f1f Binary files /dev/null and b/static/img/platform/cases/cases-email-diagram.png differ diff --git a/static/img/platform/cases/cases-integrations.png b/static/img/platform/cases/cases-integrations.png new file mode 100644 index 00000000..260b2cd0 Binary files /dev/null and b/static/img/platform/cases/cases-integrations.png differ diff --git a/static/img/platform/cases/cases-jira-diagram.png b/static/img/platform/cases/cases-jira-diagram.png new file mode 100644 index 00000000..50a24196 Binary files /dev/null and b/static/img/platform/cases/cases-jira-diagram.png differ diff --git a/static/img/platform/cases/cases-list-close.png b/static/img/platform/cases/cases-list-close.png new file mode 100644 index 00000000..bdef8204 Binary files /dev/null and b/static/img/platform/cases/cases-list-close.png differ diff --git a/static/img/platform/cases/cases-list.png b/static/img/platform/cases/cases-list.png index e7391941..420cac6b 100644 Binary files a/static/img/platform/cases/cases-list.png and b/static/img/platform/cases/cases-list.png differ diff --git a/static/img/platform/cases/cases-preferences.png b/static/img/platform/cases/cases-preferences.png new file mode 100644 index 00000000..f9ff67a9 Binary files /dev/null and b/static/img/platform/cases/cases-preferences.png differ diff --git a/static/img/platform/cases/cases-zendesk-diagram.png b/static/img/platform/cases/cases-zendesk-diagram.png new file mode 100644 index 00000000..c1d2f130 Binary files /dev/null and b/static/img/platform/cases/cases-zendesk-diagram.png differ diff --git a/static/img/platform/cases/check-case.png b/static/img/platform/cases/check-case.png index a11d7ec7..9c37a747 100644 Binary files a/static/img/platform/cases/check-case.png and b/static/img/platform/cases/check-case.png differ diff --git a/static/img/platform/cases/checks.png b/static/img/platform/cases/checks.png deleted file mode 100644 index f41d922e..00000000 Binary files a/static/img/platform/cases/checks.png and /dev/null differ diff --git a/static/img/platform/cases/new-case-check.png b/static/img/platform/cases/new-case-check.png new file mode 100644 index 00000000..2595fad4 Binary files /dev/null and b/static/img/platform/cases/new-case-check.png differ diff --git a/static/img/platform/cases/new-case.png b/static/img/platform/cases/new-case.png index 7d9c00de..75f80ee8 100644 Binary files a/static/img/platform/cases/new-case.png and b/static/img/platform/cases/new-case.png differ diff --git a/static/img/platform/cases/select-asset.png b/static/img/platform/cases/select-asset.png index 0d43bbbc..728d4ea0 100644 Binary files a/static/img/platform/cases/select-asset.png and b/static/img/platform/cases/select-asset.png differ diff --git a/static/img/platform/cases/space-settings.png b/static/img/platform/cases/space-settings.png new file mode 100644 index 00000000..f69bf3a2 Binary files /dev/null and b/static/img/platform/cases/space-settings.png differ