8 FAQ

8.1 Nous contacter

Le lieu privilégié pour communiquer avec nous sur votre application est votre issue dédiée, qui a été ouverte lors de votre demande d’hébergement, vous pouvez la réouvrir si elle est fermée.

Sinon :

Pour signaler un bug à l’équipe Sk8, merci d’ouvrir une issue de signalement de bug sur le support.
Pour nous faire une autre demande, vous pouvez créer une nouvelle issue sur le support (de préférence) ou alors contacter l’équipe SK8 sk8-contact@groupes.renater.fr.

8.2 Questions sur le fonctionnement général de SK8

Comment fonctionne le catalogue ? Quel intérêt ?

Sans passer par le catalogue, vous disposez d’un unique container pour votre application Shiny, tous les utilisateurs se connectent dessus, c’est plus léger pour nos serveurs et plus rapide au démarrage.

Le catalogue SK8 utilise ShinyProxy. En passant par l’url “catalogue” de votre application, pour chaque utilisateur de votre application un nouveau container Docker sera reconstruit. L’avantage est que les utilisateurs constateront moins de latence en utilisant l’application, l’inconvénient est que si votre container Docker est long à lancer, chaque utilisateur devra patienter plus longtemps pour voir l’application démarrer.

Le fonctionnement par catalogue (ShinyProxy) peut être nécessaire pour certaines applications dont les données sont obligatoirement gérées en dehors de l’application (mise à jour des données AVANT le lancement de l’application par exemple) ou causant des problèmes de conflits entre utilisateurs.

NB : il est souvent plus simple si c’est possible (et plus léger en stockage, mémoire, …), de faire un filtre sur les données côté server dans un observe() par exemple, plutôt que d’activer le catalogue.

A noter Par défaut le catalogue n’est pas activé. Il ne le sera que si : 1. vous en faites la demande lors de votre inscription 2. votre application fonctionne déjà sans catalogue. A ce moment là nous activerons le catalogue et nous vous enverrons l’url à partager à vos utilisateurs.

En développement : il sera possible de demander la création d’un catalogue indépendant de celui de SK8 pour votre unité/département/projet de recherche.

Lien vers le catalogue SK8.

J’ai déjà une application existante sous Docker, comment l’intégrer à SK8 ?

Si vous disposez déjà d’une application R-Shiny containerisé avec un Dockerfile, vous n’avez qu’à garder le fichier .gitlab-ci.yml pour intégrer votre application dans SK8.

Si vous disposez déjà d’un fichier .gitlab-ci.yml, il suffit d’ajouter à son contenu celui de SK8. Plus d’information

Le formulaire de demande d’hébergement n’est pas disponible

Si le site https://demande-hebergement.sk8.inrae.fr n’est pas disponible, vous pouvez directement créer une issue sur le support SK8.

J’ai soumis une demande d’hébergement et je n’ai pas de nouvelles, que faire ?

A votre demande d’hébergement une issue a été créée. Vous pouvez aller voir son statut ici : https://forgemia.inra.fr/sk8/sk8-support/-/issues.

Vous pouvez nous écrire un message dans cette issue, toute l’équipe SK8 la recevra.

A noter tout de même que la création de templates dédiée est manuelle en fonction de vos spécifications, et que parfois nous partons en vacances, donc selon la période de l’année ça peut nous prendre un peu de temps pour vous répondre.

Mais si vous n’avez pas de nouvelles au bout de quelques jours vous pouvez évidemment nous contacter !

J’aimerais mettre une licence sur mon code, mais je ne sais pas laquelle je dois utiliser. Un conseil ?

Comme le rappelle le site datapartage d’INRAE, les données produites par les EPST dans le cadre de leur mission de service public (données brutes, données élaborées et métadonnées produites par les salariés de l’établissement ou dans le cadre d’un contrat indiquant que ces données lui appartiennent) sont concernées par la loi dite “CADA” : elles doivent donc être rendues publiques (sauf exceptions légales) et librement réutilisables dès lors qu’elles sont considérées comme achevées.

De ce fait, il est nécessaire d’appliquer une licence ouverte aux données, algorithmes et codes de la recherche.

Pour vous aider à choisir une licence, vous pouvez vous référer à :

Datapartage : Choisir une licence
Les recommandations de la communauté R
Des outils en lignes tels que License selector et Choose a license

Vous devez également être vigilants aux licences de vos dépendances. R et shiny sont sous licence GPL2 / GPL3.

