Official documentation: https://hub.pages.pasteur.fr/shiny-k8s/
## Project Goal
To help hub members to correctly and easily deploy a web application, initially developed in RShiny, under Kubernetes .
You are in the gitlab projects dedicated to all component used to deplopy a Rshiny application in Kubernetes.
The satelite project [shiny-k8s-example](https://gitlab.pasteur.fr/hub/shiny-k8s-example) contains example of using the components developped here.
## Project structure and dependencies
## Project shiny-k8s
### Branch main
## Definition
For the developer, the configuration files to build the initial docker image, along with its CI configuration ( /.gitlab-ci.yml ) which build and expose the image in the [container registry](https://gitlab.pasteur.fr/hub/shiny-k8s/container_registry).
### Branch helm
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)
See orphan branch ["helm"](https://gitlab.pasteur.fr/hub/shiny-k8s/-/tree/helm).
For the developer, the templates to deploy an RShiny 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).
Note: it is an orphan branch, do not try to merge it with main, it have no sense and would cause trouble.
### Branch doc
See orphan branch ["docs"](https://gitlab.pasteur.fr/hub/shiny-k8s/-/tree/docs).
For Developer, branch dedicated to write the complete documentation under sphinx (available on https://hub.pages.pasteur.fr/shiny-k8s/)
## Project Goal
Note: it is an orphan branch, do not try to merge it with main, it have no sense and would cause trouble.
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.
## Project shiny-k8s-example
See ["shiny-k8s-example"](https://gitlab.pasteur.fr/hub/shiny-k8s-example).
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)
For toolkit user only, with provide pre-configured project to "deploy" your Shiny application in kubernetes [in R](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-r) and [in python](https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/tree/base-python).
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
The toolkit uses the image used is based on the previous image created in the "shiny-k8s" project
The toolkit uses the Helm configuration of the "shiny-k8s-helm" project
The toolkit uses the GitlLab CI/CD.
This project use orphan branch concept [^1] to manage the different ressources using according to the usage.
## Documentation
```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