Chaves de importação
Crie uma chave para que o repositório do seu produto envie a documentação a um espaço de conhecimento, guarde-a como segredo, rotacione-a ou revogue-a.
Nesta página
Uma chave de importação permite que o repositório do seu produto (por exemplo, no GitHub) envie a pasta de documentação para um espaço de Conhecimento a cada mudança, sem que ninguém entre no Elion ITSM. Cada chave serve para um único espaço.
Antes de começar
Você precisa do nível de administrador em Configurações (função Administrador).
A central de ajuda deve estar ativada. Leia Ativar a central de ajuda.
O espaço de Conhecimento onde a importação será feita deve existir. Ele pode ter qualquer visibilidade; para aparecer na central de ajuda, deve ser Pública e estar incluído.
Você precisa de permissão para adicionar segredos no repositório.
Criar uma chave
Entre em Configurações → Central de ajuda e abra a aba Importação.
No cartão Chaves de importação, escolha o espaço em Espaço. A lista mostra primeiro os espaços incluídos na central de ajuda.
Clique em Criar chave.
Em Nova chave para…, preencha:
Campo
O que escrever
Nome
Algo para reconhecê-la depois, por exemplo o repositório: “GitHub Action de manuais”.
Vence
Em 90 dias, Em 180 dias, Em um ano (a opção padrão) ou Sem vencimento.
Clique em Criar chave.
Abre-se a janela Chave criada, com a chave completa. Ela começa com ul_kb_.
Clique em Copiar chave.
Cole-a imediatamente no segredo do repositório (veja abaixo).
Clique em Pronto, já copiei.
A chave é mostrada uma única vez. Ao fechar a janela, não é possível vê-la de novo: na lista fica só o começo dela, como ul_kb_a1b2c3d4e5f6_…. Se você a perder, rotacione-a. Não a escreva no YAML, no código nem em uma mensagem.
Cada espaço aceita até 5 chaves vigentes. Se você chegar ao limite, verá O espaço já tem 5 chaves vigentes: revogue alguma antes de criar outra.
Guardar a chave no repositório
No GitHub:
No repositório, entre em Settings → Secrets and variables → Actions.
Clique em New repository secret.
No nome, escreva
ARGUNIS_KB_IMPORT_KEY.No valor, cole a chave.
Salve o segredo.
A GitHub Action
O cartão GitHub Action traz o arquivo pronto para copiar, com o endereço exato do Elion ITSM. Clique em Copiar YAML e salve-o no repositório como .github/workflows/argunis-itsm-docs.yml.
A cada mudança no branch main que altere a pasta docs/usabilidad, a Action compacta essa pasta e a envia ao Elion ITSM com a chave do segredo. Você também pode executá-la manualmente na aba Actions do GitHub.
O arquivo é assim (copie sempre o da tela, que traz o endereço do seu 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"Como preparar a pasta docs/usabilidad está em Importar documentação de um repositório.
A lista de chaves
A tabela mostra as chaves do espaço escolhido:
Coluna | O que mostra |
|---|---|
Nome | O nome, quem a criou e quando. |
Chave | O começo da chave, para reconhecê-la. |
Status | vigente, vencida ou revogada. Uma chave rotacionada diz também rotacionada: deixa de valer ao vencer. |
Último uso | Quando foi usada pela última vez, ou nunca. |
Vence | A data de vencimento, ou sem vencimento. |
Rotacionar uma chave
Rotacione uma chave quando você a perdeu, quando alguém que a conhecia saiu da equipe ou antes de ela vencer. A rotação não interrompe as importações.
Clique em Rotacionar na chave.
Confirme com Rotacionar.
Em Nova chave de “…”, clique em Copiar chave e substitua o valor do segredo
ARGUNIS_KB_IMPORT_KEYno repositório.Clique em Pronto, já copiei.
A chave nova mantém o nome, o espaço e a duração. A anterior continua valendo por 24 horas, para que você consiga trocar o segredo; depois ela deixa de funcionar.
Revogar uma chave
Clique em Revogar na chave.
Confirme com Revogar.
Você verá Chave revogada. Ela deixa de valer na hora: a próxima importação com essa chave será rejeitada. Revogar não pode ser desfeito; se precisar de novo, crie uma nova.