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
{{ message }}
This repository was archived by the owner on Dec 29, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/meshstack.aks-developer-platform-quickstart-guide.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,30 +5,30 @@ title: AKS Developer Platform Guide
5
5
6
6
## Introduction
7
7
8
-
Welcome to the **First Developer Platform guide**! This guide provides step-by-step instructions to help you set up your first developer platform experience incorporating AKS, GitHub & GitHub Actions to deliver an easy-to-use starter kit to your application teams.
8
+
Welcome to the **First Developer Platform Guide**! This guide provides step-by-step instructions to help you set up your first developer platform experience incorporating AKS, GitHub & GitHub Actions to deliver an easy-to-use starter kit to your application teams.
9
9
10
10
## Goals
11
11
12
12
By the end of this guide, you will have built a complete starter kit for your users that will provide:
13
13
14
14
- A new GitHub repository
15
15
- A “dev” project with:
16
-
- an AKS namespace
17
-
- a GitHub actions workflow with credentials to the AKS namespace
16
+
- an AKS namespace
17
+
- a GitHub actions workflow with credentials to the AKS namespace
18
18
- A “prod” project with:
19
-
- an AKS namespace
20
-
- a GitHub actions workflow with credentials to the AKS namespace
19
+
- an AKS namespace
20
+
- a GitHub actions workflow with credentials to the AKS namespace
21
21
22
22
## Prerequisites
23
23
24
24
Before starting, ensure you have the following:
25
25
26
26
- You have a basic understanding of building blocks in meshStack.
27
-
-*If you don’t, we recommend running through the [AWS S3 guide](./meshstack.building-aws-quickstart-guide.md) to learn how building blocks work.*
27
+
-*If you don’t, we recommend running through the [AWS S3 guide](./meshstack.building-aws-quickstart-guide.md) to learn how building blocks work.*
28
28
- You have integrated an AKS cluster into meshStack.
29
-
-*If you don’t, we recommend running through the [First Platform guide for AKS](./meshstack.aks-platform-quickstart-guide.md) where you are guided to integrate an AKS cluster as a platform in meshStack*
29
+
-*If you don’t, we recommend running through the [First Platform guide for AKS](./meshstack.aks-platform-quickstart-guide.md) where you are guided to integrate an AKS cluster as a platform in meshStack*
30
30
31
-
## What will we do in this guide?
31
+
## What Will We Do in This Guide?
32
32
33
33
Shortly put, we will set up the following in this guide:
34
34
@@ -38,7 +38,7 @@ Shortly put, we will set up the following in this guide:
38
38
39
39
## 1. GitHub Repository
40
40
41
-
### Preparation
41
+
### Preparing GitHub Repository
42
42
43
43
The GitHub Repository building block definition needs access to your GitHub organization.
44
44
Follow the following steps to create a GitHub App that will be used to manage the repositories.
@@ -56,25 +56,25 @@ Follow the following steps to create a GitHub App that will be used to manage th
56
56
3.[**Create a GitHub App Private Key**](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)
57
57
1. Save this file somewhere convenient as we will also need it later.
58
58
59
-
### Creating the Building Block Definition
59
+
### Creating the Repository Building Block Definition
60
60
61
61
To make things easy, we will use the [meshStack Hub](https://hub.meshcloud.io) to create the new building block definition.
62
62
63
-
1. Open the Github Repository Creation Definition in the hub [here](https://hub.meshcloud.io/definitions/github-repository).
63
+
1. Open the Github Repository Creation Definition in the meshStack hub [here](https://hub.meshcloud.io/definitions/github-repository).
64
64
2. Click on “Add to meshStack” and enter your meshStack URL (if not given already).
65
65
3. Continue the flow in meshStack.
66
66
1. Right away you will be asked for a “Type”. Pick “Workspace Building Block” here.
67
67
2. Continue until you reach the “Inputs” page. On this page you will be forced to fill in the following:
68
68
1.`GITHUB_APP_ID` - This is the value saved under “Preparation” step 1b.
69
69
2.`GITHUB_APP_INSTALLATION_ID` - This is the value saved under “Preparation” step 2b.
70
-
3.`GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a.
70
+
3.`GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a. Take the entire content of the file and paste it in here.
71
71
4. Finish the flow and create the building block definition.
72
72
73
73
🎉 The GitHub Repository Building Block Definition is ready!
74
74
75
75
## 2. GitHub Actions Connector
76
76
77
-
### Preparation
77
+
### Preparing the GitHub Actions Connector
78
78
79
79
This building block definition will interact with both GitHub & AKS, so we need authorization for both.
80
80
@@ -84,11 +84,11 @@ For AKS, you will need to run the Terraform code in the backplane that will set
84
84
85
85
Make sure you save the `config_tf` output and save it as a file called `config.tf`. We will use it later.
86
86
87
-
### Creating the Building Block Definition
87
+
### Creating the GitHub Actions Connector Building Block Definition
88
88
89
89
We will again use the [meshStack Hub](https://hub.meshcloud.io) to create the new building block definition.
90
90
91
-
1. Open the Github Actions Integration with AKS definition in the hub [here](https://hub.meshcloud.io/definitions/aks-github-connector).
91
+
1. Open the Github Actions Integration with AKS definition in the meshStack hub [here](https://hub.meshcloud.io/definitions/aks-github-connector).
92
92
2. Click on “Add to meshStack” and enter your meshStack URL (if not given already).
93
93
3. Continue the flow in meshStack.
94
94
1. Right away you will be asked for a “Type”. Pick “Tenant Building Block” here and select “AKS” as the supported platform.
@@ -98,8 +98,8 @@ We will again use the [meshStack Hub](https://hub.meshcloud.io) to create the ne
98
98
2.`github_repo` - This refers to the GitHub repository to connect to. Open this up and set the “Source” to “Parent Building Block Output” and set the corresponding output to “repo_name”.
99
99
3.`GITHUB_APP_ID` - This is the value saved under “Preparation” step 1b from the previous building block definition
100
100
4.`GITHUB_APP_INSTALLATION_ID` - This is the value saved under “Preparation” step 2b from the previous building block definition
101
-
5.`GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a from the previous building block definition
102
-
6. Create a new input called [`config.tf`](http://config.tf) and set the Source to “Static” and the Type to “File”. Mark the input as encrypted and upload the config.tf file from the preparation step.
101
+
5.`GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a from the previous building block definition. Take the entire content of the file and paste it in here.
102
+
6. Create a new input called `config.tf` and set the Source to “Static” and the Type to “File”. Mark the input as encrypted and upload the config.tf file from the preparation step.
103
103
4. Finish the flow and create the building block definition.
104
104
105
105
🎉 The GitHub Actions Connector Building Block Definition is ready!
@@ -114,12 +114,12 @@ We will create resources within meshStack. This means we need an API Key to inte
114
114
115
115
- Create a new API Key in meshStack in the Admin Area. Make sure you save the **API key ID** & **API key secret** somewhere, as you’ll need it later.
116
116
- Give it the following permissions:
117
-
- “Admin: Create and Update Building Blocks in any Workspace”
118
-
- “Admin: List Building Blocks in any Workspace”
119
-
- “Admin: Create and Update Projects in any Workspace”
120
-
- “Admin: List Projects in any Workspace”
121
-
- “Admin: Create and update Tenants in any Workspace as well as import existing platform tenants”
122
-
- “Admin: List Tenants in any Workspace”
117
+
- “Admin: Create and Update Building Blocks in any Workspace”
118
+
- “Admin: List Building Blocks in any Workspace”
119
+
- “Admin: Create and Update Projects in any Workspace”
120
+
- “Admin: List Projects in any Workspace”
121
+
- “Admin: Create and update Tenants in any Workspace as well as import existing platform tenants”
122
+
- “Admin: List Tenants in any Workspace”
123
123
124
124
### Creating the Building Block Definition
125
125
@@ -290,10 +290,10 @@ You can also change the behavior if you want in this starter kit. In its current
290
290
```
291
291
292
292
- Create a new building block definition in meshStack. Make sure you set the following:
293
-
- Type = Workspace Building Block
294
-
- Implementation Type = Terraform
295
-
- For the inputs you will have to enter an API key ID & API key secret for the meshStack API user you created before.
293
+
- Type = Workspace Building Block
294
+
- Implementation Type = Terraform
295
+
- For the inputs you will have to enter an API key ID & API key secret for the meshStack API user you created before.
296
296
297
-
## What’s next?
297
+
## What’s Next?
298
298
299
299
- [Publish all building blocks](./marketplace.service-management-area.md#publishing) so anyone in the organization can use it and provision namespaces in self-service.
0 commit comments