Skip to content

Commit

Permalink
Update docs to reflect the integrations ui changes I made
Browse files Browse the repository at this point in the history
  • Loading branch information
misterpantz committed Aug 8, 2024
1 parent 1486b48 commit d5d20dd
Show file tree
Hide file tree
Showing 28 changed files with 52 additions and 58 deletions.
4 changes: 2 additions & 2 deletions docs/cnspec/cloud/aws/packer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ To configure the plugin to work in registered mode, you must first create a Base

To create a Base64-encoded service account:

1. Navigate to the space you want to create a service account in.
2. Select **Settings** followed by **Service Accounts**.
1. [Navigate](/platform/start/navigate/) to the space in which you want to create a service account.
2. In the left navigation, select **Settings**. Then select the **Service Accounts** tab.
3. Select **ADD ACCOUNT**.
4. Check the **Base64-encoded** box to Base64-encode the credentials.
5. Select **GENERATE NEW CREDENTIALS**.
Expand Down
4 changes: 2 additions & 2 deletions docs/cnspec/cloud/gcp/packer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ To configure the plugin to work in registered mode, you must first create a Base

To create a Base64-encoded service account:

1. Navigate to the space you want to create a service account in.
2. Select **Settings** followed by **Service Accounts**.
1. [Navigate](/platform/start/navigate/) to the space in which you want to create a service account.
2. In the left navigation, select **Settings**. Then select the **Service Accounts** tab.
3. Select **ADD ACCOUNT**.
4. Check the **Base64-encoded** box to Base64-encode the credentials.
5. Select **GENERATE NEW CREDENTIALS**.
Expand Down
4 changes: 2 additions & 2 deletions docs/platform/infra/cloud/aws/hosted/integration-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ import Partial from "../../../../partials/_editor-owner.mdx";

![AWS integration options](/img/platform/infra/cloud/aws/hosted-or-serverless.png)

2. Select **Mondoo-Hosted**.
2. Select **SELECT MONDOO-HOSTED INTEGRATION**.

![integration-create-image](/img/platform/infra/cloud/aws/add-hosted-top.png)

3. In the **Choose an integration name** box, type a recognizable name for this AWS asset.

4. Access the AWS IAM tab in your browser that shows the access keys you created in the steps above. Copy the **Access key**.
4. Access the AWS IAM tab in your browser that shows the access keys you created in the steps above. Copy the **Access key** value.

