docs: Breaking down installation guide to avoid assuming AWS #2759
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
yhakbar
changed the title
yhakbar
force-pushed
the
yousif/dev-1100-break-down-setup-installation-to-avoid-assuming-aws
branch
from
d4aa2e7 to
14a3786
Compare
yhakbar
force-pushed
the
yousif/dev-1096-break-down-architecture-to-avoid-assuming-aws
branch
from
dba5367 to
5c77938
Compare
yhakbar
force-pushed
the
yousif/dev-1100-break-down-setup-installation-to-avoid-assuming-aws
branch
from
a9bfa94 to
7a28fbb
Compare
yhakbar
force-pushed
the
yousif/dev-1100-break-down-setup-installation-to-avoid-assuming-aws
branch
from
20a0f47 to
0216063
Compare
yhakbar
changed the base branch from
yousif/dev-1096-break-down-architecture-to-avoid-assuming-aws
to
pipelines-v4
yhakbar
force-pushed
the
yousif/dev-1100-break-down-setup-installation-to-avoid-assuming-aws
branch
from
0216063 to
df85b9e
Compare
|
|
||
| By default, Account Factory includes the following components: | ||
|
|
||
| - 📋 An HTML form for generating workflow inputs: `.github/workflows/account-factory-inputs.html` |
There was a problem hiding this comment.
nit: I think these icons are a bit of an AI-callsign, and is not a pattern mirrored elsewhere in our docs. Whilst I like a good emoji, I'm not sure these help
There was a problem hiding this comment.
Also, I know you didn't add these! Just a whilst-your-in-there thing
| 6. **Create `.gitlab-ci.yml`** to configure your GitLab CI/CD pipeline. | ||
| 7. **Commit and push** your changes to activate Pipelines. | ||
|
|
||
| ## Ensure OIDC configuration and JWKS are publicly accessible |
There was a problem hiding this comment.
It's a bit odd to have this headline come BEFORE the next headline of "prerequisites" - feels like this belongs under that headline?
|
|
||
| This step only applies if you are using a self-hosted GitLab instance that is not accessible from the public internet. If you are using GitLab.com or a self-hosted instance that is publicly accessible, you can skip this step. | ||
|
|
||
| 1. [Follow GitLab's instructions](https://docs.gitlab.com/ci/cloud_services/aws/#configure-a-non-public-gitlab-instance) for hosting your OIDC configuration and JWKS in a public location (e.g. S3 Bucket). This is necessary for both Gruntwork and the AWS OIDC provider to access the GitLab OIDC configuration and JWKS when authenticating JWT's generated by your custom instance. |
There was a problem hiding this comment.
There are some AWS-specific assumptions in this section
|
|
||
| ::: | ||
|
|
||
| ## Configuring SCM Access |
There was a problem hiding this comment.
Since this page is now specific to GitLab and doesn't have to cater to both github and gitlab, maybe we just say GitLab here?
| ## Configuring SCM Access | |
| ## Configuring GitLab Access |
|
|
||
| ## Configuring SCM Access | ||
|
|
||
| Pipelines needs the ability to interact with Source Control Management (SCM) platforms to fetch resources (e.g. IaC code, reusable CI/CD code and the Pipelines binary itself). |
There was a problem hiding this comment.
| Pipelines needs the ability to interact with Source Control Management (SCM) platforms to fetch resources (e.g. IaC code, reusable CI/CD code and the Pipelines binary itself). | |
| Pipelines needs the ability to interact with GitLab to fetch resources (e.g. IaC code, reusable CI/CD code and the Pipelines binary itself). |
There was a problem hiding this comment.
This section also feels like something got lost - we say "we need machine users" with a link to the doc, but nothing else. Maybe something more concrete like "To create machine users, follow our guide [here]" (or similar)
|
|
||
| If you don't have a `root.hcl` file, you might need to customize the bootstrapping process, as the Terragrunt scale catalog expects a `root.hcl` file in the root of the project. Please contact [Gruntwork support](/support) for assistance if you need help. | ||
|
|
||
| For each AWS account that needs bootstrapping, we'll use Boilerplate to scaffold the necessary content. |
There was a problem hiding this comment.
Might be missing an instruction here to tell the user to run this boilerplate command in each account folder or similar?
| For each environment, you'll want to define a [`filter` block](/2.0/reference/pipelines/configurations-as-code/api#filter-block) that tells Pipelines which units are part of that environment. You'll also want to define an [`authentication` block](/2.0/reference/pipelines/configurations-as-code/api#authentication-block) that tells Pipelines how to authenticate with your cloud provider(s) for that environment. | ||
|
|
||
| <Tabs> | ||
| <TabItem value="aws" label="AWS" default> |
There was a problem hiding this comment.
I suggest using a groupId here so the choice of cloud is synced across the doc
| @@ -0,0 +1,867 @@ | |||
| # Bootstrap Pipelines in an Existing Repository | |||
There was a problem hiding this comment.
There's a significant amount of duplicated content between GitHub/GitLab pages. What do you think of factoring that out?
There was a problem hiding this comment.
I started digging into this here, but it's proving annoying because the code snippets are interfering with MDX component parsing, and I don't want to have to put every code block in a separate file.
#2784
Will do what I can, but I'd like to defer that work in the interest of getting this merged.
There was a problem hiding this comment.
We discussed the issues involved in abstracting away logic into components, requiring work to avoid issues related to backticks and curly braces interfering with MDX parsing.
yhakbar
deleted the
yousif/dev-1100-break-down-setup-installation-to-avoid-assuming-aws
branch
3 participants
Breaking down installation guide to avoid assuming AWS usage.