Sobre a migração do Jenkins com o GitHub Actions Importer
As instruções abaixo orientarão você na configuração do ambiente para usar o GitHub Actions Importer para migrar os pipelines do Jenkins para o GitHub Actions.
Pré-requisitos
-
Uma conta ou uma organização do Jenkins com pipelines e trabalhos que você deseja converter em fluxos de trabalho do GitHub Actions.
-
Acesso para criar um token de API pessoal do Jenkins para sua conta ou sua organização.
-
Um ambiente em que seja possível executar contêineres baseados no Linux e instalar as ferramentas necessárias.
- O Docker está instalado e em execução.
- A CLI do GitHub está instalada.
Observação: a CLI e o contêiner do GitHub Actions Importer não precisam ser instalados no mesmo servidor que a plataforma de CI.
Limitações
Há algumas limitações na migração do Jenkins para o GitHub Actions com o GitHub Actions Importer. Por exemplo, você precisa migrar os seguintes constructos manualmente:
- Ferramentas de build obrigatórias
- Pipelines com script
- Segredos
- Executores auto-hospedados
- Plug-ins desconhecidos
Para obter mais informações sobre migrações manuais, confira "Migrar do Jenkins para o GitHub Actions".
Instalação da extensão da CLI do GitHub Actions Importer
-
Instale a extensão da CLI do GitHub Actions Importer:
Bash gh extension install github/gh-actions-importer
gh extension install github/gh-actions-importer
-
Verifique se a extensão foi instalada:
$ gh actions-importer -h Options: -?, -h, --help Show help and usage information Commands: update Update to the latest version of GitHub Actions Importer. version Display the version of GitHub Actions Importer. configure Start an interactive prompt to configure credentials used to authenticate with your CI server(s). audit Plan your CI/CD migration by analyzing your current CI/CD footprint. forecast Forecast GitHub Actions usage from historical pipeline utilization. dry-run Convert a pipeline to a GitHub Actions workflow and output its yaml file. migrate Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.
Como configurar credenciais
O comando configure
da CLI é usado para definir as credenciais e opções obrigatórias para o GitHub Actions Importer ao trabalhar com o Jenkins e o GitHub.
-
Crie um GitHub personal access token. Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".
O token precisa ter o escopo
workflow
.Depois de criar o token, copie-o e salve-o em um local seguro para uso posterior.
-
Crie um token de API do Jenkins. Para obter mais informações, confira Como autenticar clientes com script na documentação do Jenkins.
Depois de criar o token, copie-o e salve-o em um local seguro para uso posterior.
-
No terminal, execute o comando da CLI
configure
do GitHub Actions Importer:gh actions-importer configure
O comando
configure
solicitará que você insira as seguintes informações:- Em "Quais provedores de CI você está configurando?", use as teclas de direção para selecionar
Jenkins
, pressione Espaço para fazer a seleção e pressione Enter. - Em "Personal access token para GitHub", insira o valor do personal access token criado anteriormente e pressione Enter.
- Em "URL base da instância do GitHub", insira a URL da instância do GitHub Enterprise Server e pressione ENTER.
- Em "Personal access token para o Jenkins", insira o valor do token de API pessoal do Jenkins criado anteriormente e pressione ENTER.
- Em "Nome de usuário do Jenkins", insira seu nome de usuário do Jenkins e pressione ENTER.
- Em "URL base da instância do Jenkins", insira a URL da instância do Jenkins e pressione ENTER.
Um exemplo do comando
configure
é mostrado abaixo:$ gh actions-importer configure ✔ Which CI providers are you configuring?: Jenkins Enter the following values (leave empty to omit): ✔ Personal access token for GitHub: *************** ✔ Base url of the GitHub instance: https://github.com ✔ Personal access token for Jenkins: *************** ✔ Username of Jenkins user: admin ✔ Base url of the Jenkins instance: https://localhost Environment variables successfully updated.
- Em "Quais provedores de CI você está configurando?", use as teclas de direção para selecionar
-
No terminal, execute o comando
update
da CLI do GitHub Actions Importer para se conectar ao GitHub Packages Container registry e verificar se a imagem do contêiner foi atualizada para a última versão:gh actions-importer update
A saída do comando será parecida com a mostrada abaixo:
Updating ghcr.io/actions-importer/cli:latest... ghcr.io/actions-importer/cli:latest up-to-date
Executar uma auditoria do Jenkins
Use o comando audit
para obter uma exibição de alto nível de todos os pipelines de um servidor do Jenkins.
O comando audit
executa as seguintes etapas:
- Busca todos os projetos definidos em um servidor do Jenkins.
- Converte cada pipeline no fluxo de trabalho equivalente do GitHub Actions.
- Gera um relatório que resume a possibilidade do nível de integridade e complexidade de uma migração com o GitHub Actions Importer.
Como executar o comando de auditoria
Para executar uma auditoria de um servidor do Jenkins, execute o seguinte comando no terminal:
gh actions-importer audit jenkins --output-dir tmp/audit
Como inspecionar os resultados da auditoria
Os arquivos do diretório de saída especificado contêm os resultados da auditoria. Confira o arquivo audit_summary.md
para ver um resumo dos resultados da auditoria.
O resumo da auditoria contém as seções a seguir.
Pipelines
A seção "Pipelines" contém estatísticas de alto nível sobre a taxa de conversão feita pelo GitHub Actions Importer.
Veja abaixo alguns termos importantes que podem aparecer na seção "Pipelines":
- Os pipelines Bem-sucedidos tiveram 100% dos constructos e itens individuais convertidos automaticamente nos equivalentes do GitHub Actions.
- Os pipelines parcialmente bem-sucedidos tiveram todos os constructos de pipeline convertidos, porém, houve alguns itens individuais que não foram convertidos automaticamente nos GitHub Actions equivalentes.
- Os pipelines Sem suporte são tipos de definição que não têm suporte no GitHub Actions Importer.
- Os pipelines com falha encontraram um erro fatal ao serem convertidos. Isso pode ocorrer por uma das seguintes razões:
- O pipeline foi configurado incorretamente e não é válido no Bamboo.
- O GitHub Actions Importer encontrou um erro interno ao convertê-lo.
- Houve uma resposta de rede malsucedida que tornou o pipeline inacessível, o que geralmente ocorre devido a credenciais inválidas.
Etapas de Build
A seção "Etapas de compilação" contém uma visão geral das etapas de compilação individuais usadas em todos os pipelines e indica quantas delas foram convertidas automaticamente pelo GitHub Actions Importer.
Veja abaixo alguns termos importantes que podem aparecer na seção "Etapas de compilação":
- Uma etapa de compilação conhecida foi convertida automaticamente em uma ação equivalente.
- Uma etapa de compilação desconhecida não foi convertida automaticamente em uma ação equivalente.
- Uma etapa de compilação sem suporte é aquela que:
- Fundamentalmente, não tem suporte no GitHub Actions.
- Foi configurada de maneira incompatível com o GitHub Actions.
- Uma ação é uma lista das ações que foram usadas nos fluxos de trabalho convertidos. Isso pode ser importante para:
- Se você usar o GitHub Enterprise Server, reunir a lista de ações a serem sincronizadas com a sua instância.
- Definir uma lista de permissões no nível da organização das ações que são usadas. Essa lista de ações é abrangente e inclui as ações que as equipes de segurança ou conformidade podem precisar analisar.
Tarefas manuais
A seção "Tarefas manuais" contém uma visão geral das tarefas que o GitHub Actions Importer não consegue executar automaticamente e que precisam ser realizadas de maneira manual.
Veja abaixo alguns termos importantes que podem aparecer na seção "Tarefas manuais":
- Um segredo é um repositório ou um segredo no nível da organização que é usado nos pipelines convertidos. Esses segredos devem ser criados manualmente no GitHub Actions para que os pipelines funcionem de maneira correta. Para obter mais informações, confira "Usar segredos em ações do GitHub".
- Um executor auto-hospedado refere-se a um rótulo de um executor que é referenciado em um pipeline convertido e que não é hospedado no GitHub. Será necessário definir manualmente esses executores para que os pipelines funcionem de maneira correta.
Arquivos
A seção final do relatório de auditoria fornece um manifesto de todos os arquivos que foram gravados em disco durante a auditoria.
Cada arquivo de pipeline tem uma variedade de arquivos contidos na auditoria, incluindo:
- O pipeline original como foi definido no GitHub.
- Todas as respostas de rede usadas para converter o pipeline.
- O arquivo de fluxo de trabalho convertido.
- Rastreamentos de pilha que podem ser usados para solucionar problemas de uma conversão de pipeline com falha.
Além disso, o arquivo workflow_usage.csv
contém uma lista separada por vírgula de todas as ações, todos os segredos e todos os executores usados pelos pipelines convertidos com sucesso. Isso pode ser útil para determinar quais fluxos de trabalho usam quais ações, segredos ou executores e para executar revisões de segurança.
Prever o uso potencial do executor de build
Use o comando forecast
para prever o uso potencial do GitHub Actions calculando métricas de execuções de pipeline concluídas no servidor do Jenkins.
Pré-requisitos para executar o comando de previsão
Para executar o comando forecast
em uma instância do Jenkins, você precisa instalar o plug-in paginated-builds
no servidor do Jenkins. Esse plug-in permite que o GitHub Actions Importer recupere com eficiência os dados históricos de build para trabalhos que têm um grande número de builds. Como o Jenkins não fornece um método para recuperar dados de build paginados, o uso desse plug-in impede tempos limite do servidor do Jenkins que possam ocorrer durante a busca de um grande volume de dados históricos. O plug-in paginated-builds
é de código aberto e expõe um ponto de extremidade da API REST para buscar dados de build em páginas, em vez de tudo de uma vez.
Para instalar o plug-in paginated-builds
:
- Na sua instância do Jenkins, navegue até
https://<your-jenkins-instance>/pluginManager/available
. - Procure o plug-in
paginated-builds
. - Marque a caixa à esquerda e selecione Instalar sem reiniciar.
Como executar o comando de previsão
Para executar uma previsão do uso potencial do GitHub Actions, execute o comando a seguir no terminal. Por padrão, o GitHub Actions Importer inclui os sete dias anteriores no relatório de previsão.
gh actions-importer forecast jenkins --output-dir tmp/forecast
Como inspecionar o relatório de previsão
O arquivo forecast_report.md
no diretório de saída especificado contém os resultados da previsão.
Veja abaixo alguns termos importantes que podem aparecer no relatório de previsão:
- A contagem de trabalhos é o número total de trabalhos concluídos.
- A contagem de pipelines é o número de pipelines exclusivos usados.
- O tempo de execução descreve o tempo gasto por um executor em um trabalho. Essa métrica pode ser usada para auxiliar no plano de custo dos executores hospedados pelo GitHub.
- Ela está correlacionada ao custo possível esperado com o GitHub Actions. Isso pode variar de acordo com o hardware usado para esses minutos. Use a calculadora de preços do GitHub Actions para estimar os custos.
- As métricas de tempo de espera descrevem o tempo gasto por um trabalho aguardando um executor ficar disponível para executá-lo.
- As métricas de trabalhos simultâneos descrevem a quantidade de trabalhos em execução a qualquer momento. Essa métrica pode ser usada para definir o número de executores que você deve configurar.
Além disso, essas métricas são definidas para cada fila de executores no Jenkins. Isso é especialmente útil se há uma combinação de executores hospedados ou auto-hospedados, ou computadores de especificação alta ou baixa, de modo que você possa ver métricas específicas para diferentes tipos de executores.
Executar uma migração de simulação de um pipeline do Jenkins
Use o comando dry-run
para converter um pipeline do Jenkins no fluxo de trabalho equivalente do GitHub Actions.
Como executar o comando de simulação
Use o comando dry-run
para converter um pipeline do Jenkins em um fluxo de trabalho equivalente do GitHub Actions. Uma simulação cria os arquivos de saída em um diretório especificado, mas não abre uma solicitação de pull para migrar o pipeline.
Para executar uma simulação de migração dos pipelines do Jenkins para o GitHub Actions, execute o comando a seguir no terminal, substituindo my-jenkins-project
pela URL do trabalho do Jenkins.
gh actions-importer dry-run jenkins --source-url my-jenkins-project --output-dir tmp/dry-run
Como inspecionar os fluxos de trabalho convertidos
Você pode ver os logs da simulação e os arquivos de fluxo de trabalho convertidos no diretório de saída especificado.
No caso de qualquer item que o GitHub Actions Importer não tenha conseguido converter automaticamente, como etapas de build desconhecidas ou um pipeline parcialmente bem-sucedido, o ideal é criar transformadores personalizados para personalizar ainda mais o processo de conversão. Para obter mais informações, confira "Como estender o Importador de GitHub Actions com transformadores personalizados".
Executar uma migração de produção de um pipeline do Jenkins
Use o comando migrate
para converter um pipeline do Jenkins e abrir uma solicitação de pull com o fluxo de trabalho equivalente do GitHub Actions.
Como executar o comando de migração
Para migrar um pipeline do Jenkins para o GitHub Actions, execute o comando a seguir no terminal, substituindo o valor target-url
pela URL do repositório GitHub Enterprise Server e my-jenkins-project
pela URL do trabalho do Jenkins.
gh actions-importer migrate jenkins --target-url https://github.com/:owner/:repo --output-dir tmp/migrate --source-url my-jenkins-project
A saída do comando inclui a URL para a solicitação de pull que adiciona o fluxo de trabalho convertido ao seu repositório. Um exemplo de uma saída bem-sucedida é semelhante ao seguinte:
$ gh actions-importer migrate jenkins --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --source-url http://localhost:8080/job/monas_dev_work/job/monas_freestyle
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'
Como inspecionar a solicitação de pull
A saída de uma execução bem-sucedida do comando migrate
contém um link para a nova solicitação de pull que adiciona o fluxo de trabalho convertido ao seu repositório.
Alguns elementos importantes da solicitação de pull incluem:
- Na descrição da solicitação de pull, uma seção chamada Etapas manuais, que lista as etapas que você precisa concluir manualmente para concluir a migração dos pipelines para o GitHub Actions. Por exemplo, esta seção pode solicitar a criação dos segredos usados nos fluxos de trabalho.
- O arquivo de fluxos de trabalho convertido. Selecione a guia Arquivos alterados na solicitação de pull para ver o arquivo de fluxo de trabalho que será adicionado ao repositório do GitHub Enterprise Server.
Quando terminar de inspecionar a solicitação de pull, mescle-a para adicionar o fluxo de trabalho ao repositório do GitHub Enterprise Server.
Referência
Esta seção contém informações de referência sobre variáveis de ambiente, argumentos opcionais e sintaxe com suporte ao usar o GitHub Actions Importer para a migração do Jenkins.
Usando variáveis de ambiente
O GitHub Actions Importer usa variáveis de ambiente para a configuração de autenticação. Essas variáveis são definidas durante o processo de configuração com o comando configure
. Para obter mais informações, confira a seção "Como configurar as credenciais".
O GitHub Actions Importer usa as seguintes variáveis de ambiente para se conectar à instância do Jenkins:
-
GITHUB_ACCESS_TOKEN
: o personal access token usado para criar solicitações de pull com um fluxo de trabalho convertido (exige os escoposrepo
eworkflow
). -
GITHUB_INSTANCE_URL
: a URL para a instância de destino do GitHub (por exemplo,https://github.com
). -
JENKINS_ACCESS_TOKEN
: o token de API do Jenkins usado para exibir recursos do Jenkins.Observação: esse token exige acesso a todos os trabalhos que você deseja migrar ou auditar. Nos casos em que uma pasta ou um trabalho não herda as listas de controle de acesso dos pais, você precisa conceder permissões explícitas ou privilégios de administrador completos.
-
JENKINS_USERNAME
: o nome de usuário da conta de usuário que criou o token de API do Jenkins. -
JENKINS_INSTANCE_URL
: a URL da instância do Jenkins. -
JENKINSFILE_ACCESS_TOKEN
(Opcional) O token de API usado para recuperar o conteúdo de umJenkinsfile
armazenado no repositório de build. Isso exige o escoporepo
. Se isso não for fornecido, oGITHUB_ACCESS_TOKEN
será usado no lugar dele.
Essas variáveis de ambiente podem ser especificadas em um arquivo .env.local
carregado pelo GitHub Actions Importer quando ele é executado.
Como usar argumentos opcionais
Há argumentos opcionais que você pode usar com os subcomandos do GitHub Actions Importer para personalizar sua migração.
--source-file-path
Use o argumento --source-file-path
com os subcomandos forecast
, dry-run
ou migration
.
Por padrão, o GitHub Actions Importer busca o conteúdo do pipeline no controle do código-fonte. O argumento --source-file-path
instrui o GitHub Actions Importer a usar o caminho do arquivo de origem especificado. Use essa opção para pipelines de Jenkinsfile e de vários branches.
Caso você deseje fornecer vários arquivos de origem ao executar o subcomando forecast
, use padrões correspondentes no valor do caminho do arquivo. Por exemplo, o gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json
fornece ao GitHub Actions Importer todos os arquivos de origem que correspondem ao caminho do arquivo ./tmp/previous_forecast/jobs/*.json
.
Exemplo de pipeline do Jenkinsfile
Neste exemplo, o GitHub Actions Importer usa o Jenkinsfile especificado como o arquivo de origem a fim de executar uma simulação.
gh actions-importer dry-run jenkins --output-dir path/to/output/ --source-file-path path/to/Jenkinsfile --source-url :url_to_jenkins_job
--config-file-path
Use o argumento --config-file-path
com os subcomandos audit
, dry-run
e migrate
.
Por padrão, o GitHub Actions Importer busca o conteúdo do pipeline no controle do código-fonte. O argumento --config-file-path
instrui o GitHub Actions Importer a usar o caminho dos arquivos de origem especificados.
Quando você usa a opção --config-file-path
com os subcomandos dry-run
ou migrate
, o GitHub Actions Importer corresponde o campo de dados dinâmico do repositório com o trabalho representado pela opção --source-url
para selecionar o pipeline. Ele usa o config-file-path
para efetuar pull do arquivo de origem especificado.
Exemplo de auditoria
Neste exemplo, o GitHub Actions Importer usa o arquivo de configuração YAML especificado para executar uma auditoria.
gh actions-importer audit jenkins --output-dir path/to/output/ --config-file-path path/to/jenkins/config.yml
Para auditar uma instância do Jenkins usando um arquivo de configuração, o arquivo de configuração precisa estar no seguinte formato e cada valor repository_slug
precisa ser exclusivo:
source_files:
- repository_slug: pipeline-name
path: path/to/Jenkinsfile
- repository_slug: multi-branch-pipeline-name
branches:
- branch: main
path: path/to/Jenkinsfile
- branch: node
path: path/to/Jenkinsfile
Sintaxe com suporte para pipelines do Jenkins
As tabelas a seguir mostram o tipo de propriedades que o GitHub Actions Importer pode converter no momento. Para obter mais detalhes sobre como a sintaxe do pipeline do Jenkins se alinha ao GitHub Actions, confira "Migrar do Jenkins para o GitHub Actions".
Para obter informações sobre os plug-ins do Jenkins com suporte, confira o repositório github/gh-actions-importer
.
Sintaxe com suporte para pipelines freestyle
Jenkins | GitHub Actions | Status |
---|---|---|
modelo do Docker | jobs.<job_id>.container | Com suporte |
compilar | jobs | Suporte parcial |
compilar ambiente | env | Suporte parcial |
gatilhos de build | on | Suporte parcial |
geral | runners | Suporte parcial |
Sintaxe com suporte para pipelines Jenkinsfile
Jenkins | GitHub Actions | Status |
---|---|---|
docker | jobs.<job_id>.container | Com suporte |
preparar | jobs.<job_id> | Com suporte |
agente | runners | Suporte parcial |
environment | env | Suporte parcial |
fases | jobs | Suporte parcial |
etapas | jobs.<job_id>.steps | Suporte parcial |
gatilhos | on | Suporte parcial |
when | jobs.<job_id>.if | Suporte parcial |
entradas | inputs | Sem suporte |
matriz | jobs.<job_id>.strategy.matrix | Sem suporte |
opções | jobs.<job_id>.strategy | Sem suporte |
parâmetros | inputs | Sem suporte |
Sintaxe das variáveis de ambiente
O GitHub Actions Importer usa o mapeamento da tabela abaixo para converter variáveis de ambiente padrão do Jenkins no equivalente mais próximo do GitHub Actions.
Jenkins | GitHub Actions |
---|---|
${BUILD_ID} | ${{ github.run_id }} |
${BUILD_NUMBER} | ${{ github.run_id }} |
${BUILD_TAG} | ${{ github.workflow }}-${{ github.run_id }} |
${BUILD_URL} | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |
${JENKINS_URL} | ${{ github.server_url }} |
${JOB_NAME} | ${{ github.workflow }} |
${WORKSPACE} | ${{ github.workspace }} |
Aviso legal
Partes foram adaptadas do https://github.com/github/gh-actions-importer/ de acordo com a licença MIT:
MIT License
Copyright (c) 2022 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.