Skip to content

Commit

Permalink
Fix: Miscellaneous Typos (#701)
Browse files Browse the repository at this point in the history
  • Loading branch information
milldr authored Sep 24, 2024
1 parent 9fe563a commit 23077a7
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 20 deletions.
9 changes: 4 additions & 5 deletions docs/jumpstart/action-items.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Before we can get started, here's the minimum information we need from you.

Please also provision a single test user in your IdP for Cloud Posse to use for testing and add those user credentials to 1Password.

- [AWS Identity Center (SSO) ClickOps](/layers/identity/aws-sso/)
- [Setup AWS Identity Center (SSO)](/layers/identity/aws-sso/)

<Admonition type="caution">
- GSuite does not automatically sync Users and Groups with AWS Identity Center without additional configuration! If using GSuite as an IdP, considering deploying the [ssosync tool](https://github.com/awslabs/ssosync).
Expand All @@ -76,10 +76,9 @@ Before we can get started, here's the minimum information we need from you.

If deploying AWS SAML as an alternative to AWS SSO, we will need a separate configuration and metadata file. Again, please refer to the relevant linked guide.

- [GSuite](https://aws.amazon.com/blogs/desktop-and-application-streaming/setting-up-g-suite-saml-2-0-federation-with-amazon-appstream-2-0/): Follow Steps 1 through 7. This document refers to Appstream, but the process will be the same for AWS.
- [Office 365](/layers/identity/tutorials/how-to-setup-saml-login-to-aws-from-office-365)
- [JumpCloud](https://support.jumpcloud.com/support/s/article/getting-started-applications-saml-sso2)
- [Okta](https://help.okta.com/en-us/Content/Topics/DeploymentGuides/AWS/aws-configure-identity-provider.htm)
Please see the following guide and follow the steps to export metadata for your Identity Provider integration. All steps in AWS will be handled by Cloud Posse.

- [Setup AWS SAML](/layers/identity/aws-saml/)
</Step>
</Steps>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Cloud Posse recommends starting with a **Net-New Organization**

- Only one AWS Control Tower can exist in an organization.

- AWS Control Tower only recenlty became managable with Terraform, and full support is not availble.
- AWS Control Tower only recently became manageable with Terraform, and full support is not available.
Depending on the Scope of Work, Cloud Posse is usually responsible for provisioning accounts with terraform which requires all the same access as Control Tower.

- Member accounts can only be provisioned from the top-level root “organization” account
Expand Down
4 changes: 1 addition & 3 deletions docs/layers/ecs/tutorials/1password-scim-bridge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import CollapsibleText from "@site/src/components/CollapsibleText";

## Implementation

The implementation of this is fairly simple. We will generate credentials for the SCIM bridge in 1Password, store them in AWS SSM Parameter Store, deploy the SCIM bridge ECS service, and then finally connect your choosen identity provider.
The implementation of this is fairly simple. We will generate credentials for the SCIM bridge in 1Password, store them in AWS SSM Parameter Store, deploy the SCIM bridge ECS service, and then finally connect your chosen identity provider.

<Steps>
<Step>
Expand Down Expand Up @@ -88,8 +88,6 @@ The implementation of this is fairly simple. We will generate credentials for th
OP_CONFIRMATION_INTERVAL: "300"
map_secrets:
OP_SESSION: "1password/scim/scimsession"
# OP_WORKSPACE_CREDENTIALS: ""
# OP_WORKSPACE_SETTINGS: ""
log_configuration:
logDriver: awslogs
options: {}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ We recommend using the External Secrets Operator with AWS SSM Parameter Store. T

However, we are in the process of evaluating the AWS Secrets Manager secrets with Kubernetes Secrets Store CSI Driver solution. This is the AWS supported option and may be a better long-term solution. We will build the required Terraform component to support this solution.

## Consquences
## Consequences

We will develop the `eks/secrets-store-csi-driver` component using the [Secrets Store CSI Driver](https://secrets-store-csi-driver.sigs.k8s.io/getting-started/installation)
6 changes: 5 additions & 1 deletion docs/layers/identity/aws-saml.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ identity. You can use this federated identity to connect directly to a given AWS
Here are some example setup references:
<Tabs queryString="idp">
<TabItem value="google" label="Google Workspace">
Follow the [AWS documentation for Google Workspace](https://aws.amazon.com/blogs/desktop-and-application-streaming/setting-up-g-suite-saml-2-0-federation-with-amazon-appstream-2-0/). Once you have completed the setup, download the metadata file.
<Steps>
1. Open the [AWS documentation for GSuite](https://aws.amazon.com/blogs/desktop-and-application-streaming/setting-up-g-suite-saml-2-0-federation-with-amazon-appstream-2-0/)
1. Follow Steps 1 through 7. This document refers to Appstream, but the process will be the same for AWS.
1. Once you have completed the setup, download the metadata file.
</Steps>
</TabItem>
<TabItem value="okta" label="Okta">

Expand Down
2 changes: 1 addition & 1 deletion docs/layers/project/create-repository.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Learn how to create a GitHub repository to host infrastructure tools and configu
With the GitHub repository prepared, we are now ready to import the Cloud Posse reference architecture.

<Admonition type="info" title="Where do I get these files?">
The contents of this respository are supplied as part of our [Quickstart](/quickstart) or [Jumpstart](/jumpstart) packages. For the remainder of this guide, we will assume you have access to the reference architecture configurations.
The contents of this repository are supplied as part of our [Quickstart](/quickstart) or [Jumpstart](/jumpstart) packages. For the remainder of this guide, we will assume you have access to the reference architecture configurations.
<PrimaryCTA to="/quickstart">Learn More</PrimaryCTA>
</Admonition>

Expand Down
2 changes: 1 addition & 1 deletion docs/layers/project/toolbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Geodesic is a powerful Linux toolbox container designed to optimize DevOps workf

<DismissibleDialog id="q2" expires="30" className="floating tall wide">
<h1>Where are the configs?</h1>
<p>The configurations are availble via our Quickstart</p>
<p>The configurations are available via our Quickstart</p>
<PrimaryCTA to="/quickstart">Try Quickstart</PrimaryCTA>
</DismissibleDialog>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -218,4 +218,4 @@ Changes through Terraform will not immediately be reflected in the ECS Service.
been updated, but whatever was in the `task-definition.json` file in the S3 bucket will be used for deployment.

To update the ECS Service after updating the Terraform for it, you must deploy through GitHub Actions. This will then
download the new template and create a new updated `task-defintion.json` to store in s3.
download the new template and create a new updated `task-definition.json` to store in s3.
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Our implementation of Argo CD breaks up notifications into "notifiers", "templat
"body": "{\"context\":\"continuous-delivery/{{.app.metadata.name}}\",\"description\":\"ArgoCD\",\"state\":\"pending\",\"target_url\":\"{{.context.argocdUrl}}/applications/{{.app.metadata.name}}\"}"
"method": "POST"
"path": "/repos/{{call .repo.FullNameByRepoURL .app.spec.source.repoURL}}/statuses/{{.app.status.operationState.operation.sync.revision}}"
template.app-deploy-succeded: |
template.app-deploy-succeeded: |
"alertmanager": null
"message": "Application {{ .app.metadata.name }} is now running new version of deployments
manifests."
Expand All @@ -103,7 +103,7 @@ Our implementation of Argo CD breaks up notifications into "notifiers", "templat
eks/argocd:
vars:
notifications_templates:
app-deploy-succeded:
app-deploy-succeeded:
message: "Application {{ .app.metadata.name }} is now running new version of deployments"
webhook:
foo-repo-github-commit:
Expand Down Expand Up @@ -146,15 +146,15 @@ Our implementation of Argo CD breaks up notifications into "notifiers", "templat
- "app-deploy-started"
"when": "app.status.operationState.phase in ['Running'] or ( app.status.operationState.phase
== 'Succeeded' and app.status.health.status == 'Progressing' )"
trigger.on-deploy-succeded: |
trigger.on-deploy-succeeded: |
- "oncePer": "app.status.sync.revision"
"send":
- "app-deploy-succeded"
- "app-deploy-succeeded"
"when": "app.status.operationState.phase == 'Succeeded' and app.status.health.status
== 'Healthy'"
```

These triggers may trigger _multiple templates_. For example `trigger.on-deploy-succeded` triggers both `template.app-deploy-succeded.webhook.app-repo-github-commit-status` and `template.app-deploy-succeded.webhook.argocd-repo-github-commit-status`.
These triggers may trigger _multiple templates_. For example `trigger.on-deploy-succeeded` triggers both `template.app-deploy-succeeded.webhook.app-repo-github-commit-status` and `template.app-deploy-succeeded.webhook.argocd-repo-github-commit-status`.
</Step>

</Steps>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import DocCardList from '@theme/DocCardList';
import Intro from '@site/src/components/Intro';

<Intro>
Review the key design decisions for how you'll leverage Spacelift for continous delivery of your infrastructure with Terraform and Atmos.
Review the key design decisions for how you'll leverage Spacelift for continuous delivery of your infrastructure with Terraform and Atmos.
</Intro>

<DocCardList/>

0 comments on commit 23077a7

Please sign in to comment.