Skip to content

Commit

Permalink
fixed steps
Browse files Browse the repository at this point in the history
  • Loading branch information
milldr committed Aug 9, 2024
1 parent d591be8 commit 3a35378
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 50 deletions.
36 changes: 8 additions & 28 deletions docs/layers/eks/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ sidebar_label: FAQ
sidebar_position: 100
---
import Intro from '@site/src/components/Intro';
import Step from '@site/src/components/Step';
import StepNumber from '@site/src/components/StepNumber';
import Steps from '@site/src/components/Steps';

<Intro>
Frequently asked questions about EKS with Cloud Posse's reference architecture.
Expand All @@ -21,32 +20,13 @@ Kubernetes Secrets within the cluster. Per the operator pattern, the `external-s

## How does the `alb-controller-ingress-group` determine the name of the ALB?

<Step>
<StepNumber/> Null Label ID
First the component uses the [null-label](/modules/library/null/label) module to generate our intended name. We do this to meet the character length
restrictions on ALB names.
[ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L75-L83)
</Step>
<Step>
<StepNumber/> Kubernetes Ingress Annotation
Then we pass that output to the Kubernetes Ingress resource with an annotation intended to define the ALB's name.
[ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L98)
</Step>
<Step>
<StepNumber/> ALB Creation with Dynamic Suffix
Now the Ingress is created and `alb-controller` creates an ALB using the annotations on that `Ingress`. This ALB name
will have a dynamic character sequence at the end of it, so we cannot know what the name will be ahead of time.
</Step>
<Step>
<StepNumber/> Data Resource
Finally, we grab the actual name that is given to the created ALB with the `data.aws_lb` resources.
[ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L169)
</Step>
<Step>
<StepNumber/> Terraform Output
Then output that name for future reference.
[ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L36)
</Step>
<Steps>
1. First the component uses the [null-label](/modules/library/null/label) module to generate our intended name. We do this to meet the character length restrictions on ALB names. [ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L75-L83)
1. Then we pass that output to the Kubernetes Ingress resource with an annotation intended to define the ALB's name. [ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L98)
1. Now the Ingress is created and `alb-controller` creates an ALB using the annotations on that `Ingress`. This ALB name will have a dynamic character sequence at the end of it, so we cannot know what the name will be ahead of time.
1. Finally, we grab the actual name that is given to the created ALB with the `data.aws_lb` resources. [ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L169)
1. Then output that name for future reference. [ref](https://github.com/cloudposse/terraform-aws-components/blob/master/modules/eks/alb-controller-ingress-group/main.tf#L36)
</Steps>

## How can we create Self-Hosted Runners for GitHub with EKS?

Expand Down
2 changes: 2 additions & 0 deletions docs/layers/identity/aws-sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ For providers not included in the following section, please [follow the AWS docu

:::

<Steps>
1. Open the Identity account in the AWS Console
2. On the Dashboard page of the IAM Identity Center console, select Choose your identity source
3. In the Settings, choose the Identity source tab, select the Actions dropdown in the top right, and then select Change
Expand All @@ -196,6 +197,7 @@ For providers not included in the following section, please [follow the AWS docu
11. Finally, define specific Groups to match the given Group names by the aws-sso component
(`stacks/catalog/aws-sso.yaml`). In the default catalog, we define four Groups: `DevOps`, `Developers`,
`BillingAdmin`, and `Everyone`
</Steps>

If set up properly, Users and Groups added to your IdP will automatically populate and update in AWS.

Expand Down
28 changes: 6 additions & 22 deletions docs/layers/network/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ sidebar_position: 10

import Intro from '@site/src/components/Intro';
import ReactPlayer from "react-player";
import Step from '@site/src/components/Step';
import StepNumber from '@site/src/components/StepNumber';
import Steps from '@site/src/components/Steps';

<Intro>
Frequently asked questions about network and DNS with Cloud Posse's reference architecture.
Expand Down Expand Up @@ -49,26 +48,11 @@ stack. Give that component a new name, such as `vpc/data-1`, and then inherit th

In order to add a new network region:

<Step>
<StepNumber/> Create Mixin

Create a new mixin for the region: `stacks/mixins/{{ region }}/`

</Step>

<Step>
<StepNumber/> Create Stack Configuration

Define a new stack configuration for the region. The regions of any given account are defined by resources in the directories for the given region, `stacks/orgs/{{ namespace }}/{{ tenant }}/{{ stage }}/{{ region }}/`

</Step>

<Step>
<StepNumber/> Add Resources

Add the required resources to the stack file, `stacks/orgs/{{ namespace }}/{{ tenant }}/{{ stage }}/{{ region }}/network.yaml`. For example for networking, define a new VPC, connect Transit Gateway, and define Client VPN routes to the new regions.

</Step>
<Steps>
1. Create a new mixin for the region: `stacks/mixins/{{ region }}/`
1. Define a new stack configuration for the region. The regions of any given account are defined by resources in the directories for the given region, `stacks/orgs/{{ namespace }}/{{ tenant }}/{{ stage }}/{{ region }}/`
1. Add the required resources to the stack file, `stacks/orgs/{{ namespace }}/{{ tenant }}/{{ stage }}/{{ region }}/network.yaml`. For example for networking, define a new VPC, connect Transit Gateway, and define Client VPN routes to the new regions.
</Steps>

For more, see [How to Define Stacks for Multiple Regions](/learn/maintenance/tutorials/how-to-define-stacks-for-multiple-regions)

Expand Down

0 comments on commit 3a35378

Please sign in to comment.