Criar e publicar um template
Você precisa da permissão template.create na organização ativa para criar um template. A criação começa privada, então a equipe pode revisar aplicação, variáveis e padrões antes de compartilhar qualquer informação no catálogo público.
Permissões por ação
| Ação | Scope mínimo |
|---|---|
| Criar template | template.create em organization:* |
| Editar template | template.update em template:<template-id> |
| Publicar ou tornar privado | template.publish em template:<template-id> |
| Remover template | template.delete em template:<template-id> |
| Criar banco na implantação conjunta | database.create em organization:* |
| Criar Cache ou Queue na implantação conjunta | managed_service.create em organization:* |
owner tem acesso completo. assistant, member e API Keys precisam dos grants específicos.
Antes de começar
Prepare uma aplicação HTTP com uma referência pública em um dos registros aceitos: Docker Hub, GitHub Container Registry (GHCR), Quay ou GitLab Registry. Use uma referência com tag ou versão que possa ser validada pela Zenifra. A aplicação deve responder na porta informada e, se gravar arquivos, você deve conhecer a pasta que precisa de persistência.
Separe também as variáveis de ambiente. Para cada variável, defina nome, descrição, se é obrigatória e se é secreta. Nunca use uma senha, token, chave de API ou outro valor sensível como valor sugerido. O valor será preenchido por quem implantar o template.
Passo 1: abrir o formulário
- Entre no catálogo de Templates.
- Confirme a organização ativa no seletor do console.
- Selecione Novo template.
- Preencha nome, resumo, descrição e tags.
O nome e o resumo aparecem nos cards do catálogo. Use tags simples e descritivas, como web, cms ou produtividade. Não coloque identificadores internos, URLs privadas ou segredos nesses campos.
Passo 2: definir a aplicação
Informe a referência pública da aplicação, a porta HTTP e, quando necessário, a pasta de dados persistentes. A pasta deve corresponder ao local em que a aplicação grava arquivos que precisam sobreviver a atualizações. Deixe o campo vazio quando a aplicação não mantiver dados locais.
Depois, escolha os padrões sugeridos:
| Configuração | O que representa |
|---|---|
| Plano | Capacidade inicial escolhida para o projeto |
| Cobrança | Forma de cobrança por hora, mês ou ano |
| Acesso | Exposição pública ou privada da aplicação |
| Instâncias | Quantidade inicial de instâncias |
| Persistência | Se o projeto mantém dados entre atualizações |
| Capacidade | Quantidade de dados persistentes sugerida |
| Auto-scaling | Se a escala automática começa habilitada |
Esses valores são sugestões. A pessoa que implantar o template poderá revisá-los antes de confirmar o projeto.
Passo 3: declarar variáveis
Adicione uma linha para cada variável esperada pela aplicação. Use nomes em maiúsculas, com letras, números e sublinhado. Marque como Obrigatória quando a aplicação não puder iniciar sem o valor. Marque como Secreta para credenciais, tokens, senhas ou chaves.
Variáveis secretas não possuem valor sugerido. Mesmo quando uma variável não é secreta, o valor padrão deve ser usado apenas para configurações seguras e genéricas. A descrição deve orientar o consumidor sem revelar dados da sua organização.
Passo 4: declarar opcionalmente uma dependência de banco
Ative a opção de banco apenas quando a aplicação precisar de um novo banco para funcionar. Escolha um ou mais mecanismos compatíveis no catálogo atual, selecione o mecanismo recomendado e informe uma recomendação para cada mecanismo compatível. O catálogo informa planos, formas de cobrança, versões, limites de capacidade e outros campos disponíveis, mantendo o formulário atualizado quando novos mecanismos forem adicionados.
Você pode vincular uma variável declarada a um dado de conexão, como host, porta, nome do banco, usuário, senha, URL de conexão ou host e porta juntos. Use uma variável secreta quando o dado de conexão for sensível. Vínculos não sensíveis podem ter valor sugerido para um banco externo. Quando a Zenifra cria o banco junto com a aplicação, ela preenche todos os vínculos com os dados dessa nova conexão.
Não informe uma senha real, URL de conexão ou outro valor de conexão no template. O template armazena o vínculo, não o valor.
Passo 5: revisar e publicar
Ao salvar, o template recebe a primeira revisão e permanece privado. Abra os detalhes, revise a aplicação, a porta, os padrões, as tags e as variáveis. Quando estiver satisfeito, escolha Publicar. A publicação é imediata após a validação da aplicação e faz o template aparecer no catálogo público.
Se preferir continuar restrito à organização, mantenha a visibilidade privada. Alterações posteriores criam uma nova revisão. Se outra pessoa tiver salvo uma revisão antiga, o console informará o conflito antes de substituir o conteúdo atual.
O selo Template Oficial não é solicitado durante a publicação. Ele identifica Templates de organizações reconhecidas pela Zenifra, como a própria Zenifra e parceiros oficiais, e aparece automaticamente quando aplicável.