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

Broken link to GH folder on the AWS Import Guide Closes #125 #182

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/guides/aws/event-handlers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ nav:

# Configuring Real-Time events

<div className="alert alert-warning">
This section details the steps required to set up AWS Event Handlers.
</div>
In this guide, you will:

- Set up AWS Event Handlers.
- Monitor the setup process and troubleshoot any errors.

The Guardrails **Event Handlers** are responsible for conveying events from AWS
CloudTrail back to Guardrails for processing. This is a requirement for Guardrails to
Expand Down Expand Up @@ -57,8 +58,8 @@ These mods are required only if using Guardrails to configure CloudTrail.

## Configuring CloudTrail

<div className="alert alert-warning"> <strong>You are not required to use the Guardrails Audit Trail</strong> to configure CloudTrail, but <strong>there must be a CloudTrail configured in each region or a global trail.</strong>
</div>
> [!WARNING]
> You are not required to use the Guardrails Audit Trail to configure CloudTrail, but there must be a CloudTrail configured in each region or a global trail.

The [Guardrails Audit Trail](/guardrails/docs/mods/aws/aws/policy#aws--turbot--audit-trail)
policy provides a convenient mechanism for setting up CloudTrail in AWS
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/aws/import-aws-account/gov-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ create a user and a role using AWS IAM.
}
```

- If you wish to take advantage of every AWS integration offered by Guardrails
- If you wish to take advantage of every AWS integration offered by Guardrails
(recommended), attach the Amazon Managed AdministratorAccess Policy to the
Role:
- `arn:aws:iam::aws:policy/AdministratorAccess`
Expand Down Expand Up @@ -92,8 +92,8 @@ Recommended Mods:

While you can import an AWS account at the Turbot level, it is recommended that
you import accounts into Guardrails Folders, as it provides greater flexibility and
ease of management.
Define a [Folder hierarchy](getting-started/configure_workspace) prior to import.
ease of management.
Define a [Folder hierarchy](/guardrails/docs/concepts/resources/hierarchy) prior to import.

#### Importing the account via Terraform

Expand Down
26 changes: 15 additions & 11 deletions docs/guides/aws/import-aws-account/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ nav:

# Importing an AWS account into Guardrails

<div className="alert alert-warning">
This section details the steps required to import an AWS Account into a Guardrails Folder.
</div>
In this guide, you will:

- Import an AWS Account into a Guardrails Folder.


## Overview

Expand All @@ -34,8 +35,8 @@ Consider that Turbot Guardrails is hosted only in AWS commercial accounts. There
- To import
[AWS China or AWS GovCloud accounts](guides/aws/import-aws-account/gov-cloud) requires hosting of guardrails in the same partition as those account or using access keys for each account outside of the current AWS Partition.

<div className="alert alert-info" role="alert"><b>NOTICE</b>: Free Tier AWS accounts cannot be used with Guardrails. If this is attempted, Guardrails will fail to properly discover resources in the account and will generate errors in the Guardrails console.
</div>
> [!IMPORTANT]
> Free Tier AWS accounts cannot be used with Guardrails. If this is attempted, Guardrails will fail to properly discover resources in the account and will generate errors in the Guardrails console.

## Prerequisites to import AWS Commercial Account

Expand Down Expand Up @@ -108,10 +109,12 @@ conforms to your requirements.
- SNS topics and subscriptions matching:
- `arn:aws:sns:*:${AccountId}:turbot_aws_api_handler`
- `arn:aws:sns:*:${AccountId}:turbot_aws_api_handler:*`
- Note that the default resource prefix is `turbot_`. If changes are
> [!NOTE]
> The default resource prefix is `turbot_`. If changes are
made to the "Event Rule Name Prefix" or "SNS Topic Name Prefix"
policies, then the IAM policy must be updated to match. This is an
uncommon requirement. See policy details below.

- [AWS > Turbot > Event Handlers > Events > Rules > Name Prefix](/guardrails/docs/mods/aws/aws/policy#aws--turbot--event-handlers--events--rules--name-prefix)
- [AWS > Turbot > Event Handlers > SNS > Topic > Name Prefix](/guardrails/docs/mods/aws/aws/policy#aws--turbot--event-handlers--sns--topic--name-prefix)
- Adjust the partition from `aws` to `aws-us-gov` and `aws-cn` as
Expand Down Expand Up @@ -220,7 +223,7 @@ Parameters:
Type: String
Default: "/"
Description: >
The IAM path to use for all IAM roles created in this stack.
The IAM path to use for all IAM roles created in this stack.
The path must either be a single forward slash "/" or
alphanumeric characters with starting and ending forward slashes "/my-path/".
GuardrailsSaaSAccountId:
Expand Down Expand Up @@ -325,12 +328,12 @@ Outputs:
Description: "ARN of the Guardrails IAM role"
Value: !GetAtt GuardrailsAccessRole.Arn
Export:
Name: "GuardrailsAccessRoleArn"
Name: "GuardrailsAccessRoleArn"
AccessRoleExternalIdOutput:
Description: "External ID used in the Access Role"
Value: !Ref AccessRoleExternalId
Export:
Name: "AccessRoleExternalId"
Name: "AccessRoleExternalId"
```

#### Full AdministratorAccess
Expand Down Expand Up @@ -555,7 +558,7 @@ Recommended Mods (in order of installation):

Importing accounts into Folders offers increased flexibility and easier
management over importing directly under the Turbot level. Define a
[Folder hierarchy](getting-started/configure_workspace) prior to import.
[Folder hierarchy](/guardrails/docs/concepts/resources/hierarchy) prior to import.

#### Importing the account via the Guardrails Console

Expand Down Expand Up @@ -676,7 +679,8 @@ integrating Guardrails into account onboarding pipelines.
script with this filter:
`--filter "resourceId:'<ARNofAccount>' controlTypeId:'tmod:@turbot/aws#/control/types/eventHandlers','tmod:@turbot/aws-sns#/control/types/topicConfigured','tmod:@turbot/aws-sns#/control/types/subscriptionConfigured','tmod:@turbot/aws-event#s/control/types/targetConfigured','tmod:@turbot/aws-events#/control/types/ruleConfigured' state:tbd,error,invalid"`

Note that Terraform cannot verify anything beyond the existence and
> [!NOTE]
> Terraform cannot verify anything beyond the existence and
configuration of the Account resource in Turbot, along with the Turbot IAM role
and External ID policies. Fully automated, lights-out account import requires
additional verification steps after import.
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/aws/services/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ nav:
order: 30
---

# Enabling AWS Services in Guardrails
# Enabling AWS Services in Guardrails

<div className="alert alert-warning">
This section details the steps required to enable services for an AWS Account. Alternatively, you can use the <a href="https://github.com/turbot/guardrails-samples/tree/main/baselines/aws/aws_service_enabled">aws_services</a> baseline which automates this process.
</div>
In this guide, you will:

- Enable service(s) for an AWS Account. Alternatively, you can use the <a href="https://github.com/turbot/guardrails-samples/tree/main/baselines/aws/aws_service_enabled">aws_services</a> baseline which automates this process.

All supported services have an Enabled policy.

Expand Down
5 changes: 2 additions & 3 deletions docs/guides/gcp/import-gcp-project/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ nav:

# Import a GCP Project into Guardrails

<div className="alert alert-warning">
This section details the steps required to import Google Cloud Platform resources into a Guardrails Folder.
</div>
> [!IMPORTANT]
> This section details the steps required to import Google Cloud Platform resources into a Guardrails Folder.

## Process Overview

Expand Down
Loading