From 0d3b2b5a27512d0a4d3d238a322f8a416cbee018 Mon Sep 17 00:00:00 2001 From: Kristian Lyngstol Date: Wed, 23 Jan 2019 14:59:32 +0100 Subject: Add document for git-split Bah, forgot to use English. Use google translate if you so require. --- doc/gondul-git-split.rst | 60 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/gondul-git-split.rst (limited to 'doc/gondul-git-split.rst') diff --git a/doc/gondul-git-split.rst b/doc/gondul-git-split.rst new file mode 100644 index 0000000..4911626 --- /dev/null +++ b/doc/gondul-git-split.rst @@ -0,0 +1,60 @@ +================ +Ny repo-struktur +================ + +Motivasjon +========== + +Vi ønsker å dele opp gondul-repoet i mindre blokker, hensikten bak splitten +er delt: + +- Klarere skille mellom ellers uavhengige komponenter +- Enklere utvikling for alle +- Deployment forenkles ved å ha det i et eget repo, og at hvert repo kan + levere en faktisk pakke som installeres om ønskelig. +- Lettere å fryse enkelt-komponenter i forkant av arrangement. + + + +Nye repo +======== + +- Templating +- Front - inkluderer web/{js,img,fonts,css} og web/index.html +- lib - inkluderer include/ - Målet er nok å endre denne, da det ikke + egentlig er voldsomt overlapp mellom API og collectors, men inntill + videre er det eget repo. +- api - inkluderer web/api +- collectors - inkluderer collectors/ +- gondul/ - inkluderer ansible, dokumentasjon, default config. + + +På sikt er målet at API er det eneste som snakker med postgres, men inntill +videre vil fortsatt collectors snakke direkte. Collectors kan i prinsippet +deles yttligere opp om det ønskes, men det blir mye små-repoer. + +Navn: + +gondul-templating +gondul-frontend +gondul-api +gondul-collectors +gondul + +Repoet som da heter "gondul" blir "master-repo" og et slags +integrasjonsrepo. Det kan potensielt bli delt mer på sikt for å skille +ansible-saker fra dokumentasjon mm. Dette venter vi med for å unngå +usedvanlig mye fragmentering. + +Installasjon +============ + +Alt installeres default i /opt/$gondul-repo - Det vil være opp til +master-repoet å binde ting sammen. Det vil typisk bety at apache/nginx +settes opp for å levere statisk innhold for front og i dag levere CGI for +API, templating settes opp på egen port - Varnish vil da sørge for faktisk +ruting. + +Enkelt-repoer vil det være naturlig at leverer sin egen installasjonsrutine. +På sikt: Debian-pakker. Her er det viktigere for noen komponenter enn andre. + -- cgit v1.2.3 From 48ea18352bbf9dbfabe6fbce09ff6e6c9fa6d8f2 Mon Sep 17 00:00:00 2001 From: Simen Linderud Date: Wed, 23 Jan 2019 16:18:05 +0100 Subject: Markdown edits --- doc/gondul-git-split.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/gondul-git-split.rst') diff --git a/doc/gondul-git-split.rst b/doc/gondul-git-split.rst index 4911626..bded55a 100644 --- a/doc/gondul-git-split.rst +++ b/doc/gondul-git-split.rst @@ -36,9 +36,13 @@ deles yttligere opp om det ønskes, men det blir mye små-repoer. Navn: gondul-templating + gondul-frontend + gondul-api + gondul-collectors + gondul Repoet som da heter "gondul" blir "master-repo" og et slags -- cgit v1.2.3 From af9857d2e9c8c0506afe7a3afc1125fedae9c84a Mon Sep 17 00:00:00 2001 From: Kristian Lyngstol Date: Thu, 24 Jan 2019 15:34:53 +0100 Subject: Minor tweaks on gondul-git-split --- doc/gondul-git-split.rst | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) (limited to 'doc/gondul-git-split.rst') diff --git a/doc/gondul-git-split.rst b/doc/gondul-git-split.rst index bded55a..e4fd155 100644 --- a/doc/gondul-git-split.rst +++ b/doc/gondul-git-split.rst @@ -28,22 +28,17 @@ Nye repo - collectors - inkluderer collectors/ - gondul/ - inkluderer ansible, dokumentasjon, default config. - På sikt er målet at API er det eneste som snakker med postgres, men inntill videre vil fortsatt collectors snakke direkte. Collectors kan i prinsippet deles yttligere opp om det ønskes, men det blir mye små-repoer. Navn: -gondul-templating - -gondul-frontend - -gondul-api - -gondul-collectors - -gondul +- gondul-templating +- gondul-frontend +- gondul-api +- gondul-collectors +- gondul Repoet som da heter "gondul" blir "master-repo" og et slags integrasjonsrepo. Det kan potensielt bli delt mer på sikt for å skille @@ -59,6 +54,9 @@ settes opp for å levere statisk innhold for front og i dag levere CGI for API, templating settes opp på egen port - Varnish vil da sørge for faktisk ruting. -Enkelt-repoer vil det være naturlig at leverer sin egen installasjonsrutine. -På sikt: Debian-pakker. Her er det viktigere for noen komponenter enn andre. +Alt av "deployment" legges i "gondul"-repoet, men hver enkelt repo kan også +ønske å levere rutiner for isolert installasjon av typen som hører hjemme i +for eksempel en python-pakke eller debian-pakke. + + -- cgit v1.2.3