Skip to content

Commit

Permalink
add CTAs, office hours videos and format design decisions
Browse files Browse the repository at this point in the history
  • Loading branch information
osterman committed Jul 19, 2024
1 parent 66c0bac commit 8f52546
Show file tree
Hide file tree
Showing 29 changed files with 227 additions and 227 deletions.
9 changes: 9 additions & 0 deletions docs/community/office-hours.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: Office Hours with Cloud Posse
id: office-hours
---
import HubspotForm from 'react-hubspot-form'
import { YouTubePlaylist } from '@codesweetly/react-youtube-playlist';

# Office Hours Registration

Expand All @@ -17,3 +18,11 @@ import HubspotForm from 'react-hubspot-form'
onReady={(form) => console.log('Form ready!')}
loading={<div>Loading...</div>}
/>

## Past Recordings

<div className="youtube">
<YouTubePlaylist
apiKey="AIzaSyDHVTCXzhWSzqXZhik4BWem6xnzASqS17Y"
playlistId="PLhRztDM6Uvne8MUuwXrv2truMl6gVZ0D8" />
</div>
15 changes: 10 additions & 5 deletions docs/community/support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,19 @@ sidebar_position: 100
# FAQ
Here are some quick answers to frequently asked questions. See also our [Troubleshooting](/reference-architecture/reference/troubleshooting).

## Documentation
## How can we support you?

### How do I request additional documentation?
By far, the hardest part of being an open-source company is surviving the financial reality that very few companies ever pay for open source. Any financial contribution you can make helps us continue operating as a business, and we've made this easy through GitHub sponsorships.


<iframe src="https://github.com/sponsors/cloudposse/card" title="Sponsor Cloud Posse" height="auto" width="100%" style={{border: 0}}></iframe>

## How do I request additional documentation?

