Como configurar um repositório de amostra

Um repositório de amostra é um repositório Git que contém amostras personalizadas que você criou para sua equipe a desenvolver aplicativos.

Isso significa que, de uma organização ou equipe, você pode configurar repositórios de amostra com o Cloud Code, personalizados para sua organização, para oferecer um conjunto padrão de aplicativos iniciais, serviços e configurações de infraestrutura que outros podem usar. Isso ajuda a alinhar novos projetos com a pilha e os padrões técnicos preferidos da organização e incentiva a incorporação de práticas recomendadas no início do ciclo de desenvolvimento.

Um repositório de amostra pode ser um repositório de aplicativos de amostra que você já criou ou um novo conjunto de amostras que você quer que outras pessoas usem. Você só precisará adicionar um arquivo descritor de amostra ao repositório para importá-lo com o Cloud Code.

Quando estiverem prontos, os repositórios de amostra serão fáceis de compartilhar com sua equipe; para usar, é necessário configurar o Cloud Code e o URL do Git do repositório de amostra. Para repositórios Git particulares, somente membros que têm acesso ao repositório podem usar as amostras personalizadas subjacentes.

Para ver um exemplo de como configurar um repositório de amostra, consulte este repositório.

Como criar um novo repositório de amostra

Se quiser criar um novo repositório de amostra para uso, siga estas etapas:

  1. Crie um novo repositório Git.

    Seu repositório Git pode ser hospedado remotamente ou ativo na sua máquina local. Este exemplo usa um novo repositório do GitHub, "custom-sample-repo".

    Interface de criação do repositório do GitHub com campo de nome do repositório preenchido com "custom-sample-repo"

  2. Adicione diretórios de amostra a este repositório.

    Os diretórios de amostra podem conter qualquer coisa e estar localizados em qualquer lugar no repositório. Neste exemplo, dois diretórios de amostra, "hello-world" e "kubernetes-custom-sample", foram adicionados a "custom-sample-repo".

    É altamente recomendável usar um arquivo readme com instruções sobre como usar melhor suas amostras personalizadas.

    "custom-sample-repo" com dois diretórios de amostra subjacentes: "hello-world" e "kubernetes-custom-sample"

  3. Crie um arquivo de descritor de amostra.

    Um arquivo de descritor de amostra fornece ao Cloud Code informações sobre sua amostra para criar o aplicativo adequadamente. Esse arquivo precisa ser nomeado como .cctemplate, localizado no diretório raiz e ter o esquema definido na seção Esquema do arquivo descritor de amostra.

Como usar um repositório atual

Se você quiser usar um repositório atual, ainda precisará criar um arquivo do descritor de exemplo. Esse arquivo fornece ao Cloud Code informações sobre sua amostra para criar o aplicativo adequadamente.

O arquivo descritor de amostra precisa ser nomeado .cctemplate, localizado no diretório raiz e ter o esquema definido na seção Esquema do arquivo descritor de amostra.

Exemplo de esquema de descritor

Chave Descrição Tipo
metadata Metadados usados pelo Cloud Code para leitura. Conformidade com o esquema de metadados. Metadados
modelos Matriz de amostras contidas em um repositório. Os objetos nessa matriz precisam estar em conformidade com o Esquema de amostra. Matriz<Amostra>
nome (opcional) Nome do repositório de amostra. String

Exemplo

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

Esquema de amostra

Chave Descrição Tipo
caminho Onde a amostra está localizada dentro de um repositório.

O caminho é interpretado como sendo a partir da raiz do repositório.

String
Nome Nome de uma amostra.

Isso é exibido em um ambiente de desenvolvimento integrado ao selecionar uma amostra para basear um aplicativo.

String
Descrição (opcional) Descrição de uma amostra.

Isso é exibido em um ambiente de desenvolvimento integrado ao selecionar uma amostra para basear um aplicativo.

String

Exemplo

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

Esquema de metadados

Chave Descrição Tipo
versão A versão do esquema de amostra que está sendo usado. Atualmente, a única versão válida é 1. String

Exemplo

{
   "version":"1"
}