Clés d'importation
Créez une clé pour que le dépôt de votre produit envoie sa documentation vers un espace de connaissances, enregistrez-la comme secret, renouvelez-la ou révoquez-la.
Sur cette page
Une clé d'importation permet au dépôt de votre produit (par exemple sur GitHub) d'envoyer son dossier de documentation vers un espace de Connaissances à chaque modification, sans que personne n'ouvre Elion ITSM. Chaque clé ne sert qu'à un seul espace.
Avant de commencer
Vous devez disposer du niveau administrateur dans Paramètres (rôle Administrateur).
Le centre d'aide doit être activé. Lisez Activer le centre d'aide.
L'espace de Connaissances de destination doit exister. Sa visibilité peut être quelconque ; pour qu'il soit visible dans le centre d'aide, il doit être Public et inclus.
Vous devez avoir l'autorisation d'ajouter des secrets dans le dépôt.
Créer une clé
Ouvrez Paramètres → Centre d'aide et l'onglet Importation.
Dans la carte Clés d'importation, choisissez l'espace dans Espace. La liste affiche d'abord les espaces inclus dans le centre d'aide.
Cliquez sur Créer une clé.
Dans Nouvelle clé pour…, remplissez :
Champ
Quoi saisir
Nom
Un repère pour la reconnaître ensuite, par exemple le dépôt : « GitHub Action des manuels ».
Expire
Dans 90 jours, Dans 180 jours, Dans un an (l'option par défaut) ou Sans expiration.
Cliquez sur Créer une clé.
La fenêtre Clé créée s'ouvre avec la clé complète. Elle commence par ul_kb_.
Cliquez sur Copier la clé.
Collez-la immédiatement dans le secret du dépôt (voir plus bas).
Cliquez sur C'est fait, je l'ai copiée.
La clé n'est affichée qu'une seule fois. Une fois la fenêtre fermée, elle ne peut plus être affichée : la liste n'en garde que le début, comme ul_kb_a1b2c3d4e5f6_…. Si vous la perdez, renouvelez-la. Ne l'écrivez ni dans le YAML, ni dans le code, ni dans un message.
Chaque espace accepte 5 clés valides au maximum. Si vous atteignez la limite, vous verrez L'espace a déjà 5 clés valides : révoquez-en une avant d'en créer une autre.
Enregistrer la clé dans le dépôt
Sur GitHub :
Dans le dépôt, ouvrez Settings → Secrets and variables → Actions.
Cliquez sur New repository secret.
Dans le nom, saisissez
ARGUNIS_KB_IMPORT_KEY.Dans la valeur, collez la clé.
Enregistrez le secret.
La GitHub Action
La carte GitHub Action fournit le fichier prêt à copier, avec l'adresse exacte d'Elion ITSM. Cliquez sur Copier le YAML et enregistrez-le dans le dépôt sous .github/workflows/argunis-itsm-docs.yml.
À chaque modification de la branche main qui touche le dossier docs/usabilidad, l'Action compresse ce dossier et l'envoie vers Elion ITSM avec la clé du secret. Vous pouvez aussi la lancer manuellement depuis l'onglet Actions de GitHub.
Le fichier ressemble à ceci (copiez toujours celui de l'écran, qui contient l'adresse de votre Elion ITSM) :
name: Documentación a Elion ITSM
on:
push:
branches: [main]
paths: ['docs/usabilidad/**']
workflow_dispatch:
permissions:
contents: read
concurrency:
group: argunis-itsm-kb-import
cancel-in-progress: false
jobs:
importar:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v5
- name: Comprimir docs/usabilidad
run: cd docs/usabilidad && zip -qr "$RUNNER_TEMP/docs.zip" .
- name: Subir a Elion ITSM
env:
ARGUNIS_KB_IMPORT_KEY: ${{ secrets.ARGUNIS_KB_IMPORT_KEY }}
run: |
curl --fail-with-body -sS -X POST \
-H "Authorization: Bearer $ARGUNIS_KB_IMPORT_KEY" \
-F "file=@$RUNNER_TEMP/docs.zip;type=application/zip" \
"https://api-itsm.argunis.com/api/kb/import?ref=$GITHUB_SHA"La préparation du dossier docs/usabilidad est expliquée dans Importer la documentation depuis un dépôt.
La liste des clés
Le tableau affiche les clés de l'espace choisi :
Colonne | Ce qu'elle affiche |
|---|---|
Nom | Le nom, qui l'a créée et quand. |
Clé | Le début de la clé, pour la reconnaître. |
État | valide, expirée ou révoquée. Une clé renouvelée indique en plus renouvelée : cesse de fonctionner à l'expiration. |
Dernière utilisation | La date de la dernière utilisation, ou jamais. |
Expire | La date d'expiration, ou sans expiration. |
Renouveler une clé
Renouvelez une clé quand vous l'avez perdue, quand une personne qui la connaissait a quitté l'équipe ou avant son expiration. Le renouvellement n'interrompt pas les importations.
Cliquez sur Renouveler pour la clé.
Confirmez avec Renouveler.
Dans Nouvelle clé de « … », cliquez sur Copier la clé et remplacez la valeur du secret
ARGUNIS_KB_IMPORT_KEYdans le dépôt.Cliquez sur C'est fait, je l'ai copiée.
La nouvelle clé conserve le nom, l'espace et la durée. L'ancienne reste valable 24 heures, le temps de modifier le secret ; ensuite, elle cesse de fonctionner.
Révoquer une clé
Cliquez sur Révoquer pour la clé.
Confirmez avec Révoquer.
Vous verrez Clé révoquée. Elle cesse immédiatement de fonctionner : la prochaine importation avec cette clé est refusée. La révocation est irréversible ; si vous en avez de nouveau besoin, créez-en une nouvelle.