diff --git a/README.md b/README.md index 6d59c45bb1a904488ce60cae51eca6dc4be53ce7..2ececa958ae807e143769ffcc31323f89770d4ee 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,43 @@ -# Dev tips +# Branch "helm" - Project shiny-k8s + +## Definition + +For Developer,this branch is dedicated to the templates to deploy an Shiny application in kubernetes using helm, along with its CI configuration ( /.gitlab-ci.yml ) which package the templates and expose them in the [package registry](https://gitlab.pasteur.fr/hub/shiny-k8s/-/packages). + +Dear User, who develop Shiny application, please go to the dedicated project [shiny-k8s-example](https://gitlab.pasteur.fr/hub/shiny-k8s-example) containing example of using the components developped here. Please follow detailed instructions in the [User Guide](https://hub.pages.pasteur.fr/shiny-k8s/user_guide/index.html) + +## How to use ( Developer only) To build a package locally, and test it with the example project, you can do: + ```sh helm package shiny-k8s-toolkit-helm -d ../*shiny-k8s-example-python/chart/charts/ helm package shiny-k8s-toolkit-helm -d ../*shiny-k8s-example-r/chart/charts/ ``` -It will store the package in the appropriate folder, and when you will run +It will store the package in the appropriate folder, and when you will run `./dohelm.sh` the newest version will be used. Don't forget to increment the version counter in shiny-k8s-toolkit-helm/Chart.yaml + +## Project Goal + +To help members of Bioinformatic & Biostatistic Hub and Institut Pasteur to correctly and easily deploy a web application, developed in Shiny ( with R or Python), under a Kubernetes cluster managed by the IT department, we have developed the shiny-k8s-toolkit using gitlab projects containig all the components to be used by user or developper to deploy their application. + +Dear User, who develop Shiny application, please go to the dedicated project [shiny-k8s-example](https://gitlab.pasteur.fr/hub/shiny-k8s-example) containing example of using the components developped here. Please follow detailed instructions in the [User Guide](https://hub.pages.pasteur.fr/shiny-k8s/user_guide/index.html) + +Dear Developer,you can stay here if you want to know how the shiny-k8s-toolkit is built. More information for developer in the [Developer Guide](https://hub.pages.pasteur.fr/shiny-k8s/developer_guide/index.html) + +## Project Structure + +This project use orphan branch concept [^1] to manage the different ressources using according to the usage. + +```ini +shiny-k8s + ├── main + ├── helm ### Dedicated Orphan branch to store helm template and help to manage the kubernetes configuration + ├── docker-images ### Dedicated orphan branch to build docker images will be used in examples + └── docs ### Dedicated orphan branch to host the sphinx documentation of toolkit +``` + +[^1]: [git definition](https://git-scm.com/docs/git-checkout/2.14.6#Documentation/git-checkout.txt---orphanltnewbranchgt)