![AWS access portal](/img/platform/infra/cloud/aws/keys.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Every time the Lambda function updates, it first reads the SHA-256 of each file

## What happens if I delete the CloudFormation stack?

When the CloudFormation stack is deleted, the lambda function receives a notification and immediately deletes all AWS resources created by Mondoo. Mondoo Platform UI will display the integration as deleted. No data will be lost in Mondoo Platform. A CloudFormation stack can be deleted and recreated multiple times.
When the CloudFormation stack is deleted, the Lambda function receives a notification and immediately deletes all AWS resources created by Mondoo. Mondoo Platform UI will display the integration as deleted. No data will be lost in Mondoo Platform. A CloudFormation stack can be deleted and recreated multiple times.

## How much will operating the serverless Mondoo AWS integration cost?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Security groups for all AWS SSM-managed instances must include an egress rule to

## Logging and metrics

All lambda logs are stored in CloudWatch Logs, under a log group calls `/aws/lambda/MondooLambda` in the region where the CloudFormation was installed.
All Lambda logs are stored in CloudWatch Logs, under a log group calls `/aws/lambda/MondooLambda` in the region where the CloudFormation was installed.

To search the logs in the log group, select it and choose "Search Log Group" from the upper right corner of the console. ![AWS CloudWatch Log Group Details Console](/img/platform/infra/cloud/aws/lambda-loggroup.png)
You can search for specific log messages or view a specific time frame of activity in one pane from this view.
Expand Down
20 changes: 9 additions & 11 deletions docs/platform/infra/cloud/azure/azure-integration-scan-group.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -348,19 +348,19 @@ After you've created, granted permissions to, and tested a new app registration,

2. In the **Choose an integration name** box, enter a name for the integration. Make it a name that lets you easily recognize the Azure tenant.

3. In the **Enter Application (client) ID** box, enter the value from the `appId` value you copied in Step B.
3. In the **Enter the application (client) ID** box, enter the value from the `appId` value you copied in Step B.

4. In the **Enter the Directory (tenant) ID** box, enter the `tenantId` value you copied in Step A.
4. In the **Enter the directory (tenant) ID** box, enter the `tenantId` value you copied in Step A.

5. Specify the subscriptions for Mondoo to continuously scan. You copied at least one subscription ID in step A.

- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the Directory (tenant) ID** toggle enabled.
- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the directory (tenant) ID** toggle enabled.

- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Allowlist, and enter the subscription ID to scan.
- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Allow list** and enter the subscription ID to scan.

- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Denylist, and enter the names of the subscriptions you don't want Mondoo to scan.
- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Deny list** and enter the names of the subscriptions you don't want Mondoo to scan.

6. To automatically discover all Linux and Windows VMs in your subscription and scan them using Azure Run Command, select **Scan Azure VMs using Run Command**.
6. To automatically scan all VMs in your subscription, enable **Scan VMs**.

7. Provide the certificate (a [PEM](https://aboutssl.org/what-is-pem-certificate-file/) (privacy-enhanced mail) file) for Mondoo to securely authenticate with the app (service principal) you created. You created this certificate in Step B.

Expand All @@ -379,13 +379,11 @@ After you've created, granted permissions to, and tested a new app registration,

![integration-create-image](/img/platform/infra/cloud/azure/add-int-azure-bottom.png)

8. To automatically scan all VMs in your subscription, enable **Scan Azure VMs using RunCommand**.
8. Select the **START SCANNING** button.

9. Select the **START SCANNING** button.
9. On the Recommended Policies page, enable the policies on which you want to base assessments of your Azure environment. To learn more, read [Manage Policies](/platform/security/posture/policies/).

10. On the Recommended Policies page, enable the policies on which you want to base assessments of your Azure environment. To learn more, read [Manage Policies](/platform/security/posture/policies/).

11. Select **FINALIZE SETUP**.
10. Select **FINALIZE SETUP**.

Mondoo begins scanning your Azure resources. When it completes, you can see results on the INVENTORY page. To learn more, read [Monitor Your Infrastructure Security](/platform/security/posture/monitor/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,19 +332,19 @@ After you've created, granted permissions to, and tested a new app registration,

2. In the **Choose an integration name** box, enter a name for the integration. Make it a name that lets you easily recognize the Azure tenant.

3. In the **Enter Application (client) ID** box, enter the value from the `appId` value you copied in Step B.
3. In the **Enter the application (client) ID** box, enter the value from the `appId` value you copied in Step B.

4. In the **Enter the Directory (tenant) ID** box, enter the `tenantId` value you copied in Step A.
4. In the **Enter the directory (tenant) ID** box, enter the `tenantId` value you copied in Step A.

5. Specify the subscriptions for Mondoo to continuously scan. You copied at least one subscription ID in step A.

- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the Directory (tenant) ID** toggle enabled.
- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the directory (tenant) ID** toggle enabled.

- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Allowlist, and enter the subscription ID to scan.
- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Allow list**, and enter the subscription IDs. Type each subscription on a new line.

- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Denylist, and enter the names of the subscriptions you don't want Mondoo to scan.
- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Deny list**, and enter the names of the subscriptions you don't want Mondoo to scan. Type each subscription on a new line.

6. To automatically discover all Linux and Windows VMs in your subscription and scan them using Azure Run Command, select **Scan Azure VMs using Run Command**.
6. To automatically discover all Linux and Windows VMs in your subscription and scan them using Azure Run Command, enable **Scan VMs**.

7. Provide the certificate (a [PEM](https://aboutssl.org/what-is-pem-certificate-file/) (privacy-enhanced mail) file) for Mondoo to securely authenticate with the app (service principal) you created. You created this certificate in Step B.

Expand All @@ -363,13 +363,11 @@ After you've created, granted permissions to, and tested a new app registration,

![integration-create-image](/img/platform/infra/cloud/azure/add-int-azure-bottom.png)

8. To automatically scan all VMs in your subscription, enable **Scan Azure VMs using RunCommand**.
8. Select the **START SCANNING** button.

9. Select the **START SCANNING** button.
9. On the Recommended Policies page, enable the policies on which you want to base assessments of your Azure environment. To learn more, read [Manage Policies](/platform/security/posture/policies/).

10. On the Recommended Policies page, enable the policies on which you want to base assessments of your Azure environment. To learn more, read [Manage Policies](/platform/security/posture/policies/).

11. Select **FINALIZE SETUP**.
10. Select **FINALIZE SETUP**.

Mondoo begins scanning your Azure resources. When it completes, you can see results on the INVENTORY page. To learn more, read [Monitor Your Infrastructure Security](/platform/security/posture/monitor/).

Expand Down
20 changes: 9 additions & 11 deletions docs/platform/infra/cloud/azure/manual-reg-path.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -244,19 +244,19 @@ After you've created, granted permissions to, and tested a new app registration,

2. In the **Choose an integration name** box, enter a name for the integration. Make it a name that lets you easily recognize the Azure tenant.

3. In the **Enter Application (client) ID** box, enter the value from the app registration's **Application (client) ID** box.
3. In the **Enter the application (client) ID** box, enter the value from the app registration's **Application (client) ID** box.

4. In the **Enter the Directory (tenant) ID** box, enter the value from the app registration's **Directory (tenant) ID** box.
4. In the **Enter the directory (tenant) ID** box, enter the value from the app registration's **Directory (tenant) ID** box.

5. Specify the subscriptions for Mondoo to continuously scan.

- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the Directory (tenant) ID** toggle enabled.
- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the directory (tenant) ID** toggle enabled.

- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Allowlist, and enter the subscription ID to scan.
- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Allow list** and enter the subscription ID to scan.

- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Denylist, and enter the names of the subscriptions you don't want Mondoo to scan.
- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Deny list** and enter the names of the subscriptions you don't want Mondoo to scan.

6. To automatically discover all Linux and Windows VMs in your subscription and scan them using Azure Run Command, select **Scan Azure VMs using Run Command**.
6. To automatically discover all Linux and Windows VMs in your subscription and scan them using Azure Run Command, enable **Scan VMs**.

7. Provide a certificate (a [PEM](https://aboutssl.org/what-is-pem-certificate-file/) (privacy-enhanced mail) file) for Mondoo to securely authenticate with the app (service principal) you created.

Expand All @@ -275,13 +275,11 @@ After you've created, granted permissions to, and tested a new app registration,

![integration-create-image](/img/platform/infra/cloud/azure/add-int-azure-bottom.png)

8. To automatically scan all VMs in your subscription, enable **Scan Azure VMs using RunCommand**.
8. Select the **START SCANNING** button.

9. Select the **START SCANNING** button.
9. On the Recommended Policies page, enable the policies on which you want to base assessments of your Azure environment. To learn more, read [Manage Policies](/platform/security/posture/policies/).

10. On the Recommended Policies page, enable the policies on which you want to base assessments of your Azure environment. To learn more, read [Manage Policies](/platform/security/posture/policies/).

11. Select **FINALIZE SETUP**.
10. Select **FINALIZE SETUP**.

Mondoo begins scanning your Azure resources. When it completes, you can see results on the INVENTORY page. To learn more, read [Monitor Your Infrastructure Security](/platform/security/posture/monitor/).

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/infra/cloud/gcp/gcp-integration-scan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ To access the data it needs, your GCP integration needs a GCP service account. T

- For a project: In the **Enter the project ID** box, enter your project's ID. To learn how to retrieve this value, read [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) in the Google documentation.

5. Under **Provide your Google Service Account config**, upload the GCP service account's JSON key that you downloaded in the previous section:
5. Under **Provide your Google service account config**, upload the GCP service account's JSON key that you downloaded in the previous section:

Drag the file and drop it in the **Drag and drop your .json file here** box.

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/infra/saas/google_workspace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import Partial2 from "../../partials/_editor-owner.mdx";

3. In the **Mandated user's email** box, enter the email address of a Google Workspace user with super admin access. Mondoo relies on this user's privileges to access the information it needs. You can choose an existing super admin or create one just for Mondoo.

4. Under **Provide your Google Service Account config**, upload the GCP service account's JSON key that you downloaded in the previous section:
4. Under **Provide your Google service account config**, upload the GCP service account's JSON key that you downloaded in the previous section:

Drag the file and drop it in the **Drag and drop your .json file here** box.

Expand Down
10 changes: 5 additions & 5 deletions docs/platform/infra/saas/ms365/ms365-auto.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,17 +227,17 @@ After you've created and granted permissions to a new app registration, you can

2. In the **Choose an integration name** box, enter a name for the integration. Make it a name that lets you easily recognize the Microsoft 365 tenant.

3. In the **Enter Application (client) ID** box, enter the value from the app registration's **Application (client) ID** box.
3. In the **Enter the application (client) ID** box, enter the value from the app registration's **Application (client) ID** box.

4. In the **Enter the Directory (tenant) ID** box, enter the value from the app registration's **Directory (tenant) ID** box.
4. In the **Enter the directory (tenant) ID** box, enter the value from the app registration's **Directory (tenant) ID** box.

5. Specify the subscriptions for Mondoo to continuously scan.

- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the Directory (tenant) ID** toggle enabled.
- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the directory (tenant) ID** toggle enabled.

- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Allowlist, and enter the subscription ID to scan.
- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Allow list** and enter the subscription ID to scan.

- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Denylist, and enter the names of the subscriptions you don't want Mondoo to scan.
- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Deny list** and enter the names of the subscriptions you don't want Mondoo to scan.

6. Provide a certificate (a [PEM](https://aboutssl.org/what-is-pem-certificate-file/) (privacy-enhanced mail) file) for Mondoo to securely authenticate with the app (service principal) you created.

Expand Down
10 changes: 5 additions & 5 deletions docs/platform/infra/saas/ms365/ms365-manual.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -188,17 +188,17 @@ After you've created and granted permissions to a new app registration, you can

2. In the **Choose an integration name** box, enter a name for the integration. Make it a name that lets you easily recognize the Microsoft 365 tenant.

3. In the **Enter Application (client) ID** box, enter the value from the app registration's **Application (client) ID** box.
3. In the **Enter the application (client) ID** box, enter the value from the app registration's **Application (client) ID** box.

4. In the **Enter the Directory (tenant) ID** box, enter the value from the app registration's **Directory (tenant) ID** box.
4. In the **Enter the directory (tenant) ID** box, enter the value from the app registration's **Directory (tenant) ID** box.

5. Specify the subscriptions for Mondoo to continuously scan.

- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the Directory (tenant) ID** toggle enabled.
- To continuously scan all subscriptions in the tenant, leave the **Scan all subscriptions connected to the directory (tenant) ID** toggle enabled.

- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Allowlist, and enter the subscription ID to scan.
- To choose the subscriptions to scan, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Allow list** and enter the subscription ID to scan.

- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the Directory (tenant) ID** toggle, select Denylist, and enter the names of the subscriptions you don't want Mondoo to scan.
- To scan **all** subscriptions except those you specify, disable the **Scan all subscriptions connected to the directory (tenant) ID** toggle, select **Deny list** and enter the names of the subscriptions you don't want Mondoo to scan.

6. Provide a certificate (a [PEM](https://aboutssl.org/what-is-pem-certificate-file/) (privacy-enhanced mail) file) for Mondoo to securely authenticate with the app (service principal) you created.

Expand Down
Loading

0 comments on commit d5d20dd

Please sign in to comment.