Il n’y a pas réponse universelle, mais les licences GPL3, MIT et CC-BY-SA répondent à la majorité des besoins. Les licences permissives (comme MIT) et copyleft (comme GPL3) autorisent la copie, la modification, la réutilisation et la publication du code. Cependant les licences copyleft sont plus strictes et obligent la distribution du code dans les mêmes conditions.

Vous pouvez ajouter facilement une licence à votre projet depuis R avec usethis::use_*_license(), ou depuis votre dépôt sur la forge, en cliquant sur [+] Add LICENSE.

Est-ce qu’il y a un outil d’analyse de la fréquentation de mon application ?

L’équipe SK8 a fait le choix de développer un service non intrusif, aussi l’utilisation d’outils de suivi n’est pas prévue par nous. En revanche rien ne vous empêche d’utiliser un outil et d’intégrer le morceau de code permettant le suivi dans le code de votre application.

Par exemple la version gratuite de PanelBear a déjà été utilisé avec succès mais dont le service s’arrêtera au 1er mai 2023. Son successeur Cronitor RUM permet avec la version gratuite de monitorer jusque 5 sites.

Pour l’utiliser il vous faut :

Créer un compte
Enregistrer votre site
Copier le snippet javascript fourni dans le dossier www,
Inclure le snippet dans le ui avec la ligne : tags$script(src = "myssnippet.js"),

Pour savoir comment inclure un script javascript dans votre application : https://shiny.rstudio.com/articles/packaging-javascript.html

Stocker des données sous SK8

Actuellement, il n’est pas possible de disposer de données persistantes pour vos applications.
Toutes données générées ou uploadées sur votre application aura une durée de vie éphémère.

Concrétement, l’image Docker générée dans votre projet est instanciée plusieurs fois (containers) dans le cluster SK8 et sont redémarrées automatiquement en cas de problème (plantage…) avec l’image de base.

Du point de vue code RShiny, il est donc préférable d’utiliser une API pour profiter de stockages externes à SK8, type S3 ou bases de données.

Plus d’information ici

Passer des variables à l’image docker de l’application

Lorsque vous accédez à des ressources (données, code) par le d’identifiants d’authentification dans votre application, ceux-ci ne ne doivent pas apparaître en clair dans votre code.

Reportez-vous à cette section pour plus d’informations sur comment intégrer des variables secrètes dans SK8

Est-ce que je peux envoyer des modifications sur une autre branche que main dans mon repository ?

Oui, bien sûr. Les jobs de configuration, eux, sont actifs sur toutes les branches.

En revanche le déploiement ne se fait que sur la branche main. Les jobs du pipeline qui concernent la gestion de l’application (01-Publier, 02-Annuler-dernière-mise-à-jour et 03-Dépublier) et les logs (Recevoir-les-logs-de-mon-app) ne se lancent que sur la branche main du repo.

Puis-je configurer une URL personnalisée pour accéder à mon app ?

L’architecture SK8 n’est pas en mesure de proposer une URL différente de <myapp>.sk8.inrae.fr

Vous pouvez cependant tout à fait envisager une redirection depuis une URL personnalisée. Il suffit de disposer d’un nom de domaine (ticket Ariane) puis de demander une configuration DNS pour que cette URL pointe vers votre application SK8 (ticket Ariane)

Mon application est destinée à être utilisée lors de formations, est-ce un problème ?

Effectivement le cas des formations, avec une application lancée par elève risque de poser probème si l’application est volumineuse.

Plusieurs solutions : - Si l’application est de taille relativement petite, pas de problème mais on vous conseille très fortement de communiquer le lien du catalogue pour votre application, ainsi chaque elève aura son container et les applications des uns et des autres seront isolées.

Si la taille de l’application est plus importante, vous pourriez envisager que les elèves aient accès à l’application en local, chacun sur son poste. Dans ce cas nous recommendons l’accès par Docker. Une fois Docker installé sur la machine de l’elève, il n’y a qu’à lancer la commande docker run -it -p 3838:3838 registry.forgemia.inra.fr/<Chemin du projet>:latest si l’application est publique. C’est préférable à un lancement depuis R car ça évite d’avoir à installer les packages et dépendances, et de résoudre des éventuels problèmes de versions de packages.

Je dois mettre en place une authentification pour accéder à mon application, comment m’y prendre sur SK8 ?

Un atelier à ce sujet lors des journées Shiny::INRAE 2025 peut répondre à vos interrogations. Vous pouvez accéder à la restitution ici.

Comment récupère-t-on les logs de notre application déjà ?

Pour récupérer les logs de votre application, vous pouvez vous référer à la partie Pipeline CI/CD

