Referencia del esquema

# Referencia del esquema

La referencia del esquema YAML para Catalyst Pipelines describe las claves predefinidas para los diversos componentes del pipeline. Utilizando estas claves, puedes incorporar los componentes necesarios y definir el flujo de ejecución del pipeline.
A continuación se analizan los componentes en detalle en sus respectivas páginas de ayuda. Puedes comenzar desde {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners/" %}}aquí{{%/link%}}. Consulta {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/implementation" %}}esta página{{%/link%}} para obtener más información sobre la configuración del pipeline desde la consola de Catalyst.

### Definiciones YAML

A continuación se muestra la lista de claves compatibles en Catalyst para el archivo {{%badge%}}catalyst-pipelines.yaml{{%/badge%}}.

<table class="content-table">
        <thead>
            <tr>
                <th>Keyword</th>
                <th>Descripción</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>{{%badge%}}version{{%/badge%}}</td>
                <td>La versión del pipeline se puede definir como cualquier valor entero, con el propósito de preservar las configuraciones del pipeline como versiones distintas y reutilizables.</td>
            </tr>
            <tr>
                <td>{{%badge%}}runners{{%/badge%}}</td>
                <td>Un runner es una configuración de máquina virtual que se puede definir a nivel de {{%bold%}}stage{{%/bold%}} o de {{%bold%}}job{{%/bold%}}. Puedes definir la especificación del runner como valor de la clave {{%badge%}}config-id{{%/badge%}} en {{%badge%}}runners{{%/badge%}}. Obtén más información en {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners" %}}esta página de ayuda{{%/link%}}.</td>
            </tr>
            <tr>
                <td>{{%badge%}}images{{%/badge%}}</td>
                <td>Una image es un paquete o conjunto de dependencias requeridas para la ejecución de jobs en el pipeline. Las images se pueden definir a nivel de {{%bold%}}stage{{%/bold%}} o de {{%bold%}}job{{%/bold%}}.

Puedes definir el nombre de la image en la clave {{%badge%}}image{{%/badge%}} y la URL del registro de paquetes externo (como Dockerhub) en la clave {{%badge%}}registry{{%/badge%}}.
            
También debes definir la clave {{%badge%}}auth{{%/badge%}} para autenticar el registro especificado. Obtén más información en {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images" %}}esta página de ayuda{{%/link%}}.
</td>
            </tr>
            <tr>
                <td>{{%badge%}}auth{{%/badge%}}</td>
                <td>Para autenticar cualquier cuenta de registro externo y obtener los paquetes requeridos para la ejecución de jobs, deberás especificar las claves {{%badge%}}username{{%/badge%}} y {{%badge%}}password{{%/badge%}} en la clave {{%badge%}}auth{{%/badge%}}. Puedes consultar {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images" %}}esta sección de ayuda{{%/link%}} para saber más al respecto.</td>
            </tr>
            <tr>
                <td>{{%badge%}}variables{{%/badge%}}</td>
                <td>Esta palabra clave se utiliza para almacenar valores de marcadores de posición a nivel de {{%bold%}}pipeline{{%/bold%}} o de {{%bold%}}job{{%/bold%}}. Consulta {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/variables" %}}esta página de ayuda{{%/link%}} para más detalles.</td>
            </tr>
            <tr>
                <td>{{%badge%}}steps{{%/badge%}}</td>
                <td>Son un conjunto de comandos que se pueden definir para llevar a cabo los procesos de compilación, prueba y despliegue en el pipeline. Puedes definir los steps según las aplicaciones que compilas, los procedimientos de prueba para ellas y los entornos en los que la aplicación debe desplegarse. Consulta {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/steps" %}}esta página de ayuda{{%/link%}} para obtener más información sobre los steps.</td>
            </tr>
            <tr>
                <td>{{%badge%}}jobs{{%/badge%}}</td>
                <td>Un job es una secuencia de steps definidos en un stage. Puedes definir hasta cinco jobs dentro de un stage, y bajo cada job, puedes definir {{%badge%}}steps{{%/badge%}}, {{%badge%}}variables{{%/badge%}}, {{%badge%}}runners{{%/badge%}} e {{%badge%}}images{{%/badge%}} utilizando la clave {{%badge%}}jobs{{%/badge%}}.

Si has configurado el pipeline para compilar tu aplicación antes de probarla o desplegarla, puedes almacenar temporalmente los archivos de compilación generados de tu código en el servicio Catalyst Stratus. Estas configuraciones se pueden definir utilizando la clave {{%badge%}}artifacts{{%/badge%}}.

Esta clave incluye dos subclaves adicionales llamadas {{%badge%}}notify{{%/badge%}} y {{%badge%}}approve{{%/badge%}}.

Puedes obtener más información en detalle en {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction" %}}esta página de ayuda{{%/link%}}.
</td>
            </tr>
            <tr>
                <td>{{%badge%}}notify{{%/badge%}}</td>
                <td>Esta clave te permite enviar notificaciones ya sea al inicio de la ejecución del job o tras la finalización exitosa del job. Puedes utilizar las claves {{%badge%}}on-start{{%/badge%}} u {{%badge%}}on-end{{%/badge%}} para este propósito. Consulta {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction" %}}esta sección de ayuda{{%/link%}} para más detalles.</td>
            </tr>
            <tr>
                <td>{{%badge%}}approve{{%/badge%}}</td>
                <td>Esta clave se utiliza para {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction" %}}jobs de aprobación{{%/link%}} para definir los detalles del revisor del job y el mensaje de aprobación personalizado.

Puedes establecer el tipo de aprobación utilizando la subclave {{%badge%}}type-name{{%/badge%}} y agregar la dirección de correo electrónico del revisor y un mensaje de revisión personalizado en la clave {{%badge%}}type-variables{{%/badge%}} que incluye las subclaves {{%badge%}}reviewers{{%/badge%}} y {{%badge%}}message{{%/badge%}}, respectivamente.
</td>
            </tr>
            <tr>
                <td>{{%badge%}}artifacts{{%/badge%}}</td>
                <td>Esta clave se utiliza para representar el proceso de carga y descarga de los archivos de compilación de la aplicación generados durante la ejecución del pipeline. Para esto, puedes establecer los valores en las claves {{%badge%}}upload{{%/badge%}} y {{%badge%}}download{{%/badge%}} respectivamente. Puedes obtener más información sobre los artifacts en {{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/artifacts" %}}su página de ayuda{{%/link%}}.</td>
            </tr>
            <tr>
                <td>{{%badge%}}upload{{%/badge%}}</td>
                <td>Esta clave se utiliza para almacenar los archivos zip de compilación generados en el servicio Catalyst Stratus. Debes definir el nombre del archivo de compilación, la ubicación en la que se debe almacenar el archivo y otras condiciones del archivo utilizando las subclaves {{%badge%}}name{{%/badge%}}, {{%badge%}}location{{%/badge%}} y {{%badge%}}files{{%/badge%}} respectivamente.</td>
            </tr>
            <tr>
                <td>{{%badge%}}download{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para recuperar los archivos zip de compilación almacenados del servicio Catalyst Stratus. También puedes definir las subclaves {{%badge%}}name{{%/badge%}}, {{%badge%}}location{{%/badge%}} y {{%badge%}}files{{%/badge%}} de manera similar a la palabra clave upload.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/stages" %}}stages{{%/link%}}{{%/badge%}}</td>
                <td>Un stage es una fase distinta que contiene múltiples jobs. Puedes definir hasta cinco stages en un pipeline, cada uno conteniendo un conjunto de jobs. También puedes definir {{%badge%}}runners{{%/badge%}} e {{%badge%}}images{{%/badge%}} a nivel de stage.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-equal" %}}when-equal{{%/link%}}{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para evaluar si dos valores coinciden exactamente entre sí y proceder con el flujo de ejecución especificado del pipeline, solo si la validación resulta verdadera.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-not" %}}when-not{{%/link%}}{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para evaluar si una condición particular es {{%badge%}}true{{%/badge%}} o {{%badge%}}false{{%/badge%}}. Según el resultado de la evaluación, se ejecutará el flujo de pipeline definido.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-not-equal" %}}when-not-equal{{%/link%}}{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para evaluar si dos valores no coinciden entre sí, y luego proceder a ejecutar el flujo de pipeline definido.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-or" %}}when-and{{%/link%}}{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para evaluar si las dos condiciones definidas en la clave {{%badge%}}and{{%/badge%}} resultan verdaderas. Si es así, se ejecuta el flujo definido en la condición {{%badge%}}when{{%/badge%}}.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-or" %}}when-or{{%/link%}}{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para evaluar si alguna de las condiciones definidas en la clave {{%badge%}}or{{%/badge%}} resulta verdadera. Si es así, se ejecuta el flujo del pipeline definido en la clave {{%badge%}}when{{%/badge%}}.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#global-configuration" %}}pipeline-when{{%/link%}}{{%/badge%}}</td>
                <td>La lógica condicional que se puede definir a nivel de pipeline, la cual dicta el flujo de ejecución de todo el pipeline. Puedes utilizar las claves {{%badge%}}and{{%/badge%}}, {{%badge%}}equal{{%/badge%}}, {{%badge%}}or{{%/badge%}}, {{%badge%}}not{{%/badge%}}, {{%badge%}}not-equal{{%/badge%}} junto con la condición {{%badge%}}pipeline-when{{%/badge%}}.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners/#global-configuration" %}}pipeline-runner{{%/link%}}{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para definir un runner a nivel de pipeline, el cual es accesible en todos los stages y jobs.</td>
            </tr>
            <tr>
                <td>{{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images/#global-configuration" %}}pipeline-image{{%/link%}}{{%/badge%}}</td>
                <td>Esta clave se puede utilizar para definir una image a nivel de pipeline, la cual es accesible en todos los stages y jobs.</td>
            </tr>
            </tbody>
</table>

{{%note%}}{{%bold%}}Note:{{%/bold%}} Al definir el flujo de ejecución del pipeline en el archivo {{%badge%}}{{%link href="/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images/#global-configuration" %}}pipeline-image{{%/link%}}
{{%/badge%}}, asegúrate de utilizar las palabras clave exactas designadas por Catalyst como claves y asignar los datos correspondientes a cada clave.{{%/note%}}

La referencia del esquema YAML para Catalyst Pipelines describe las claves predefinidas para los diversos componentes del pipeline. Utilizando estas claves, puedes incorporar los componentes necesarios y definir el flujo de ejecución del pipeline. A continuación se analizan los componentes en detalle en sus respectivas páginas de ayuda. Puedes comenzar desde aquí. Consulta esta página para obtener más información sobre la configuración del pipeline desde la consola de Catalyst.

Definiciones YAML

A continuación se muestra la lista de claves compatibles en Catalyst para el archivo catalyst-pipelines.yaml.

Keyword	Descripción
version	La versión del pipeline se puede definir como cualquier valor entero, con el propósito de preservar las configuraciones del pipeline como versiones distintas y reutilizables.
runners	Un runner es una configuración de máquina virtual que se puede definir a nivel de stage o de job. Puedes definir la especificación del runner como valor de la clave config-id en runners. Obtén más información en esta página de ayuda.
images	Una image es un paquete o conjunto de dependencias requeridas para la ejecución de jobs en el pipeline. Las images se pueden definir a nivel de stage o de job. Puedes definir el nombre de la image en la clave image y la URL del registro de paquetes externo (como Dockerhub) en la clave registry. También debes definir la clave auth para autenticar el registro especificado. Obtén más información en esta página de ayuda.
auth	Para autenticar cualquier cuenta de registro externo y obtener los paquetes requeridos para la ejecución de jobs, deberás especificar las claves username y password en la clave auth. Puedes consultar esta sección de ayuda para saber más al respecto.
variables	Esta palabra clave se utiliza para almacenar valores de marcadores de posición a nivel de pipeline o de job. Consulta esta página de ayuda para más detalles.
steps	Son un conjunto de comandos que se pueden definir para llevar a cabo los procesos de compilación, prueba y despliegue en el pipeline. Puedes definir los steps según las aplicaciones que compilas, los procedimientos de prueba para ellas y los entornos en los que la aplicación debe desplegarse. Consulta esta página de ayuda para obtener más información sobre los steps.
jobs	Un job es una secuencia de steps definidos en un stage. Puedes definir hasta cinco jobs dentro de un stage, y bajo cada job, puedes definir steps, variables, runners e images utilizando la clave jobs. Si has configurado el pipeline para compilar tu aplicación antes de probarla o desplegarla, puedes almacenar temporalmente los archivos de compilación generados de tu código en el servicio Catalyst Stratus. Estas configuraciones se pueden definir utilizando la clave artifacts. Esta clave incluye dos subclaves adicionales llamadas notify y approve. Puedes obtener más información en detalle en esta página de ayuda.
notify	Esta clave te permite enviar notificaciones ya sea al inicio de la ejecución del job o tras la finalización exitosa del job. Puedes utilizar las claves on-start u on-end para este propósito. Consulta esta sección de ayuda para más detalles.
approve	Esta clave se utiliza para jobs de aprobación para definir los detalles del revisor del job y el mensaje de aprobación personalizado. Puedes establecer el tipo de aprobación utilizando la subclave type-name y agregar la dirección de correo electrónico del revisor y un mensaje de revisión personalizado en la clave type-variables que incluye las subclaves reviewers y message, respectivamente.
artifacts	Esta clave se utiliza para representar el proceso de carga y descarga de los archivos de compilación de la aplicación generados durante la ejecución del pipeline. Para esto, puedes establecer los valores en las claves upload y download respectivamente. Puedes obtener más información sobre los artifacts en su página de ayuda.
upload	Esta clave se utiliza para almacenar los archivos zip de compilación generados en el servicio Catalyst Stratus. Debes definir el nombre del archivo de compilación, la ubicación en la que se debe almacenar el archivo y otras condiciones del archivo utilizando las subclaves name, location y files respectivamente.
download	Esta clave se puede utilizar para recuperar los archivos zip de compilación almacenados del servicio Catalyst Stratus. También puedes definir las subclaves name, location y files de manera similar a la palabra clave upload.
stages	Un stage es una fase distinta que contiene múltiples jobs. Puedes definir hasta cinco stages en un pipeline, cada uno conteniendo un conjunto de jobs. También puedes definir runners e images a nivel de stage.
when-equal	Esta clave se puede utilizar para evaluar si dos valores coinciden exactamente entre sí y proceder con el flujo de ejecución especificado del pipeline, solo si la validación resulta verdadera.
when-not	Esta clave se puede utilizar para evaluar si una condición particular es true o false. Según el resultado de la evaluación, se ejecutará el flujo de pipeline definido.
when-not-equal	Esta clave se puede utilizar para evaluar si dos valores no coinciden entre sí, y luego proceder a ejecutar el flujo de pipeline definido.
when-and	Esta clave se puede utilizar para evaluar si las dos condiciones definidas en la clave and resultan verdaderas. Si es así, se ejecuta el flujo definido en la condición when.
when-or	Esta clave se puede utilizar para evaluar si alguna de las condiciones definidas en la clave or resulta verdadera. Si es así, se ejecuta el flujo del pipeline definido en la clave when.
pipeline-when	La lógica condicional que se puede definir a nivel de pipeline, la cual dicta el flujo de ejecución de todo el pipeline. Puedes utilizar las claves and, equal, or, not, not-equal junto con la condición pipeline-when.
pipeline-runner	Esta clave se puede utilizar para definir un runner a nivel de pipeline, el cual es accesible en todos los stages y jobs.
pipeline-image	Esta clave se puede utilizar para definir una image a nivel de pipeline, la cual es accesible en todos los stages y jobs.

Note: Al definir el flujo de ejecución del pipeline en el archivo pipeline-image, asegúrate de utilizar las palabras clave exactas designadas por Catalyst como claves y asignar los datos correspondientes a cada clave.

Última actualización 2026-03-20 21:51:56 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit