From 1f0ea4153ace15257f95daaf2a76117b1c8cb013 Mon Sep 17 00:00:00 2001 From: cmoulliard Date: Tue, 31 Oct 2023 14:48:01 +0100 Subject: [PATCH] Addind a TOC and developer section Signed-off-by: cmoulliard --- README.md | 35 ++++++++++++++++++++++++++++++++++- pkg/kind/resources/kind.yaml | 1 - 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a6af065c..d2c03131 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ +Table of Contents +================= + +* [IDP Builder](#idp-builder) + * [About](#about) + * [Quickstart](#quickstart) + * [Build](#build) + * [Run](#run) + * [Use](#use) + * [Architecture](#architecture) + * [Kind cluster](#kind-cluster) + * [Localbuild](#localbuild) + * [Gitserver](#gitserver) + * [Embedded Argo Apps](#embedded-argo-apps) + * [Diagram](#diagram) + * [To start developing](#to-start-developing) +* [Extending the IDP builder](#extending-the-idpbuilder) + # IDP Builder Internal development platform binary launcher. @@ -73,7 +91,22 @@ As you can imagine each of these apps are are deployed by ArgoCD to the Kind clu [Excalidraw diagram here:](https://excalidraw.com/#json=MNOQf_OeLtKYe_Y80Bt2l,AP-ftLAwZoDWjp2yudnMKA) - +## To start developing + +If you want to contribute and extend the existing project, make sure that you have installed go (>= 1.20) and cloned this project. +Next, you can build it `make` or launch the `main.go` within your IDE or locally `./idpbuilder`. + +You can override the kind configuration generated by the idpbuilder. For that purpose, look to the +console to grab the config and save it in a file: +```text +########################### Our kind config ############################ +# Kind kubernetes release images https://github.com/kubernetes-sigs/kind/releases +kind: Cluster +apiVersion: kind.x-k8s.io/v1alpha4 +... +######################### config end ############################ +``` +Next, import it `./idpbuilder create --kindConfig ` ## Extending the IDP builder In the future we hope to allow for a pluggable interface to allow for extending the IDP builder with additional argo apps. For now you simply need to add additional apps in the [Embedded Apps](https://github.com/cnoe-io/idpbuilder/blob/4b0f8ecdd7266083373da51d5add1bca73e05a33/pkg/apps/resources.go#L20-L32) and also add the resources they will deploy in the `srv` folder: [pkg/apps/srv](https://github.com/cnoe-io/idpbuilder/blob/4b0f8ecdd7266083373da51d5add1bca73e05a33/pkg/apps/srv/) diff --git a/pkg/kind/resources/kind.yaml b/pkg/kind/resources/kind.yaml index a65f4dc1..2b3d8191 100644 --- a/pkg/kind/resources/kind.yaml +++ b/pkg/kind/resources/kind.yaml @@ -1,4 +1,3 @@ -# two node (one workers) cluster config # Kind kubernetes release images https://github.com/kubernetes-sigs/kind/releases kind: Cluster apiVersion: kind.x-k8s.io/v1alpha4