|
1 | 1 | # Build Zitadel Dev Docker Images
|
2 | 2 |
|
3 |
| -To enhance developer experience, we prepare the Zitadel development docker images with all necessary configurations. |
4 |
| -The developer will have to simply start these application and database docker containers and |
5 |
| -then the environment is ready to use without any additional configuration. |
| 3 | +To enhance the developer experience, we prepare the Zitadel development docker images with all necessary configurations. |
| 4 | +The developer will have to simply start these application and database docker containers and |
| 5 | +then the environment is ready to use without any additional configuration. |
6 | 6 |
|
7 | 7 | ## Image Build Job
|
8 | 8 |
|
9 |
| -The GitHub action [build-dev-images](../../../.github/workflows/build-zitadel-dev-images.yml) builds the necessary images |
| 9 | +The GitHub action [build-dev-images](../../../.github/workflows/build-zitadel-dev-images.yml) builds the necessary |
| 10 | +images |
10 | 11 | and uploads it to the GitHub packages and also uploads all configuration details to action artifacts.
|
11 | 12 |
|
12 |
| -> Images will be always simply built with 'latest' tag. |
| 13 | +> Images will always be simply built with 'latest' tag. |
13 | 14 |
|
14 | 15 | ## Configure Client Systems
|
15 | 16 |
|
16 |
| -Whenever this job is executed, the images generated will contain new information for all clients. |
17 |
| -Hence, it is necessary for the developer to also update the following files whenever a new image is created |
18 |
| -and also inform team that the latest images must be pulled. |
| 17 | +Whenever this job is executed, the images generated will contain new information for all clients. |
| 18 | +Hence, it is necessary for the developer to also update the following files whenever a new image is created |
| 19 | +and also inform the team that the latest images must be pulled. |
19 | 20 |
|
20 | 21 | - [xpanse UI auth config](https://github.com/eclipse-xpanse/xpanse-ui/blob/main/.env.zitadel-local)
|
21 | 22 | - [xpanse app auth config](https://github.com/eclipse-xpanse/xpanse/blob/main/runtime/src/main/resources/application-zitadel.properties)
|
22 | 23 |
|
23 | 24 | ## Building Images Locally
|
24 | 25 |
|
25 |
| -If necessary to build the images locally, then the following steps must be followed. |
| 26 | +If necessary to build the images locally, then the following steps must be followed. |
26 | 27 |
|
27 | 28 | ```shell
|
28 | 29 | docker build -t custom-pg-db:latest .
|
29 | 30 | docker compose up -d
|
30 | 31 | ```
|
31 |
| -Wait for the server to be up and the service account key to be generated under `machinekey` folder. |
| 32 | + |
| 33 | +Wait for the server to be up and the service account key to be generated under `machinekey` folder. |
32 | 34 | Then copy the service account key to `terraform` folder and then apply changes.
|
33 | 35 |
|
| 36 | +> [!CAUTION] |
| 37 | +> If there are any existing terraform state files in the folder, they must be removed before running. |
| 38 | +
|
34 | 39 | ```shell
|
35 | 40 | cd ../../terraform
|
36 |
| -cp ../../build/machinekey/zitadel-machine.sa.json . |
| 41 | +cp ../local/build/machinekey/zitadel-admin-sa.json . |
37 | 42 | terraform apply -var-file=environments/local.tfvars -auto-approve
|
38 | 43 | ```
|
0 commit comments