spiffe/spire

Migrate from HCL1 to HCL2

Aberta

#4.042 aberto em 3 de abr. de 2023

Ver no GitHubGuia do colaborador
 (13 comentários) (0 reação) (0 responsável)Go (631 forks)auto 404
help wantedpriority/backlog

Métricas do repositório

Stars
 (2.443 estrelas)
Métricas de merge de PR
 (Mesclagem média 9d 14h) (44 fundiu PRs em 30d)

Description

HCL1 has been deprecated and unmaintained for quite some time. Further, there are bugs and non-deterministic behavior that has caused us issue from time to time. We could benefit from moving from hcl1 to hcl2. Unfortunately the syntax is not fully backwards compatible. We need a solid plan to migrate folks from hcl1 to hcl2.

Acceptance criteria:

  • Configuration syntax changes as minimal as possible
  • Deterministically detect if someone is configuring via hcl1 or hcl2
  • Provide a way to emit hcl2 from hcl1 to aid in auto-migration
  • Eventual deprecation plan for hcl1 support (we can and should probably continue to support hcl1 for some time)

Guia do colaborador

Direção de pesquisa
Familiarize se com a análise de configuração HCL1 existente no código. Projete um método para detectar se uma configuração está na sintaxe HCL1 ou HCL2 (por exemplo, por extensão de arquivo ou cabeçalho de versão). Implemente uma ferramenta de conversão que leia HCL1 e produza HCL2 equivalente. Teste com vários arquivos de configuração para garantir a correção. Planeje um período de depreciação onde ambos são suportados.
Pilha de tecnologia
go
Domain
infrastructure
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GoGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40