DocumentaciónAyuda

Llaves de importación

Crea una llave para que el repositorio de tu producto suba su documentación a un espacio de conocimiento, guárdala como secreto, rótala o revócala.

En esta página

Una llave de importación permite que el repositorio de tu producto (por ejemplo, en GitHub) suba su carpeta de documentación a un espacio de Conocimiento en cada cambio, sin que nadie entre a Elion ITSM. Cada llave sirve para un solo espacio.

Antes de empezar

  • Necesitas el nivel de administrador en Configuración (rol Administrador).

  • El centro de ayuda debe estar activado. Lee Activar el centro de ayuda.

  • Debe existir el espacio de Conocimiento donde se importará. Puede ser de cualquier visibilidad; para que se vea en el centro de ayuda, debe ser Pública y estar incluido.

  • Necesitas permiso para agregar secretos en el repositorio.

Crear una llave

  1. Entra a Configuración → Centro de ayuda y abre la pestaña Importación.

  2. En la tarjeta Llaves de importación, elige el espacio en Espacio. La lista muestra primero los espacios incluidos en el centro de ayuda.

  3. Presiona Crear llave.

  4. En Nueva llave para…, completa:

    Campo

    Qué escribir

    Nombre

    Algo para reconocerla después, por ejemplo el repositorio: «GitHub Action de manuales».

    Vence

    En 90 días, En 180 días, En un año (la opción por defecto) o Sin vencimiento.

  5. Presiona Crear llave.

Se abre la ventana Llave creada, con la llave completa. Empieza con ul_kb_.

  1. Presiona Copiar llave.

  2. Pégala de inmediato en el secreto del repositorio (ver más abajo).

  3. Presiona Listo, ya la copié.

La llave se muestra una sola vez. Al cerrar la ventana ya no se puede volver a ver: en la lista solo queda su comienzo, como ul_kb_a1b2c3d4e5f6_…. Si la pierdes, rótala. No la escribas en el YAML, en el código ni en un mensaje.

Cada espacio admite hasta 5 llaves vigentes. Si llegas al tope, verás El espacio ya tiene 5 llaves vigentes: revoca alguna antes de crear otra.

Guardar la llave en el repositorio

En GitHub:

  1. En el repositorio, entra a Settings → Secrets and variables → Actions.

  2. Presiona New repository secret.

  3. En el nombre, escribe ARGUNIS_KB_IMPORT_KEY.

  4. En el valor, pega la llave.

  5. Guarda el secreto.

La GitHub Action

La tarjeta GitHub Action trae el archivo listo para copiar, con la dirección exacta de Elion ITSM. Presiona Copiar YAML y guárdalo en el repositorio como .github/workflows/argunis-itsm-docs.yml.

En cada cambio a la rama main que toque la carpeta docs/usabilidad, la Action comprime esa carpeta y la sube a Elion ITSM con la llave del secreto. También puedes lanzarla a mano desde la pestaña Actions de GitHub.

El archivo se ve así (copia siempre el de la pantalla, que trae la dirección de tu 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"

Cómo preparar la carpeta docs/usabilidad está en Importar documentación desde un repositorio.

La lista de llaves

La tabla muestra las llaves del espacio elegido:

Columna

Qué muestra

Nombre

El nombre, quién la creó y cuándo.

Llave

El comienzo de la llave, para reconocerla.

Estado

vigente, vencida o revocada. Una llave rotada dice además rotada: deja de servir al vencer.

Último uso

Cuándo se usó por última vez, o nunca.

Vence

La fecha de vencimiento, o sin vencimiento.

Rotar una llave

Rota una llave cuando la perdiste, cuando alguien que la conocía dejó el equipo o antes de que venza. La rotación no corta las importaciones.

  1. Presiona Rotar en la llave.

  2. Confirma con Rotar.

  3. En Nueva llave de «…», presiona Copiar llave y reemplaza el valor del secreto ARGUNIS_KB_IMPORT_KEY en el repositorio.

  4. Presiona Listo, ya la copié.

La llave nueva conserva el nombre, el espacio y la duración. La anterior sigue sirviendo 24 horas, para que alcances a cambiar el secreto; después deja de funcionar.

Revocar una llave

  1. Presiona Revocar en la llave.

  2. Confirma con Revocar.

Verás Llave revocada. Deja de servir al instante: la próxima importación con esa llave se rechaza. Revocar no se puede deshacer; si la necesitas otra vez, crea una nueva.

Relacionado

Buscar en Elion ITSM

Escribe al menos 2 letras para buscar en Elion ITSM.

↑↓ moverse · Enter abrir · Esc cerrar