Passa al contenuto principale

Moduli personalizzati

Puoi distribuire il tuo modulo con la tua funzionalità utilizzando l'API per sviluppatori.

Sviluppo​

Utilizza il template https://github.com/OneEntry/module-example e segui le istruzioni in https://github.com/OneEntry/custom-module-deployment-guide durante lo sviluppo.

Costruzione​

  • Crea un nuovo token di progetto con diritti read-registry. Si consiglia di creare un token a tempo indeterminato.
  • Crea un nuovo tag in git (ad ogni rilascio di una nuova versione del modulo)
  • Attendi il completamento della pipeline, dopo di che l'immagine docker del modulo sarà caricata nel registry e disponibile per la distribuzione

Distribuzione​

Vai nelle impostazioni, nella sezione "Moduli" e scorri verso il basso per accedere al modulo di aggiunta.

  • Specifica il nome e il tag del modulo

  • Nel campo Url immagine specifica il percorso all'immagine docker precedentemente costruita nel formato host/user/repo:version.

    Dove host è il nome dell'host del docker registry, ad esempio registry.gitlab.com,

    user è l'id dell'utente o dell'organizzazione, ad esempio oneentry,

    repo è il nome del repository, ad esempio my-module

    version è il nome del tag (versione del modulo)

    Esempio completo: registry.gitlab.com/oneentry-skd-js/test-module:prod-v1.0.10

  • Nel campo Docker host specifica l'host del docker registry, che ripete la parte host nel percorso all'immagine docker, ad esempio registry.gitlab.com

  • Nei campi Id token e Token specifica il nome del token (indicato durante la creazione) e il token stesso (di solito inizia con glpat) rispettivamente

  • Specifica le variabili d'ambiente necessarie (env) richieste per il funzionamento del modulo (puoi modificarle in seguito)

Dopo aver creato il modulo, apparirà nella tabella. Ora puoi distribuirlo cliccando su Deploy (ci vorrà un po' di tempo).

Stati del contenitore​

  • Non distribuito - Il modulo è stato creato, ma non è mai stato distribuito
  • In distribuzione - Il modulo è in fase di distribuzione
  • Avviato - Il modulo è in esecuzione
  • Sospeso - Il modulo è distribuito, ma non è avviato

Azioni sul modulo​

  • Suspend Sospendere il modulo. Ferma il processo, ma i dati rimangono
  • Resume Riprendere il funzionamento del modulo. Avvia il processo
  • Delete Eliminare il modulo. Fermerà il processo, eliminerà il contenitore e i dati ad esso associati

Debug degli errori​

Se il modulo non è riuscito a essere distribuito o il processo termina sistematicamente, vedrai Warn.

Problemi possibili​

  • Immagine docker configurata in modo errato
  • Token non valido o errato
  • Il processo termina. Il processo interno non dovrebbe terminare finché il modulo è attivo

Logging​

Altri problemi con il modulo possono essere risolti utilizzando i log che vengono visualizzati nelle impostazioni del modulo

Aggiornamento/modifica del modulo​

Se è necessario distribuire una nuova versione del modulo o modificare le variabili d'ambiente, devi aggiornare il tag e/o le variabili nelle impostazioni. Il processo verrà riavviato.

.