Configura un repositorio de muestra

Un repositorio de muestra es un repositorio de Git con muestras personalizadas que creaste para que tu equipo pueda desarrollar aplicaciones.

Esto significa que, dentro de una organización o equipo, puedes configurar repositorios de muestra con Cloud Code, personalizados para tu organización, a fin de ofrecer un conjunto estándar de aplicaciones, servicios y configuraciones de infraestructura iniciales que otros. . Esto ayuda a alinear proyectos nuevos con la pila técnica y los estándares preferidos de tu organización y fomenta la incorporación de prácticas recomendadas al comienzo del ciclo de desarrollo.

Un repositorio de muestra puede ser un repositorio existente de aplicaciones de muestra que ya creaste o un conjunto de muestras nuevo que desees que otros usen. Solo deberás agregar un archivo descriptor de muestra al repositorio para importarlo con Cloud Code.

Cuando esté listo, los repositorios de muestra serán fáciles de compartir con su equipo. necesitarán configurar Cloud Code y la URL de Git del repositorio de muestra. Para los repositorios privados de Git, solo los miembros que tienen acceso al repositorio pueden usar las muestras personalizadas subyacentes.

Para ver un ejemplo de cómo se puede configurar un repositorio de muestra, consulta este repositorio.

Crea un repositorio de muestra nuevo

Si deseas crear un repositorio de muestra nuevo y usarlo, sigue estos pasos:

  1. Crea un repositorio de Git nuevo.

    Tu repositorio de Git se puede alojar de forma remota o en tu máquina local. En este ejemplo, se usa un repositorio nuevo de GitHub, “custom-sample-repo”.

    Interfaz de creación del repositorio de GitHub con el campo Nombre de repositorio completo con 'custom-sample-repo'

  2. Agrega directorios de muestra a este repositorio.

    Tus directorios de muestra pueden contener lo que desees y ubicarse en cualquier lugar que desees del repositorio. En este ejemplo, se agregaron dos directorios de muestra, "hello-world" y "kubernetes-custom-sample", a "custom-sample-repo".

    Se recomienda un archivo readme con instrucciones sobre cómo usar las muestras personalizadas.

    “custom-sample-repo” con dos directorios de muestra subyacentes: “hello-world” y “kubernetes-custom-sample”

  3. Crea un archivo descriptor de muestra.

    Un archivo descriptor de muestra proporciona a Cloud Code la información del ejemplo para crear correctamente tu aplicación. Este archivo debe llamarse .cctemplate, ubicado en tu directorio raíz, y tener el esquema definido en la sección Esquema del archivo del descriptor de muestra.

Usa un repositorio existente

Si deseas usar un repositorio existente, deberás crear un archivo descriptor de muestra. Este archivo le proporciona a Cloud Code la información del ejemplo para crear la aplicación de forma correcta.

El archivo del descriptor de muestra debe llamarse .cctemplate, ubicado en el directorio raíz, y debe tener el esquema definido en la sección Esquema del archivo del descriptor de muestra.

Ejemplo de esquema del descriptor

Clave Descripción Tipo
metadata Metadatos que usa Cloud Code para leer. Se ajusta al esquema de metadatos. Metadatos
plantillas Arreglo de muestras contenidas en un repositorio. Los objetos de este arreglo deben cumplir con el esquema de muestra. Arreglo<Ejemplo>
nombre (opcional) Nombre del repositorio de muestra. String

Ejemplo

{
   "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 muestra

Clave Descripción Tipo
ruta de acceso Ubicación de la muestra dentro de un repositorio

La ruta de acceso se interpreta como la raíz del repositorio.

String
nombre Indica el nombre de una muestra.

Esto se muestra en un IDE al seleccionar una muestra para basar una aplicación.

String
descripción (opcional) Descripción de una muestra.

Esto se muestra en un IDE al seleccionar una muestra para basar una aplicación.

String

Ejemplo

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

Esquema de metadatos

Clave Descripción Tipo
version La versión del esquema de muestra que se usa. En la actualidad, la única versión válida es 1. String

Ejemplo

{
   "version":"1"
}