From a847eea426d9f1c1d0cf6ce282507d1834969eeb Mon Sep 17 00:00:00 2001 From: Richard Robert Reitz Date: Thu, 26 Sep 2024 16:38:12 +0200 Subject: [PATCH] Updated idpbuilder install document --- .../tools/idpbuilder/installation/_index.md | 91 ++++++++++++++++--- 1 file changed, 76 insertions(+), 15 deletions(-) diff --git a/content/en/docs/tools/idpbuilder/installation/_index.md b/content/en/docs/tools/idpbuilder/installation/_index.md index 332ff68..9bb482f 100644 --- a/content/en/docs/tools/idpbuilder/installation/_index.md +++ b/content/en/docs/tools/idpbuilder/installation/_index.md @@ -7,17 +7,17 @@ weight = 1 The idpbuilder uses KIND as Kubernetes cluster. It is suggested to use a virtual machine for the installation. MMS Linux clients are unable to execute KIND natively on the local machine because of network problems. Pods for example can't connect to the internet. -Windows and Mac users already utilize a virtual machine for the Linux environment. +Windows and Mac users already utilize a virtual machine for the Docker Linux environment. ### Prerequisites -- Docker +- Docker Engine - Go - kubectl ### Build process -To build idpbuilder the source code can be downloaded and compiled: +For building idpbuilder the source code needs to be downloaded and compiled: ``` git clone https://github.com/cnoe-io/idpbuilder.git @@ -37,7 +37,7 @@ To start the idpbuilder binary execute the following command: ### Logging into ArgoCD -At the end of the idpbuilder execution a link is shown to of the installed ArgoCD. The credentianls for access can be obtained by executing: +At the end of the idpbuilder execution a link of the installed ArgoCD is shown. The credentianls for access can be obtained by executing: ``` ./idpbuilder get secrets @@ -74,7 +74,7 @@ CNOE provides two implementations of an IDP: - Amazon AWS implementation - KIND implementation -Both are not useable to run on bare metal or an OSC instance. The Amazon implementation is complex and make suse of Terraform which is currently not supported by either base metal or OSC. Therefore the KIND implementation is used and customized to support the idpbuilder installation. The idpbuilder is doing some magic which needs to be replicated. +Both are not useable to run on bare metal or an OSC instance. The Amazon implementation is complex and makes use of Terraform which is currently not supported by either base metal or OSC. Therefore the KIND implementation is used and customized to support the idpbuilder installation. The idpbuilder is also doing some network magic which needs to be replicated. Several prerequisites have to be provided to support the idpbuilder on bare metal or the OSC: @@ -84,11 +84,11 @@ Several prerequisites have to be provided to support the idpbuilder on bare meta ### Prerequisites -Talos Linux is choosen for an bare metal Kubernetes instance. +Talos Linux is choosen for a bare metal Kubernetes instance. - talosctl - Go -- Docker +- Docker Engine - kubectl - kustomize - helm @@ -142,9 +142,9 @@ sudo systemctl enable nginx sudo systemctl restart nginx ``` -#### VS Code launch settings for idpbuilder +#### Building idpbuilder -First build idpbuilder from source code: +For building idpbuilder the source code needs to be downloaded and compiled: ``` git clone https://github.com/cnoe-io/idpbuilder.git @@ -154,11 +154,12 @@ go build The idpbuilder binary will be created in the current directory. -Then open the folder in VS Code: +#### Configure VS Code launch settings + +Open the idpbuilder folder in VS Code: ``` code . -cd .. ``` Create a new launch setting. Add the `"args"` parameter to the launch setting: @@ -190,9 +191,49 @@ talosctl cluster create #### Install local path privisioning (storage) ``` +mkdir -p localpathprovisioning cd localpathprovisioning +cat > localpathprovisioning.yaml <