Pour résumer, il suffit de cliquer dans les taches du CI/CD sur l’action Recevoir-les-logs-de-mon-app qui permettra de recevoir les logs dans votre boite mail.

8.3 Erreurs constatées

J’ai cloné mon repo mais je ne vois pas l’onglet git dans RStudio.

C’est que vous avez dû cloner votre projet en ligne de commande et ne pas créer le projet associé.

Il faut ensuite créer un projet R (depuis RStudio : File > New projet > Existing directory et ne pas oublier de cocher Open in new session en bas à droite).

Vous pouvez maintenant fermer RStudio puis réouvrir votre projet soit en cliquant sur le fichier .Rproj qui a été créé, soit en lançant la commande rstudio monprojet.Rproj.

J’ai une erreur “Impossible de trouver la fonction xxx”

Le package d’où provient la fonction n’est pas détecté.

Vous pouvez utiliser la syntaxe suivante :

NomPackage::NomFonction à chaque appel de fonction, dans tous les codes R (à privilégier)
ou inclure l’appel à la librairie directement dans le fichier global.R: library(NomPackage) Pour une meilleure prise en charge de vos packages R, nous vous conseillons d’utiliser le package renv chez vous en local, et de commiter le fichier renv.lock

Problème error ssh_askpass

Au moment de la création de votre projet versionné via GitHub ou GitLab, vous pouvez rencontrer l’erreur suivante: “error ssh_askpass exec(/usr/bin/ssh-askpass) no such file or directory”. Il manque en fait le paquet ssh-askpass sur votre ordinateur. Sous Ubuntu, il suffit de l’installer via synaptic par exemple ou en ligne de commande avec apt-get:

sudo apt-get install ssh-askpass

Au commit suivant, à l’invitation, il faut taper yes et le problème est résolu.

Erreur Délai de connexion dépassé

Lors de la création de l’image Docker, il arrive que certains services soient temporairement inaccessibles.

Exemple :

W: Impossible de récupérer http://deb.debian.org/debian/dists/testing/InRelease  Délai de connexion dépassé [IP : 199.232.82.132 80]
W: Le téléchargement de quelques fichiers d'index a échoué, ils ont été ignorés, ou les anciens ont été utilisés à la place.

Généralement, relancer le job en question permet de résoudre le problème.

Le statut de mon job “01_Publier” affiche un succès mais mon application n’est pas visible, que faire ?

A noter que le premier déploiement peut prendre quelques dizaines de minutes.

Vous devriez aussi avoir reçu un mail à la fin du job, si ça n’est pas le cas, allez voir les logs (cliquer sur le nom du job).

Si rien n’apparait de suspect à ce niveau, vous pouvez lancer le job “Recevoir-les-logs-de-mon-app” pour recevoir les logs de déploiement par mail.

Le statut de mon job “01_Publier” affiche un succès mais je ne vois pas ma mise à jour

Il se peut que le job se soit déroulé intégralement mais qu’il y ait eu des erreurs ou warnings à son exécution.

De plus vous devriez avoir reçu un mail à la fin du job, si ça n’est pas le cas, allez voir les logs.

Pour voir les logs, cliquer sur le nom du job.

Si rien n’apparait de suspect à ce niveau, vous pouvez lancer le job “Recevoir-les-logs-de-mon-app” pour recevoir les logs de déploiement par mail.

Comment uploader des fichiers volumineux dans mon application ? (‘Maximum upload size exceeded’)

Au début de votre fichier server.R, vous pouvez rajouter ce code :

options(shiny.maxRequestSize = 20*1024^2)

(ici augmente la limite à 20MB).

Mes logs sont vides, le fichier indique __"No logs"__

Cela se produit généralement quand votre application n’est pas en ligne.
Il suffit d’activer la tâche 01-Publier dans le CI/CD.

Dans mon pipeline je ne vois que les 2 jobs Configuration et Construire l'application.

Les jobs du pipeline qui concernent la gestion de l’application (01-Publier, 02-Annuler-dernière-mise-à-jour et 03-Dépublier) et les logs (Recevoir-les-logs-de-mon-app) ne se lancent que sur la branche main du repo. Pour pouvoir envoyer l’appplication sur un noeud kubernetes et ainsi la déployer, merci de passer (fusionner) votre code sur la branche main.

Project sk8/sk8-conf/sk8-template-ci not found or access denied!

Le pipeline CI/CD ne se lancera pas si votre push est effectué par le biais d’un token qui n’est pas un “personnal access token”. Ce sera par exemple le cas lors de push effectués par des logiciels tels que Github Desktop.

Le pipeline CI/CD ne peut être lancé que par votre compte, d’où l’erreur de type access denied