You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: GETTING_STARTED.md
+23-23
Original file line number
Diff line number
Diff line change
@@ -3,25 +3,25 @@ The Flightdeck platform is a containerized runtime environment built on top of p
3
3
4
4
For new or existing projects, especially ones that have PII data (think health and financial services) Flightdeck provides a powerful, enterprise ready platform to begin building or migrating enterprise-grade applications. Flightdeck has already been used for many in education, health, and financial industries just to name a few.
5
5
6
-
This guide walks through a linear process of deployment based on the (AWS Platform Guide)[https://thoughtbot.atlassian.net/wiki/spaces/APG/overview]. It is highly recommended to read through each relevant section to understand the nuances of the steps this tutorial outlines.
6
+
This guide walks through a linear process of deployment based on the [AWS Platform Guide](https://thoughtbot.atlassian.net/wiki/spaces/APG/overview). It is highly recommended to read through each relevant section to understand the nuances of the steps this tutorial outlines.
* Create source code repositories -- for details on the repos needed, see (Repository Conventions)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/10649919].
11
+
* Create source code repositories -- for details on the repos needed, see [Repository Conventions](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/10649919).
12
12
* Create password vault.
13
13
* Create management AWS account.
14
14
* Register or delegate domains.
15
-
*(Launch Control Tower)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11239471].
16
-
*(Launch Customizations for Control Tower)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/86999041].
17
-
*(Set up accounts)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11173895].
18
-
*(Configure Single Sign On)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/86933512].
15
+
*[Launch Control Tower](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11239471).
16
+
*[Launch Customizations for Control Tower](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/86999041).
17
+
*[Set up accounts](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11173895).
18
+
*[Configure Single Sign On](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/86933512).
19
19
* Create email groups for permission sets.
20
20
* Configure SAML for SSO.
21
21
* Configure SCIM for SSO.
22
22
* Configure DNS for domains.
23
23
* Continuous Integration and Deployment (CI/CD) for infrastructure
@@ -37,33 +37,33 @@ This guide walks through a linear process of deployment based on the (AWS Platfo
37
37
### Platform Dependencies
38
38
The Landing Zone is the start URL for users to access the organization's AWS accounts.
39
39
40
-
Flightdeck uses (Control Tower)[https://aws.amazon.com/controltower/] to build a Landing Zone implementing security best practices and reliable workload isolation. This provides a quick starting point for a multi-account setup while still allowing for significant customization and expansion later.
41
-
Rather than managing individual IAM users, it is suggested to use (AWS SSO)[https://aws.amazon.com/single-sign-on/] to manage users centrally and integrate with existing identity stores like a Google or Microsoft user directory.
40
+
Flightdeck uses [Control Tower](https://aws.amazon.com/controltower/) to build a Landing Zone implementing security best practices and reliable workload isolation. This provides a quick starting point for a multi-account setup while still allowing for significant customization and expansion later.
41
+
Rather than managing individual IAM users, it is suggested to use [AWS SSO](https://aws.amazon.com/single-sign-on/) to manage users centrally and integrate with existing identity stores like a Google or Microsoft user directory.
42
42
43
-
Flightdeck also uses (Customizations for Control Tower)[https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/] to configure (account baselines)[https://docs.aws.amazon.com/controltower/latest/userguide/terminology.html] and deploy (service control policies)[https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html].
43
+
Flightdeck also uses [Customizations for Control Tower](https://aws.amazon.com/solutions/implementations/customizations-for-aws-control-tower/) to configure [account baselines](https://docs.aws.amazon.com/controltower/latest/userguide/terminology.html) and deploy [service control policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html).
44
44
45
45
### Accounts and Network
46
-
In order to fully deploy the Flightdeck platform, it is recommended to set up the (conventional accounts)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/10649900] in addition to the standard accounts using the (landing zone repository template)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14680065]. It may take some time for all the required accounts to be provisioned. Once all the accounts are fully enrolled, next step is to create (VPC networks)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11304982].
47
-
In the (infrastructure repository)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/10649919] for the organization create Terraform root modules for managing VPCs and related networking resources. Diagrams of the network and account structure can be provided to security teams for compliance framework purposes.
46
+
In order to fully deploy the Flightdeck platform, it is recommended to set up the [conventional accounts](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/10649900) in addition to the standard accounts using the [landing zone repository template](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14680065). It may take some time for all the required accounts to be provisioned. Once all the accounts are fully enrolled, next step is to create [VPC networks](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11304982).
47
+
In the [infrastructure repository](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/10649919) for the organization create Terraform root modules for managing VPCs and related networking resources. Diagrams of the network and account structure can be provided to security teams for compliance framework purposes.
48
48
49
49
### Ingress Stack
50
-
In the (infrastructure repository)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/13599104 for the organization, you can create Terraform root modules for managing ingress resources, including hosted zones, SSL certificates, load balancers, target groups, and DNS aliases. In order to provision the ingress stack, at least one hosted zone is required. For more information on configuring hosted zones see (DNS administration)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11173932].
50
+
In the [infrastructure repository](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/13599104) for the organization, you can create Terraform root modules for managing ingress resources, including hosted zones, SSL certificates, load balancers, target groups, and DNS aliases. In order to provision the ingress stack, at least one hosted zone is required. For more information on configuring hosted zones see [DNS administration](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/11173932).
51
51
52
-
Flightdeck includes a (Terraform module)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14450709] for provisioning an entire ingress stack, including:
53
-
* An (application load balancer)[https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html] for handling incoming requests.
54
-
* An (ACM certificate)[https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html] for encrypting requests using TLS.
55
-
* A (Route 53 alias)[https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-choosing-alias-non-alias.html] to publish a DNS address for the load balancer.
56
-
*(Target groups)[https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html] for the clusters in this ingress stack.
52
+
Flightdeck includes a [Terraform module](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14450709) for provisioning an entire ingress stack, including:
53
+
* An [application load balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html) for handling incoming requests.
54
+
* An [ACM certificate](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) for encrypting requests using TLS.
55
+
* A [Route 53 alias](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-choosing-alias-non-alias.html) to publish a DNS address for the load balancer.
56
+
*[Target groups](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) for the clusters in this ingress stack.
57
57
58
58
### Flightdeck Platform
59
59
Flightdeck is a platform for deploying and managing applications on Kubernetes. Flightdeck consists of Terraform modules for deploying a curated set of preconfigured open source projects and AWS products.
60
60
61
-
In order to deploy Flightdeck, you'll first need Kubernetes clusters. On AWS, Flightdeck is designed to deploy to AWS's EKS platform. Flightdeck contains a (cluster Terraform module)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14680073] capable of setting up compatible EKS clusters.
62
-
Create a root module for each phase of the software development lifecycle to deploy an (EKS cluster)[https://docs.aws.amazon.com/eks/latest/userguide/clusters.html] and (managed node groups)[https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html].
63
-
Finally, deploy Flightdeck for the sandbox and production clusters using the (workload platform module)[https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14680081].
61
+
In order to deploy Flightdeck, you'll first need Kubernetes clusters. On AWS, Flightdeck is designed to deploy to AWS's EKS platform. Flightdeck contains a [cluster Terraform module](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14680073) capable of setting up compatible EKS clusters.
62
+
Create a root module for each phase of the software development lifecycle to deploy an [EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/clusters.html) and [managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html).
63
+
Finally, deploy Flightdeck for the sandbox and production clusters using the [workload platform module](https://thoughtbot.atlassian.net/wiki/spaces/APG/pages/14680081).
64
64
65
65
### Monitoring Set Up
66
-
(Grafana)[https://grafana.com/] is recommended to monitor infrastructure and applications. AWS's managed services can be leveraged for deploying centralized Prometheus and Grafana instances. Flightdeck can forward time series data from its federated Prometheus instance to an AWS Managed Prometheus instance for long-term storage. This instance can also be used as a data source for AWS Managed Grafana
66
+
[Grafana](https://grafana.com/) is recommended to monitor infrastructure and applications. AWS's managed services can be leveraged for deploying centralized Prometheus and Grafana instances. Flightdeck can forward time series data from its federated Prometheus instance to an AWS Managed Prometheus instance for long-term storage. This instance can also be used as a data source for AWS Managed Grafana.
0 commit comments