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: README.md
+23-37Lines changed: 23 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
3
3
> TL;DR
4
4
>
5
-
> Skip the theory? Go [here](README.md#how-to-spin-up-your-humanitec-aws-reference-architecture) to spin up your Humanitec AWS Reference Architecture Implementation.
5
+
> Skip the theory? Go [here](README.md#how-to-spin-up-your-humanitec-aws-reference-architecture) to spin up your Humanitec AWS Reference Architecture Implementation.
6
6
>
7
7
> [Follow this learning path to master your Internal Developer Platform](https://developer.humanitec.com/training/master-your-internal-developer-platform/introduction/).
8
8
>
9
9
10
10
Building an Internal Developer Platform (IDP) can come with many challenges. To give you a head start, we’ve created a set of [reference architectures](https://humanitec.com/reference-architectures) based on hundreds of real-world setups. These architectures described in code provide a starting point to build your own IDP within minutes, along with customization capabilities to ensure your platform meets the unique needs of your users (developers).
11
11
12
-
The initial version of this reference architecture has been presented by Mike Gatto, Sr. DevOps Engineer, McKinsey and Stephan Schneider, Digital Expert Associate Partner, McKinsey at [PlartformCon 2023](https://www.youtube.com/watch?v=AimSwK8Mw-U).
12
+
The initial version of this reference architecture has been presented by Mike Gatto, Sr. DevOps Engineer, McKinsey and Stephan Schneider, Digital Expert Associate Partner, McKinsey at [PlartformCon 2023](https://www.youtube.com/watch?v=AimSwK8Mw-U).
13
13
14
14
## What is an Internal Developer Platform (IDP)?
15
15
@@ -21,36 +21,34 @@ When McKinsey originally [published the reference architecture](https://www.yout
This plane is the primary configuration layer and interaction point for the platform users. It harbors the following components:
27
27
28
-
29
-
30
28
* A **Version Control System**. GitHub is a prominent example, but this can be any system that contains two types of repositories:
31
-
* Application Source Code
32
-
* Platform Source Code, e.g. using Terraform
29
+
* Application Source Code
30
+
* Platform Source Code, e.g. using Terraform
33
31
***Workload specifications**. The reference architecture uses [Score](https://developer.humanitec.com/score/overview/).
34
32
* A **portal** for developers to interact with. It can be the Humanitec Portal, but you might also use [Backstage](https://backstage.io/) or any other portal on the market.
35
33
36
-
37
-
### Integration and Delivery Plane
34
+
### Integration and Delivery Plane
38
35
39
36
This plane is about building and storing the image, creating app and infra configs from the abstractions provided by the developers, and deploying the final state. It’s where the domains of developers and platform engineers meet.
40
37
41
38
This plane usually contains four different tools:
39
+
42
40
* A **CI pipeline**. It can be Github Actions or any CI tooling on the market.
43
41
* The **image registry** holding your container images. Again, this can be any registry on the market.
44
42
* An **orchestrator** which in our example, is the Humanitec Platform Orchestrator.
45
43
* The **CD system**, which can be the Platform Orchestrator’s deployment pipeline capabilities — an external system triggered by the Orchestrator using a webhook, or a setup in tandem with GitOps operators like ArgoCD.
46
44
47
-
### Monitoring and Logging Plane
45
+
### Monitoring and Logging Plane
48
46
49
47
The integration of monitoring and logging systems varies greatly depending on the system. This plane however is not a focus of the reference architecture.
50
48
51
-
### Security Plane
49
+
### Security Plane
52
50
53
-
The security plane of the reference architecture is focused on the secrets management system. The secrets manager stores configuration information such as database passwords, API keys, or TLS certificates needed by an Application at runtime. It allows the Platform Orchestrator to reference the secrets and inject them into the Workloads dynamically. You can learn more about secrets management and integration with other secrets management [here](https://developer.humanitec.com/platform-orchestrator/security/overview).
51
+
The security plane of the reference architecture is focused on the secrets management system. The secrets manager stores configuration information such as database passwords, API keys, or TLS certificates needed by an Application at runtime. It allows the Platform Orchestrator to reference the secrets and inject them into the Workloads dynamically. You can learn more about secrets management and integration with other secrets management [here](https://developer.humanitec.com/platform-orchestrator/security/overview).
54
52
55
53
The reference architecture sample implementations use the secrets store attached to the Humanitec SaaS system.
56
54
@@ -59,6 +57,7 @@ The reference architecture sample implementations use the secrets store attached
59
57
This plane is where the actual infrastructure exists including clusters, databases, storage, or DNS services. The configuration of the Resources is managed by the Platform Orchestrator which dynamically creates app and infrastructure configurations with every deployment and creates, updates, or deletes dependent Resources as required.
60
58
61
59
## How to spin up your Humanitec AWS Reference Architecture
60
+
62
61
This repo contains an implementation of part of the Humanitec Reference Architecture for an Internal Developer Platform.
63
62
64
63
To install an implementation containing add-ons, follow the separate README. We currently feature these add-ons:
@@ -69,13 +68,13 @@ This repo covers the base layer of the implementation for AWS.
69
68
70
69
By default, the following will be provisioned:
71
70
72
-
- VPC
73
-
- EKS Cluster
74
-
- IAM User to access the cluster
75
-
- Ingress NGINX in the cluster
76
-
- Resource Definitions in Humanitec for:
77
-
- Kubernetes Cluster
78
-
- Logging
71
+
* VPC
72
+
* EKS Cluster
73
+
* IAM User to access the cluster
74
+
* Ingress NGINX in the cluster
75
+
* Resource Definitions in Humanitec for:
76
+
* Kubernetes Cluster
77
+
* Logging
79
78
80
79
### Prerequisites
81
80
@@ -115,22 +114,12 @@ This reference architecture implementation uses Terraform. You will need to do t
115
114
terraform apply
116
115
```
117
116
118
-
`terraform plan` and `apply` might output this message:
119
-
```
120
-
│ Warning: Argument is deprecated
121
-
│
122
-
│ with module.base.module.aws_eks.aws_eks_addon.this["aws-ebs-csi-driver"],
123
-
│ [...]
124
-
```
125
-
This is due to an upstream issue with the Terraform AWS modules, and can be ignored.
126
-
127
117
#### Required input variables
128
118
129
119
Terraform reads variables by default from a file called `terraform.tfvars`. You can create your own file by renaming the `terraform.tfvars.example` file in the root of the repo and then filling in the missing values.
130
120
131
121
You can see find a details about each of those variables and additional supported variables under [Inputs](#inputs).
132
122
133
-
134
123
### Verify your result
135
124
136
125
Check for the existence of key elements of the reference architecture. This is a subset of all elements only. For a complete list of what was installed, review the Terraform code.
@@ -148,8 +137,9 @@ Check for the existence of key elements of the reference architecture. This is a
*[Structure and integration points](https://developer.humanitec.com/training/master-your-internal-developer-platform/structure-and-integration-points/)
0 commit comments