Skip to content

Commit

Permalink
[RELEASE REVIEW]Add/update guides for release (#97)
Browse files Browse the repository at this point in the history
* Add runbooks for TEF, TED & TE instaall and update

* Update nav bar

* Adjusting to the folder name from update-workspace-te-version to update-workspace

* Remove old files

* Migrated getting-started with AWS, Azure and GCP with image path changes to render properly

* Updates to remove unused nav bar items

* Updates

* add pre-installation steps

* Add Getting Started with AWS in Guardrails index page

* Updated Getting Started AWS/Azure/GCP section index page with tabular navigation
Update the nav sidebar_label
Update section in  Prerequisites - content shift

* Removed /runbooks/ path with /getting-started/ to fix navigation
Fixed runbook word references across getting started

* Update

* Update path reference of/runbooks/

* Updates to AWS getting started

* Clean work runbook references to guide

* Removal of runbooks references

* Adjust the Installation section nav bar sequence

* Add DB Instance Not in Available State & Enable Verbose Logging

* update getting-started-aws (#101)

* update aws-getting-started (#102)

* add glossary links (#103)

* Update content in Connect an AWS Account to Guardrails

* Draft code for Install TEF - Using Guardrail's VPC & Existing VPC

* Updates

* aws-getting-started-with-raj-revisions-new-images-and-checkbox-tracker (#109)

* aws-getting-started-with-raj-revisions-new-images-and-checkbox-tracker

* update aws-getting-started first 2 guides

* aws-getting-started-strip-comments (#110)

* Add updated content for install tef with create new vpc

* more aws image tweaks (#111)

* Revise aws getting started (#112)

* revise-aws-getting-started

* revise image

* revise images and caution

* add annotations

* revise observe-aws-activity (#114)

* revise-aws-getting-started-3 (#115)

* Add > Guide > Delete TE, Install Mod and Importing a Portfolio (#105)

* fix callouts

* fix callouts

* Updates

* Options for Progress Tracker

* Add Install TEF into Existing VPC

* revise aws getting started 5 (#117)

* revise aws getting started (#118)

* a-g-s 7 (#119)

* ags 9 (#120)

* a g s 11 (#121)

* a-g-s-12 (#122)

* Add > Troubleshooting > Mod Dependency guides (#116)

* Updates to sidebar to adjust mod related guides in configuring guardrails section

* Fix code for CAUTION

* Update Install TEF section to add CFN Termination protection and rename the folders inline with nav bar title

* Minor update in index.md

* Add Create Workspace & Login Workspace (#123)

* Add Create Workspace

* update the format

* fix formating

* Update with additional content, formatting adjusted for images

* Add Workspace Login new guide

* Link the workspace login in create workspace step7

* Remove unwanted images

* Update image

---------

Co-authored-by: raj <[email protected]>

* Update steps for Enable Termination Protection

* Update > Images in Install Mod,  Update Mod and add Uninstall Mod (#124)

* Continue aws getting started 1 (#126)

* calc exception tweaks

* finish aws series again

* tweaks

* Adjusting sidebar.json to locate correctly the path of mod related guides to Configuring Guardrails, altered the folder name of mod-cleanup to align nav bar mod-lambda-cleanup

* Fix image path changes

* Fix [!CAUTION] section in Connect an AWS Account to Guardrails

* tweaks (#129)

* Add Auto mod update schedule (#130)

* review-getting-started-gcp-1 (#131)

* review-getting-started-gcp-2 (#132)

* review-getting-started-gcp-3 (#133)

* fix-aws-caution-and-progress-image (#134)

* aws-and-gcp-static-exception (#135)

* aws-and-gcp-calc-exception (#136)

* Aws and gcp send alert (#137)

* fix aws calc policy title

* aws-and-gcp-send-alert

* aws-and-gcp-send-alert-2 (#138)

* Add Critical Alarms for TED and TE (#127)

Co-authored-by: raj <[email protected]>
Co-authored-by: Jon Udell <[email protected]>

* Gcp connect project (#142)

* add event handlers

* minor fixes

* More getting started updates (#143)

* update-send-alert

* regen aws

* caution -> note

* more-getting-started (#144)

* update-aws-gcp-getting-started (#145)

* more tweaks (#146)

* update index pages (#147)

* Aws gcp getting started 1 (#148)

* fix image ref

* aws-gcp-getting-started-1

* update enable-policy-pack (#149)

* Aws gcp getting started 3 (#150)

* account-wide

* static-exception

* calc-exception

* send-alert

* quick-action

* enable-enforcement

* Add guides monitoring (#141)

* Add Monitoring section(#151)

* Update monitoring section images paths to render the images correctly

* Update content docs/guides/hosting-guardrails/monitoring/index.md

* Formatting updates

* Update monitoring index.md

* Update docs/guides/configuring-guardrails/index.md

* Update broken links in docs/guides/hosting-guardrails/updating-stacks/index.md and arrange sidebar.json updating-stacks order

* Updates to format and broken links in index pages

* gcp-send-email (#152)

* gcp-send-email

* gcp-send-email

* aws-gcp-send-email (#154)

* Azure connect (#155)

* azure connect

* update-index-files

* aws-connect (#156)

* remove-bogus-subheads (#157)

* aws-connect (#158)

* Aws getting started (#160)

* aws-observe-activity-formatting

* more-aws-getting-started-tweaks

* more-aws-getting-started (#161)

* fix crop (#162)

* Update annotation in #step-5-copy-the-role-arn

* add revised architecture docs (#159)

* Remove
docs/getting-started/activity-exceptions.md
docs/getting-started/imports-and-reports.md
docs/getting-started/next.md
docs/getting-started/policy-management.md
docs/getting-started/search-and-visualize.md

* Update broken link at docs/guides/hosting-guardrails/monitoring/index.md

* tweaks (#163)

* Update aws and gcp (#164)

* update-aws-and-gcp

* update-aws-and-gcp

* sidebar-labels-and-sidebar-json (#165)

* sidebar-labels-and-sidebar-json

* restore enable-policy-pack image

* remove getting started guides from this branch

* Update Guardrails sample repo reference

* Applicable changes from https://github.com/turbot/guardrails-samples/tree/master/ to https://github.com/turbot/guardrails-samples/tree/main/ on specific matching directories in the guardrails sample

* Reference changes of guardrails sample repo

* Updates to broken image paths and cleanup

* Updates & cleanup

* Additional index page content.

---------

Co-authored-by: David Boeke <[email protected]>
Co-authored-by: Jon Udell <[email protected]>
Co-authored-by: Rahul Srivastav <[email protected]>
Co-authored-by: Karan Popat <[email protected]>
Co-authored-by: Venu <[email protected]>
  • Loading branch information
6 people authored Oct 17, 2024
1 parent 49f57d8 commit b50af84
Show file tree
Hide file tree
Showing 360 changed files with 3,923 additions and 1,467 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/policies/calculated-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,6 @@ terraform resource definition in the calculated policy template:
## Additional Reading

- [Calculated Policy 7 minute lab](7-minute-labs/calc-policy)
- [Guardrails Samples Repo with calculated policy examples](https://github.com/turbot/guardrails-samples/tree/master/calculated_policies)
- [Guardrails Samples Repo with calculated policy examples](https://github.com/turbot/guardrails-samples/tree/main/calculated_policies)
- [Policies concepts page](concepts/policies)
- [Azure resource tagging example with calculated policies and Terraform](guides/managing-policies/config-examples/azure-tags)
8 changes: 4 additions & 4 deletions docs/concepts/policies/taxonomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,12 +244,12 @@ Notes:
- GraphQL permits multiple `resources()` queries when they have labels. The
`trails:` label shows how this is done.
- A full example can be found in the
[Guardrails Samples Repo](https://github.com/turbot/guardrails-samples/tree/master/calculated_policies/aws_s3_approved_static_website_hosting_requires_cloud_front).
[Guardrails Samples Repo](https://github.com/turbot/guardrails-samples/blob/main/policy_packs/aws/ec2/enforce_encryption_at_rest_is_enabled_for_ebs_volumes/README.md).

## Additional Information

- [Calculated Policy 7 minute lab](7-minute-labs/calc-policy)
- [Guardrails Samples Repo with calculated policy examples](https://github.com/turbot/guardrails-samples/tree/master/calculated_policies)
- [Guardrails Samples Repo with calculated policy examples](https://github.com/turbot/guardrails-samples/tree/main/policy_packs)
- [Policies concepts page](concepts/policies)
- [Azure resource tagging example with calculated policies and Terraform](guides/managing-policies/config-examples/azure-tags)
- [Calculated Policy FAQ](calculated-faq)
- [AWS resource tagging example with calculated policies and Terraform](https://github.com/turbot/guardrails-samples/tree/main/policy_packs/aws/ec2/enforce_instances_use_amis_with_approved_tags)
- [Calculated Policy FAQ](/guardrails/docs/concepts/policies/calculated-faq)
6 changes: 3 additions & 3 deletions docs/faq/general-faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ sure to keep an eye out for new mod versions!
Install `firehose-aws-sns` mod on your workspace and a service user for the
email. Refer to the [Guardrails Firehose](guides/firehose) guide for more
information. A full configuration script can be found in the
[Guardrails Samples](https://github.com/turbot/guardrails-samples/tree/master/mod_examples/firehose-aws-sns/setup/terraform).
[Guardrails Samples](https://github.com/turbot/guardrails-samples/tree/main/mod_examples/firehose-aws-sns/setup/terraform).

## Is there a way to create a Guardrails File in the console?

Expand Down Expand Up @@ -226,7 +226,7 @@ Yes! This can be accomplished by a GraphQL query or
and [AwsCredentials](reference/graphql/object/AwsCredentials) information,
Guardrails will respond with an access and secret access key. This can be done via a
preferred scripting language - you can find additional scripting examples on our
[Guardrails Samples](https://github.com/turbot/guardrails-samples/tree/master/api_examples).
[Guardrails Samples](https://github.com/turbot/guardrails-samples/tree/main/api_examples).

Refer to
[AWS IAM documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html)
Expand Down Expand Up @@ -367,7 +367,7 @@ In rare circumstances, attempting to delete an AWS account can result in a
timeout. This is usually due to a large amount of resources within an account.
To delete large accounts, a delete account script lives in the Guardrails Samples Repo.

- [Guardrails AWS account delete script](https://github.com/turbot/guardrails-samples/tree/master/guardrails-utilities/python-utils/remove_aws_account)
- [Guardrails AWS account delete script](https://github.com/turbot/guardrails-samples/tree/main/guardrails-utilities/python-utils/remove_aws_account)

Be sure to change the Guardrails data resource `deleteThisAwsAccount` id value to
the arn of the account that must be deleted.
Expand Down
5 changes: 1 addition & 4 deletions docs/faq/terraform-faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,9 @@ resource "turbot_folder" "test_folder_multi_aka" {

You can find lots of examples on our Guardrails Samples Repo.

- [Control Objectives](https://github.com/turbot/guardrails-samples/tree/master/control_objectives)
- [Policy Packs](https://github.com/turbot/guardrails-samples/tree/main/policy_packs)
are often trivial policies for compliance requirements such as limited S3
public access.
- [Calculated Policies](https://github.com/turbot/guardrails-samples/tree/master/calculated_policies)
are generally more complex. These combine
[Guardrails Calculated Policies](concepts/policies/calculated-faq) with Terraform.

## Which Terraform versions does Guardrails support?

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/7-minute-labs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Written profile 'default' to '/Users/TestUser/.config/turbot/credentials.yml'

This command will generate a `default` profile and add it to your Turbot Guardrails
credentials file. The Turbot Guardrails Terraform provider and
[scripts in the Guardrails Samples Repo](https://github.com/turbot/guardrails-samples/tree/master/api_examples)
[scripts in the Guardrails Samples Repo](https://github.com/turbot/guardrails-samples/tree/main/api_examples)
can use the Turbot Guardrails CLI credentials file.

### Login
Expand Down
112 changes: 0 additions & 112 deletions docs/getting-started/activity-exceptions.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/getting-started/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Guardrails offers a fully functional trial. However, Guardrails is a large platf

## Are there any default or pre-configured settings in the environment?

As part of your onboarding form we ask which regions, cloud services, and cloud providers you will be starting with. Guardrails pre-configures the workspace with the appropriate Guardrails mods (for various services) and regions for the event handlers (Guardrails' mechanism for receiving real time events from the cloud). Guardrails also onboards the [getting started policy baselines](https://github.com/turbot/guardrails-samples/tree/master/baselines/getting_started) in check mode. These can be adjusted as needed during the free trial.
As part of your onboarding form we ask which regions, cloud services, and cloud providers you will be starting with. Guardrails pre-configures the workspace with the appropriate Guardrails mods (for various services) and regions for the event handlers (Guardrails' mechanism for receiving real time events from the cloud). Guardrails also onboards the [getting started policy baselines](https://github.com/turbot/guardrails-samples/tree/main/baselines/) in check mode. These can be adjusted as needed during the free trial.

## Can I extend my free trial?

Expand Down
Loading

0 comments on commit b50af84

Please sign in to comment.