Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc on workspaces #512

Merged
merged 12 commits into from
Jan 7, 2025
4 changes: 4 additions & 0 deletions docs/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,8 @@ A [team member](/platform/maintain/access/team_members/) is a person in your org

A [vulnerability](/platform/security/posture/vulnerabilities/) is a weakness in a computer system that an attacker can exploit to gain access or extract information. Vulnerabilities are also known as CVEs (common vulnerabilities and exposures).

### workspace

[Workspaces](/platform/start/organize/workspaces) are ad hoc groups of assets you want to view together. You might have a workspace for a project, for monitoring a certain problem across your infrastructure, or for a type of asset.

---
2 changes: 2 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ The Mondoo unified security platform finds and prioritizes vulnerabilities and m

- [What Is Mondoo?](/platform/start/plat-what-is/)

- [Plan your Mondoo Organization](/platform/start/organize/overview/)

#### [Integrate Your Infrastructure with Mondoo](/platform/infra/overview/)

- [Cloud](/platform/infra/cloud/overview/)
Expand Down
6 changes: 6 additions & 0 deletions docs/platform/cases/advisories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ import Partial from "../partials/_editor-owner.mdx";

1. In the [Mondoo Console](https://console.mondoo.com), [navigate](/platform/start/navigate) to a space that is set up to use cases.

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

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 your ticket system.
Expand Down
18 changes: 13 additions & 5 deletions docs/platform/intel/inventory.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,29 @@ To disable a query pack for a space, select **ADDED** next to the query pack.

![Inventory view in the Mondoo Console](/img/platform/security/dashboard.png)

2. To drill down into a space, select the box representing the space. Then, in the left navigation under **Inventory**, select **Assets**.
2. To drill down into a space, select the box representing the space.

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

3. In the left navigation under **Inventory**, select **Assets**.

Mondoo organizes your space by integration type, showing summary scores for each integration. You can select an integration type box to see only that type of asset.

![Space view in the Mondoo Console](/img/platform/security/monitor-space.png)

3. Type a keyword (such as AWS or GCP) to filter the list of assets.
4. Type a keyword (such as AWS or GCP) to filter the list of assets.

4. Select the asset you want to examine.
5. Select the asset you want to examine.

5. To see the results of all the enabled queries on the asset, select the **Data Queries** tab.
6. To see the results of all the enabled queries on the asset, select the **Data Queries** tab.

![View data queries in the Mondoo Console](/img/platform/intel/data-queries.png)

6. To see detailed resource information, select the **Resources** tab.
7. To see detailed resource information, select the **Resources** tab.

![View inventory detail in the Mondoo Console](/img/platform/intel/inventory-explore.png)

Expand Down
18 changes: 18 additions & 0 deletions docs/platform/security/customize/advisories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ import Partial from "../../partials/_editor-owner.mdx";

2. Use the Search in Space box in the top-right corner of the page or **Inventory** list in the side navigation bar to open the asset you want.

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

3. Select the **Advisories** tab.

![Advisories tab for an asset](/img/platform/security/advisories-tab.png)
Expand Down Expand Up @@ -60,6 +66,12 @@ To approve or reject an exception:

2. Use the Search in Space box in the top-right corner of the page or **Inventory** list in the side navigation bar to open the asset you want.

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

3. Select the **Exceptions** tab to see all the exceptions for the asset.

![Security policies in the Mondoo Console](/img/platform/security/approve-reject.png)
Expand All @@ -76,6 +88,12 @@ To approve or reject an exception:

2. Use the Search in Space box in the top-right corner of the page or **Inventory** list in the side navigation bar to open the asset you want.

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

3. Select the **Advisories** tab.

4. Check the boxes to the left of the advisories you want to un-snooze or re-enable.
Expand Down
6 changes: 6 additions & 0 deletions docs/platform/security/posture/advisories.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ Find advisories for assets in a space:

1. In the [Mondoo Console](https://console.mondoo.com), [navigate to the space](/platform/start/navigate) in which you want to see advisories.

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

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

![Find Advisories](/img/platform/security/advisories.png)
Expand Down
6 changes: 6 additions & 0 deletions docs/platform/security/posture/monitor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ The **Dashboard** of a space gives you a quick understanding of your security po

To learn how Mondoo ranks the top vulnerabilities and findings, read [Prioritize Security Findings](/platform/security/posture/findings/).

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

4. Use the interactive chart to explore the space:

- The main, inside circle shows the distribution of types of assets in the space.
Expand Down
6 changes: 6 additions & 0 deletions docs/platform/security/posture/vulnerabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Find vulnerabilities for assets in a space:

1. In the [Mondoo Console](https://console.mondoo.com), [navigate to the space](/platform/start/navigate) in which you want to see vulnerabilities.

:::tip

You can also select a [workspace](/platform/start/organize/workspaces/) to view a subset of assets within a space.

:::

2. In the left navigation bar, under **Vulnerabilities**, select **CVEs**.

![Find vulnerabilities](/img/platform/security/cves.png)
Expand Down
48 changes: 37 additions & 11 deletions docs/platform/start/organize/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,52 @@ descriptions: Create a manageable structure for monitoring and securing your inf
image: /img/featured_img/mondoo-feature.jpg
---

You can rely on Mondoo to secure an enormous quantity of assets in your infrastructure -- cloud platforms, workstations, servers, containers, SaaS platforms, and much more. For larger businesses, Mondoo provides asset intelligence, security, and compliance for thousands of assets. To make securing and monitoring your infrastructure manageable, you can arrange your Mondoo assets in regions, organizations, and spaces. It's best to plan your infrastructure structure before you begin integrating your infrastructure with Mondoo.
You can rely on Mondoo to secure an enormous quantity of assets in your infrastructure—cloud platforms, workstations, servers, containers, SaaS platforms, and much more. For larger businesses, Mondoo provides asset intelligence, security, and compliance for thousands of assets. To make securing and monitoring your infrastructure manageable, you can arrange your Mondoo assets in regions, organizations, spaces, and workspaces. It's best to plan your infrastructure organization before you begin adding assets to Mondoo.

:::note
![Region, organization, space, and workspace in Mondoo](/img/platform/start/organize-basics.png)

Privately hosted Enterprise accounts run in a single region.
- [Regions](/platform/start/organize/regions) let you follow localized data protection requirements such as GDPR. Mondoo currently supports two regions: US and EU. Privately hosted Mondoo Enterprise accounts run in a single region.

:::
- [Organizations](/platform/start/organize/organizations) provide a way to separate different major parts of your business and manage team members' access. Most Mondoo customers have only one organization. However, if you have business divisions that operate quite differently and have separate dedicated teams, you might consider creating multiple organizations.

This is an example of an infrastructure organization:
- [Spaces](/platform/start/organize/spaces) are structured collections of assets, policies, compliance frameworks, security models, ticket system integrations, and reports that you manage together. You can also manage team member access by space. Most Mondoo customers have multiple spaces.

![Organize even the largest infrastructure with Mondoo](/img/platform/start/org-simple.png)
- [Workspaces](/platform/start/organize/workspaces) are ad hoc groups of assets you want to view together. You might have a workspace for a project, for monitoring a certain problem across your infrastructure, or for a type of asset.

- [Regions](/platform/start/organize/regions) allow you to follow localized policy requirements (such as GDPR).
Regions, organizations, and spaces form the structure of your assets in Mondoo. An organization can be in only one region. A space can be in only one organization. An asset can be in only one space.

- [Organizations](/platform/start/organize/organizations) provide a way to separate and organize different parts of your business and manage team members' access.
Workspaces are not structural; an asset can be in multiple workspaces.

- [Spaces](/platform/start/organize/spaces) are collections of assets, policies, and reports that you manage together.
## Examples of organizations

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.
Imagine a US-based company called Lunalectric that makes rovers and rockets for space exploration. Lunalectric's business structure is divided by product type. There's a division focused on rovers and another focused on rockets. There's also a Commerce division containing finance, marketing, human resources, and so on. The company has a single operations team and a single security team.

![Organize a small infrastructure with Mondoo](/img/platform/start/org-complex.png)
Here's one way Lunalectric might organize their assets in Mondoo:

![Sample organizational structure in Mondoo](/img/platform/start/luna-org-1.png)

In this example, Lunalectric creates a single organization that contains a different space for each type of asset they monitor with Mondoo. Their AWS assets go in the Cloud space, all employee laptops are in the Workstations space, and so on. Each space contains many different workspaces for the different views and perspective they need to assess.

Here's an alternative way Lunalectric might organize their assets:

![Sample organizational structure in Mondoo](/img/platform/start/luna-org-2.png)

In this second example, Lunalectric creates a single organization that contains three spaces: one space for each business division. Each space contains a very large number of assets.

The Lunalectric team relies on many different workspaces, some examples of which are shown in the diagram above, to view subsets of assets in the different spaces. For example:

- Each space has an "urgent" workspace that shows all the assets in the space that have serious security issues requiring immediate attention.

- The Rocket space has a workspace that shows only assets used on federal projects.

- The Rover space has a workspaces dedicated to cloud assets.

- One Rocket team member, Stella, made a workspace that lets her focus on her current projects.

- The Commerce space includes a workspace specifically for assessing the security of lunalectric web properties.

## The best structure for you

There's no _right_ way to organize your assets in Mondoo. Take some time to understand what you need to learn from Mondoo and outline a couple of different organizational ideas.

---
Loading
Loading