Official documentation: https://hub.pages.pasteur.fr/rshiny-k8s/
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 [rshiny-k8s-example](https://gitlab.pasteur.fr/hub/rshiny-k8s-example) contains example of using the components developped here.
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 rshiny-k8s
## Project shiny-k8s
### Branch main
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/rshiny-k8s/container_registry).
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
See orphan branch ["helm"](https://gitlab.pasteur.fr/hub/rshiny-k8s/-/tree/helm).
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/rshiny-k8s/-/packages).
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/rshiny-k8s/-/tree/docs).
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/rshiny-k8s/)
For Developer, branch dedicated to write the complete documentation under sphinx (available on https://hub.pages.pasteur.fr/shiny-k8s/)
Note: it is an orphan branch, do not try to merge it with main, it have no sense and would cause trouble.
## Project rshiny-k8s-example
See ["rshiny-k8s-example"](https://gitlab.pasteur.fr/hub/rshiny-k8s-example)
## Project shiny-k8s-example
See ["shiny-k8s-example"](https://gitlab.pasteur.fr/hub/shiny-k8s-example)
For user only, with simplified configuration files and a template to "deploy" your Shiny application on the kube.
Contains several examples of Shiny application templates
The image used is based on the previous image created in the "rshiny-k8s" project
Use the Helm configuration of the "rshiny-k8s-helm" project
The image used is based on the previous image created in the "shiny-k8s" project
Use the Helm configuration of the "shiny-k8s-helm" project
## Workflows
...
...
@@ -61,4 +61,4 @@ This workflow described all steps to follow in order to deploy your app under ku
## Documentation
More information, see [Documentation](https://hub.pages.pasteur.fr/rshiny-k8s/)
\ No newline at end of file
More information, see [Documentation](https://hub.pages.pasteur.fr/shiny-k8s/)
