Skip to content

Commit fec5106

Browse files
milldrosterman
andauthored
Replace Admonition Style (#1092)
Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]>
1 parent 27be807 commit fec5106

File tree

17 files changed

+242
-283
lines changed

17 files changed

+242
-283
lines changed

deprecated/eks/karpenter-provisioner/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Component: `eks/karpenter-provisioner`
22

3-
:::warning This component is DEPRECATED
4-
5-
With v1beta1 of Karpenter, the `provisioner` component is deprecated.
6-
Please use the `eks/karpenter-node-group` component instead.
7-
8-
For more details, see the [Karpenter v1beta1 release notes](/modules/eks/karpenter/CHANGELOG.md).
9-
10-
:::
3+
> [!WARNING]
4+
>
5+
> #### This component is DEPRECATED
6+
>
7+
> With v1beta1 of Karpenter, the `provisioner` component is deprecated.
8+
> Please use the `eks/karpenter-node-group` component instead.
9+
>
10+
> For more details, see the [Karpenter v1beta1 release notes](/modules/eks/karpenter/CHANGELOG.md).
1111
1212
This component deploys [Karpenter provisioners](https://karpenter.sh/v0.18.0/aws/provisioning) on an EKS cluster.
1313

modules/account/README.md

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@ This component is responsible for provisioning the full account hierarchy along
44
includes the ability to associate Service Control Policies (SCPs) to the Organization, each Organizational Unit and
55
account.
66

7-
:::info
8-
9-
Part of a
10-
[cold start](https://docs.cloudposse.com/reference-architecture/how-to-guides/implementation/enterprise/implement-aws-cold-start)
11-
so it has to be initially run with `SuperAdmin` role.
12-
13-
:::
7+
> [!NOTE]
8+
>
9+
> Part of a
10+
> [cold start](https://docs.cloudposse.com/reference-architecture/how-to-guides/implementation/enterprise/implement-aws-cold-start)
11+
> so it has to be initially run with `SuperAdmin` role.
1412
1513
In addition, it enables
1614
[AWS IAM Access Analyzer](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html), which helps
@@ -178,15 +176,13 @@ SuperAdmin) credentials you have saved in 1Password.
178176

179177
#### Request an increase in the maximum number of accounts allowed
180178

181-
:::caution
182-
183-
Make sure your support plan for the _root_ account was upgraded to the "Business" level (or Higher). This is necessary
184-
to expedite the quota increase requests, which could take several days on a basic support plan. Without it, AWS support
185-
will claim that since we’re not currently utilizing any of the resources, so they do not want to approve the requests.
186-
AWS support is not aware of your other organization. If AWS still gives you problems, please escalate to your AWS TAM.
187-
See [AWS](https://docs.cloudposse.com/reference-architecture/reference/aws).
188-
189-
:::
179+
> [!WARNING]
180+
>
181+
> Make sure your support plan for the _root_ account was upgraded to the "Business" level (or Higher). This is necessary
182+
> to expedite the quota increase requests, which could take several days on a basic support plan. Without it, AWS
183+
> support will claim that since we’re not currently utilizing any of the resources, so they do not want to approve the
184+
> requests. AWS support is not aware of your other organization. If AWS still gives you problems, please escalate to
185+
> your AWS TAM. See [AWS](https://docs.cloudposse.com/reference-architecture/reference/aws).
190186

191187
1. From the region list, select "US East (N. Virginia) us-east-1".
192188

@@ -318,21 +314,19 @@ atmos terraform import account --stack core-gbl-root 'aws_organizations_organiza
318314
AWS accounts and organizational units are generated dynamically by the `terraform/account` component using the
319315
configuration in the `gbl-root` stack.
320316
321-
:::info _**Special note:**_
322-
323-
In the rare case where you will need to be enabling non-default AWS Regions, temporarily comment out the
324-
`DenyRootAccountAccess` service control policy setting in `gbl-root.yaml`. You will restore it later, after enabling the
325-
optional Regions. See related:
326-
[Decide on Opting Into Non-default Regions](https://docs.cloudposse.com/reference-architecture/design-decisions/cold-start/decide-on-opting-into-non-default-regions)
327-
328-
:::
329-
330-
:::caution You must wait until your quota increase request has been granted
331-
332-
If you try to create the accounts before the quota increase is granted, you can expect to see failures like
333-
`ACCOUNT_NUMBER_LIMIT_EXCEEDED`.
334-
335-
:::
317+
> [!IMPORTANT]
318+
>
319+
> In the rare case where you will need to be enabling non-default AWS Regions, temporarily comment out the
320+
> `DenyRootAccountAccess` service control policy setting in `gbl-root.yaml`. You will restore it later, after enabling
321+
> the optional Regions. See related:
322+
> [Decide on Opting Into Non-default Regions](https://docs.cloudposse.com/reference-architecture/design-decisions/cold-start/decide-on-opting-into-non-default-regions)
323+
324+
> [!TIP]
325+
>
326+
> #### You must wait until your quota increase request has been granted
327+
>
328+
> If you try to create the accounts before the quota increase is granted, you can expect to see failures like
329+
> `ACCOUNT_NUMBER_LIMIT_EXCEEDED`.
336330
337331
In the Geodesic shell, execute the following commands to provision AWS Organizational Units and AWS accounts:
338332

modules/auth0/tenant/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ in Terraform. Follow the
4242
[Auth0 provider documentation](https://registry.terraform.io/providers/auth0/auth0/latest/docs/guides/quickstart) to
4343
create a Machine to Machine application.
4444
45-
:::tip Machine to Machine App Name
46-
47-
Use the Context Label format for the machine name for consistency. For example, `acme-plat-gbl-prod-auth0-provider`.
48-
49-
:::
45+
> [!TIP]
46+
>
47+
> #### Machine to Machine App Name
48+
>
49+
> Use the Context Label format for the machine name for consistency. For example, `acme-plat-gbl-prod-auth0-provider`.
5050

5151
After creating the Machine to Machine application, add the app's domain, client ID, and client secret to AWS Systems
5252
Manager Parameter Store in the same account and region as this component deployment. The path for the parameters are

modules/aws-config/README.md

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,25 @@ Some of the key features of AWS Config include:
2020
- Notifications and alerts: AWS Config can send notifications and alerts when changes are made to your AWS resources
2121
that could impact their compliance or security posture.
2222

23-
:::caution AWS Config Limitations
24-
25-
You'll also want to be aware of some limitations with AWS Config:
26-
27-
- The maximum number of AWS Config rules that can be evaluated in a single account is 1000.
28-
- This can be mitigated by removing rules that are duplicated across packs. You'll have to manually search for these
29-
duplicates.
30-
- You can also look for rules that do not apply to any resources and remove those. You'll have to manually click
31-
through rules in the AWS Config interface to see which rules are not being evaluated.
32-
- If you end up still needing more than 1000 rules, one recommendation is to only run packs on a schedule with a
33-
lambda that removes the pack after results are collected. If you had different schedule for each day of the week,
34-
that would mean 7000 rules over the week. The aggregators would not be able to handle this, so you would need to
35-
make sure to store them somewhere else (i.e. S3) so the findings are not lost.
36-
- See the
37-
[Audit Manager docs](https://aws.amazon.com/blogs/mt/integrate-across-the-three-lines-model-part-2-transform-aws-config-conformance-packs-into-aws-audit-manager-assessments/)
38-
if you think you would like to convert conformance packs to custom Audit Manager assessments.
39-
- The maximum number of AWS Config conformance packs that can be created in a single account is 50.
40-
41-
:::
23+
> [!WARNING]
24+
>
25+
> #### AWS Config Limitations
26+
>
27+
> You'll also want to be aware of some limitations with AWS Config:
28+
>
29+
> - The maximum number of AWS Config rules that can be evaluated in a single account is 1000.
30+
> - This can be mitigated by removing rules that are duplicated across packs. You'll have to manually search for these
31+
> duplicates.
32+
> - You can also look for rules that do not apply to any resources and remove those. You'll have to manually click
33+
> through rules in the AWS Config interface to see which rules are not being evaluated.
34+
> - If you end up still needing more than 1000 rules, one recommendation is to only run packs on a schedule with a
35+
> lambda that removes the pack after results are collected. If you had different schedule for each day of the week,
36+
> that would mean 7000 rules over the week. The aggregators would not be able to handle this, so you would need to
37+
> make sure to store them somewhere else (i.e. S3) so the findings are not lost.
38+
> - See the
39+
> [Audit Manager docs](https://aws.amazon.com/blogs/mt/integrate-across-the-three-lines-model-part-2-transform-aws-config-conformance-packs-into-aws-audit-manager-assessments/)
40+
> if you think you would like to convert conformance packs to custom Audit Manager assessments.
41+
> - The maximum number of AWS Config conformance packs that can be created in a single account is 50.
4242
4343
Overall, AWS Config provides you with a powerful toolset to help you monitor and manage the configurations of your AWS
4444
resources, ensuring that they remain compliant, secure, and properly configured over time.
@@ -79,21 +79,22 @@ Before deploying this AWS Config component `config-bucket` and `cloudtrail-bucke
7979
This component has a `default_scope` variable for configuring if it will be an organization-wide or account-level
8080
component by default. Note that this can be overridden by the `scope` variable in the `conformance_packs` items.
8181

82-
:::info Using the account default_scope
83-
84-
If default_scope == `account`, AWS Config is regional AWS service, so this component needs to be deployed to all
85-
regions. If an individual `conformance_packs` item has `scope` set to `organization`, that particular pack will be
86-
deployed to the organization level.
87-
88-
:::
89-
90-
:::info Using the organization default_scope
91-
92-
If default_scope == `organization`, AWS Config is global unless overriden in the `conformance_packs` items. You will
93-
need to update your org to allow the `config-multiaccountsetup.amazonaws.com` service access principal for this to work.
94-
If you are using our `account` component, just add that principal to the `aws_service_access_principals` variable.
95-
96-
:::
82+
> [!TIP]
83+
>
84+
> #### Using the account default_scope
85+
>
86+
> If default_scope == `account`, AWS Config is regional AWS service, so this component needs to be deployed to all
87+
> regions. If an individual `conformance_packs` item has `scope` set to `organization`, that particular pack will be
88+
> deployed to the organization level.
89+
90+
> [!TIP]
91+
>
92+
> #### Using the organization default_scope
93+
>
94+
> If default_scope == `organization`, AWS Config is global unless overriden in the `conformance_packs` items. You will
95+
> need to update your org to allow the `config-multiaccountsetup.amazonaws.com` service access principal for this to
96+
> work. If you are using our `account` component, just add that principal to the `aws_service_access_principals`
97+
> variable.
9798
9899
At the AWS Organizational level, the Components designate an account to be the `central collection account` and a single
99100
region to be the `central collection region` so that compliance information can be aggregated into a central location.

modules/aws-sso/README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,12 @@ recommended `gbl-root` stack.
3232

3333
### Google Workspace
3434

35-
:::important
36-
37-
> Your identity source is currently configured as 'External identity provider'. To add new groups or edit their
38-
> memberships, you must do this using your external identity provider.
39-
40-
Groups _cannot_ be created with ClickOps in the AWS console and instead must be created with AWS API.
41-
42-
:::
35+
> [!IMPORTANT]
36+
>
37+
> > Your identity source is currently configured as 'External identity provider'. To add new groups or edit their
38+
> > memberships, you must do this using your external identity provider.
39+
>
40+
> Groups _cannot_ be created with ClickOps in the AWS console and instead must be created with AWS API.
4341
4442
Google Workspace is now supported by AWS Identity Center, but Group creation is not automatically handled. After
4543
[configuring SAML and SCIM with Google Workspace and IAM Identity Center following the AWS documentation](https://docs.aws.amazon.com/singlesignon/latest/userguide/gs-gwp.html),

modules/dns-primary/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,10 @@ components:
9393
YourVeryLongStringGoesHere
9494
```
9595

96-
:::info
97-
98-
Use the [acm](https://docs.cloudposse.com/components/library/aws/acm) component for more advanced certificate
99-
requirements.
100-
101-
:::
96+
> [!TIP]
97+
>
98+
> Use the [acm](https://docs.cloudposse.com/components/library/aws/acm) component for more advanced certificate
99+
> requirements.
102100
103101
<!-- prettier-ignore-start -->
104102
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

modules/ecr/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,10 @@ This utilizes
66
to assign accounts to various roles. It is also compatible with the
77
[GitHub Actions IAM Role mixin](https://github.com/cloudposse/terraform-aws-components/blob/master/mixins/github-actions-iam-role/README-github-action-iam-role.md).
88

9-
:::caution
10-
11-
Older versions of our reference architecture have an`eks-iam` component that needs to be updated to provide sufficient
12-
IAM roles to allow pods to pull from ECR repos
13-
14-
:::
9+
> [!WARNING]
10+
>
11+
> Older versions of our reference architecture have an`eks-iam` component that needs to be updated to provide sufficient
12+
> IAM roles to allow pods to pull from ECR repos
1513
1614
## Usage
1715

modules/eks/actions-runner-controller/CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,12 @@ of memory allocated to the runner Pod to account for this. This is generally not
7676
small enough amount of disk space that it can be reasonably stored in the RAM allocated to a single CPU in an EC2
7777
instance, so it is the CPU that remains the limiting factor in how many Runners can be run on an instance.
7878

79-
:::warning You must configure a memory request for the runner Pod
80-
81-
When using `tmpfs_enabled`, you must configure a memory request for the runner Pod. If you do not, a single Pod would be
82-
allowed to consume half the Node's memory just for its disk storage.
83-
84-
:::
79+
> [!WARNING]
80+
>
81+
> #### You must configure a memory request for the runner Pod
82+
>
83+
> When using `tmpfs_enabled`, you must configure a memory request for the runner Pod. If you do not, a single Pod would
84+
> be allowed to consume half the Node's memory just for its disk storage.
8585
8686
#### Configure startup timeout via `wait_for_docker_seconds`
8787

modules/eks/cluster/CHANGELOG.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ Components PR [#1033](https://github.com/cloudposse/terraform-aws-components/pul
4949

5050
### Major Breaking Changes
5151

52-
:::warning Major Breaking Changes, Manual Intervention Required
53-
54-
This release includes a major breaking change that requires manual intervention to migrate existing clusters. The change
55-
is necessary to support the new AWS Access Control API, which is more secure and more reliable than the old `aws-auth`
56-
ConfigMap.
57-
58-
:::
52+
> [!WARNING]
53+
>
54+
> #### Major Breaking Changes, Manual Intervention Required
55+
>
56+
> This release includes a major breaking change that requires manual intervention to migrate existing clusters. The
57+
> change is necessary to support the new AWS Access Control API, which is more secure and more reliable than the old
58+
> `aws-auth` ConfigMap.
5959
6060
This release drops support for the `aws-auth` ConfigMap and switches to managing access control with the new AWS Access
6161
Control API. This change allows for more secure and reliable access control, and removes the requirement that Terraform
@@ -65,18 +65,18 @@ In this release, this component only supports assigning "team roles" to Kubernet
6565
Access Policies is not yet implemented. However, if you specify `system:masters` as a group, that will be translated
6666
into assigning the `AmazonEKSClusterAdminPolicy` to the role. Any other `system:*` group will cause an error.
6767

68-
:::tip Network Access Considerations
69-
70-
Previously, this component required network access to the EKS control plane to manage the `aws-auth` ConfigMap. This
71-
meant having the EKS control plane accessible from the public internet, or using a bastion host or VPN to access the
72-
control plane. With the new AWS Access Control API, Terraform operations on the EKS cluster no longer require network
73-
access to the EKS control plane.
74-
75-
This may seem like it makes it easier to secure the EKS control plane, but Terraform users will still require network
76-
access to the EKS control plane to manage any deployments or other Kubernetes resources in the cluster. This means that
77-
this upgrade does not substantially change the need for network access.
78-
79-
:::
68+
> [!TIP]
69+
>
70+
> #### Network Access Considerations
71+
>
72+
> Previously, this component required network access to the EKS control plane to manage the `aws-auth` ConfigMap. This
73+
> meant having the EKS control plane accessible from the public internet, or using a bastion host or VPN to access the
74+
> control plane. With the new AWS Access Control API, Terraform operations on the EKS cluster no longer require network
75+
> access to the EKS control plane.
76+
>
77+
> This may seem like it makes it easier to secure the EKS control plane, but Terraform users will still require network
78+
> access to the EKS control plane to manage any deployments or other Kubernetes resources in the cluster. This means
79+
> that this upgrade does not substantially change the need for network access.
8080
8181
### Minor Changes
8282

@@ -94,12 +94,10 @@ Full details of the migration process can be found in the `cloudposse/terraform-
9494
[migration document](https://github.com/cloudposse/terraform-aws-eks-cluster/blob/main/docs/migration-v3-v4.md). This
9595
section is a streamlined version for users of this `eks/cluster` component.
9696

97-
:::important
98-
99-
The commands below assume the component is named "eks/cluster". If you are using a different name, replace "eks/cluster"
100-
with the correct component name.
101-
102-
:::
97+
> [!IMPORTANT]
98+
>
99+
> The commands below assume the component is named "eks/cluster". If you are using a different name, replace
100+
> "eks/cluster" with the correct component name.
103101
104102
#### Prepare for Migration
105103

0 commit comments

Comments
 (0)