Please request documentation by opening a [GitHub Issue](https://github.com/cloudposse/docs/issues). Please provide as much detail as possible about what you would like to see documented and what related documents you discovered that were not helpful.

### Can I pay for support?
## Are there paid support options?

Yes, we offer paid support via [GitHub Sponsorships](https://github.com/sponsors/cloudposse).
Yes, we offer [Customer Workshops](/quickstart/support) support via [GitHub Sponsorships](https://github.com/sponsors/cloudposse). With workshops, you can ask questions and get help directly from our engineers.

<iframe src="https://github.com/sponsors/cloudposse/card" title="Sponsor Cloud Posse" height="225" width="600" style={{border: 0}}></iframe>
If you're benefiting from what we build here and your business depends on it, this is a great way to get both the help you need and to support our Open Source. Discuss the possibility of a [GitHub sponsorship of Cloud Posse](/quickstart) with your management! This sponsorship includes access to our [twice-weekly customer workshops](/quickstart/support), where you can ask questions and get help directly from our engineers.
2 changes: 1 addition & 1 deletion docs/jumpstart/action-items.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import StepNumber from '@site/src/components/StepNumber';
Cloud Posse will need a few subscriptions set up from you in order to deploy your infrastructure. Some of these may not apply to all engagements, but please start setting up the relevant subscriptions now.
</Intro>

## Subsucriptions
## Subscriptions

### 1Password

Expand Down
19 changes: 18 additions & 1 deletion docs/layers/accounts/accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ sidebar_class_name: hidden
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';
import ReactPlayer from "react-player";
import ActionCard from '@site/src/components/ActionCard';
import PrimaryCTA from '@site/src/components/PrimaryCTA';
import SecondaryCTA from '@site/src/components/SecondaryCTA';

<Intro>
This chapter presents how Cloud Posse designs and manages AWS Account architectures. We will explain how Cloud Posse provisions and manages AWS Accounts, the reasoning behind our decisions, and how this architecture will better align your organization with the [AWS Well-Architected Framework](https://docs.aws.amazon.com/pdfs/wellarchitected/latest/userguide/wellarchitected-ug.pdf)
This chapter presents how Cloud Posse designs and manages AWS Account architectures. We will explain how Cloud Posse provisions and manages AWS Accounts using Atmos and Terraform, the reasoning behind our decisions, and how this architecture will better align your organization with the [AWS Well-Architected Framework](https://docs.aws.amazon.com/pdfs/wellarchitected/latest/userguide/wellarchitected-ug.pdf).
</Intro>

<KeyPoints>
Expand Down Expand Up @@ -69,6 +72,8 @@ account-level administrators cannot bypass.

### Account Architecture

By convention, we prefix each account name with its organizational unit (OU) to distinguish it from other accounts of the same type. For example, if we have an OU called `plat` (short for platform) and an account called "production" (or `prod` for short), we would name the account `plat-prod`. In practice, there might be multiple production accounts, such as in a `data` OU, a `network` OU, and a `plat` OU. By prefixing each account with its OU, it is sufficiently disambiguated and follows a consistent convention.

<dl>
<dt>
<code>core-root</code>
Expand Down Expand Up @@ -267,6 +272,18 @@ Cloud Posse manages this process with the following components.
<dd>This component is responsible for provisioning a bucket for storing cloudtrail logs for auditing purposes</dd>
</dl>


<ActionCard title="What comes next?">
Next, we'll prepare the organization to provision the Terraform State backend, followed by account provisioning.
If you're curious about the though that went into this process, please review the design decisions documentation.

<div>
<PrimaryCTA to="/layers/accounts/prepare-aws-organization">Next Step</PrimaryCTA>
<SecondaryCTA to="/layers/accounts/design-decisions">Review Design Decisions</SecondaryCTA >
</div>
</ActionCard>


## References

- [Decide on AWS Organization Strategy](/layers/accounts/design-decisions/decide-on-aws-organization-strategy/)
Expand Down
10 changes: 0 additions & 10 deletions docs/layers/accounts/design-decisions/_category_.json

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ For the latest pricing, go to

## Sample Pricing

<img src="/assets/refarch/image-20220713-003707.png" height="675" width="1672" />
<img src="/assets/refarch/image-20220713-003707.png" />
<br />
13 changes: 13 additions & 0 deletions docs/layers/accounts/design-decisions/design-decisions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Design Decisions"
sidebar_label: "Design Decisions"
sidebar_position: 100
---
import DocCardList from '@theme/DocCardList';
import Intro from '@site/src/components/Intro';

<Intro>
These are some of the design decisions you should be aware of when provisioning a new AWS organization.
</Intro>

<DocCardList/>
5 changes: 3 additions & 2 deletions docs/layers/foundation/create-repository.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ Learn how to create a GitHub repository to host infrastructure tools and configu
</Step>

<ActionCard title="What comes next?">
With your repository set up, you’re ready to configure the toolbox container. This container, based on Geodesic, will provide you with an interactive and consistent environment to execute all the necessary commands in the upcoming steps. In the next step, you’ll dive deeper into Geodesic and its powerful features.
With your repository set up, we need to address some of the prerequisites for your workstation.
This includes setting up your workstation to work with Docker, obtaining cloud access, and more.

<PrimaryCTA to="/layers/foundation/toolbox">Next Step</PrimaryCTA>
<PrimaryCTA to="/layers/foundation/prerequisites">Next Step</PrimaryCTA>
</ActionCard>
10 changes: 0 additions & 10 deletions docs/layers/foundation/design-decisions/_category_.json

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Decide on 1Password Strategy"
sidebar_label: "1Password Strategy"
refarch_id: REFARCH-34
description: "Decide how you'll use 1password for sharing secrets with individuals and teams"
---
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Decide on ECR Strategy"
sidebar_label: "ECR Strategy"
refarch_id: REFARCH-254
description: "Decide how you'll use ECR for storing docker images"
---
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Decide on Infrastructure Repository Name"
sidebar_label: "Infrastructure Repository Name"
refarch_id: REFARCH-52
description: "Decide on where to keep your infrastructure code"
---
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Decide on Namespace Abbreviation"
sidebar_label: "Namespace Abbreviation"
refarch_id: REFARCH-53
description: "Pick a concise prefix for all cloud resource names"
---
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@
title: "Decide on Regional Naming Scheme"
sidebar_label: "Regional Naming Scheme"
refarch_id: REFARCH-209
description: "Decide on a regional naming scheme for resources"
---
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';

<Intro>
We need to decide how we’ll handle DR if that’s a requirement. It has far-reaching implications on naming conventions
and is not an easily reversible decision.
</Intro>

Our current best practice is to use the following convention:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Decide on Secrets Management Strategy for Terraform"
sidebar_label: "Secrets Management Strategy for Terraform"
refarch_id: REFARCH-81
description: "Decide where to manage secrets used by Terraform"
---
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';
Expand Down
13 changes: 13 additions & 0 deletions docs/layers/foundation/design-decisions/design-decisions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Design Decisions"
sidebar_label: "Design Decisions"
sidebar_position: 100
---
import DocCardList from '@theme/DocCardList';
import Intro from '@site/src/components/Intro';

<Intro>
As part of getting started, there are some foundational design decisions to be aware of. In our reference architecture, we've made some default decisions on your behalf, but you may want to reconsider or customize these based on your specific requirements.
</Intro>

<DocCardList/>
11 changes: 11 additions & 0 deletions docs/layers/foundation/foundation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import KeyPoints from '@site/src/components/KeyPoints';
import ReactPlayer from "react-player";
import ActionCard from '@site/src/components/ActionCard';
import PrimaryCTA from '@site/src/components/PrimaryCTA';
import SecondaryCTA from '@site/src/components/SecondaryCTA';

## Problem

Expand Down Expand Up @@ -115,3 +116,13 @@ If this all sounds a little bit daunting, you may want to start by reviewing the
- [ ] Review [atmos.tools](https://atmos.tools/).
- [ ] Review the [How-to Guides](/reference-architecture/how-to-guides) so you’re aware of what guides exist.
- [ ] Review [References](/reference-architecture/category/reference/) for additional context and documentation.


<ActionCard title="What comes next?">
Let's get started by creating the repository and importing the configurations provided by Cloud Posse as part of the Quickstart. If you don't have a Quickstart, consider learning more about its benefits.

<div>
<PrimaryCTA to="/layers/foundation/create-repository">Next Step</PrimaryCTA>
<SecondaryCTA to="/quickstart">Learn More</SecondaryCTA >
</div>
</ActionCard>
13 changes: 10 additions & 3 deletions docs/layers/foundation/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,31 @@ title: Prerequisites
sidebar_label: Setup Prerequisites
sidebar_position: 3
---
import Intro from '@site/src/components/Intro';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Step from '@site/src/components/Step';
import StepNumber from '@site/src/components/StepNumber';
import ActionCard from '@site/src/components/ActionCard';
import PrimaryCTA from '@site/src/components/PrimaryCTA';

<Intro>
Before we start provisioning the reference architecture, ensure you have sufficient cloud access to provision the resources and that your local workstation has the necessary software installed.
</Intro>

<Step>
## <StepNumber/> Obtain Cloud Access

If you're provisioning the infrastructure from scratch, you'll need the AWS root account credentials as part of the bootstrapping process before AWS Single Sign-On is set up. If you're working within an existing organization, ensure you have sufficient access to the accounts you'll be managing.

- [ ] AWS SSO Access (talk to your AWS administrator)
- [ ] Ensure you can log in to AWS. See
[How to Use Leapp to Authenticate with AWS](/reference-architecture/how-to-guides/integrations/leapp) to get
started.
</Step>

<Step>
## <StepNumber/> Setup Workstation
## <StepNumber/> Setup Your Workstation

Prerequisites for your local host computer:

Expand Down Expand Up @@ -104,7 +111,7 @@ import PrimaryCTA from '@site/src/components/PrimaryCTA';
</Step>
<ActionCard title="What comes next?">
Now that you’ve set up your workstation and obtained cloud access, you’re ready to get started with setting up the infrastructure repository. This repository will be used to store all your infrastructure as code, ensuring a structured and organized approach to managing your resources.
With your repository set up, you’re ready to configure the toolbox container. This container, based on Geodesic, will provide you with an interactive and consistent environment to execute all the necessary commands in the upcoming steps. In the next step, you’ll dive deeper into Geodesic and its powerful features.
<PrimaryCTA to="/layers/foundation/create-repository">Next Step</PrimaryCTA>
<PrimaryCTA to="/layers/foundation/toolbox">Next Step</PrimaryCTA>
</ActionCard>
7 changes: 6 additions & 1 deletion docs/layers/foundation/toolbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Geodesic is a powerful Linux toolbox container designed to optimize DevOps workf
<figcaption>Geodesic in action</figcaption>
</figure>


<DismissibleDialog id="q2" expires="30" className="floating tall wide">
<h1>Where are the configs?</h1>
<p>The configurations are availble via our Quickstart</p>
Expand Down Expand Up @@ -47,3 +46,9 @@ run `make all`.
The container will have the given local home mapped, so you should be able to use aws normally inside it once you set a profile that has valid credentials. For instance, if I log in to the profile `acme` with [leapp](https://github.com/Noovolari/leapp), I can run `aws --profile acme sts get-caller-identity` and get a response.

Once you've verified that the infra container has access to aws resources, we can move on to the next step.

<ActionCard title="What comes next?">
With your repository set up, workstation configured and toolbox in hand, you're ready to get to work provisioning your infrastructure with Atmos and Terraform.

<PrimaryCTA to="/layers/accounts">Next Step</PrimaryCTA>
</ActionCard>
9 changes: 9 additions & 0 deletions docs/learn/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: "Overview of the Reference Architecture implementation using Atmos"
---
import Intro from '@site/src/components/Intro';
import KeyPoints from '@site/src/components/KeyPoints';
import ActionCard from '@site/src/components/ActionCard';
import PrimaryCTA from '@site/src/components/PrimaryCTA';

<Intro>
This is Cloud Posse's commercial implementation of a Reference Architecture using [Atmos](https://atmos.tools) together with the vast ecosystem of Cloud Posse modules following our SweetOps methodology.
Expand Down Expand Up @@ -60,3 +62,10 @@ This documentation site breaks down SweetOps into the following sections to help
- [**Reference**](/reference-architecture/category/reference/): Informative materials on specific tools and patterns within SweetOps.
- [**Components**](/components): Details on our vast library of opinionated root modules



<ActionCard title="What comes next?">
Now that you know what the reference architecture is about, you're ready to get started by with your first project.

<PrimaryCTA to="/layers/foundation">Next Step</PrimaryCTA>
</ActionCard>
Loading

0 comments on commit 8f52546

Please sign in to comment.