---
title: "Referencia del esquema"
url: https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/schema-reference/
description: "Conoce en detalle las definiciones de esquema predefinidas del archivo catalyst-pipelines.yaml."
last_updated: 2026-03-20T16:21:56Z
service: Pipelines
type: general
---

# 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 [aquí](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners/). Consulta [esta página](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/implementation) 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`.

<table class="content-table">
        <thead>
            <tr>
                <th>Keyword</th>
                <th>Descripción</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`version`</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>`runners`</td>
                <td>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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners).</td>
            </tr>
            <tr>
                <td>`images`</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 **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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images).
</td>
            </tr>
            <tr>
                <td>`auth`</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 `username` y `password` en la clave `auth`. Puedes consultar [esta sección de ayuda](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images) para saber más al respecto.</td>
            </tr>
            <tr>
                <td>`variables`</td>
                <td>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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/variables) para más detalles.</td>
            </tr>
            <tr>
                <td>`steps`</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 [esta página de ayuda](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/steps) para obtener más información sobre los steps.</td>
            </tr>
            <tr>
                <td>`jobs`</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 `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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction).
</td>
            </tr>
            <tr>
                <td>`notify`</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 `on-start` u `on-end` para este propósito. Consulta [esta sección de ayuda](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction) para más detalles.</td>
            </tr>
            <tr>
                <td>`approve`</td>
                <td>Esta clave se utiliza para [jobs de aprobación](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction) 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.
</td>
            </tr>
            <tr>
                <td>`artifacts`</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 `upload` y `download` respectivamente. Puedes obtener más información sobre los artifacts en [su página de ayuda](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/artifacts).</td>
            </tr>
            <tr>
                <td>`upload`</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 `name`, `location` y `files` respectivamente.</td>
            </tr>
            <tr>
                <td>`download`</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 `name`, `location` y `files` de manera similar a la palabra clave upload.</td>
            </tr>
            <tr>
                <td>`[stages](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/stages)`</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 `runners` e `images` a nivel de stage.</td>
            </tr>
            <tr>
                <td>`[when-equal](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-equal)`</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>`[when-not](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-not)`</td>
                <td>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.</td>
            </tr>
            <tr>
                <td>`[when-not-equal](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-not-equal)`</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>`[when-and](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-or)`</td>
                <td>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`.</td>
            </tr>
            <tr>
                <td>`[when-or](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-or)`</td>
                <td>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`.</td>
            </tr>
            <tr>
                <td>`[pipeline-when](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#global-configuration)`</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 `and`, `equal`, `or`, `not`, `not-equal` junto con la condición `pipeline-when`.</td>
            </tr>
            <tr>
                <td>`[pipeline-runner](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners/#global-configuration)`</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>`[pipeline-image](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images/#global-configuration)`</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:** Al definir el flujo de ejecución del pipeline en el archivo [pipeline-image](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images/#global-configuration)
, asegúrate de utilizar las palabras clave exactas designadas por Catalyst como claves y asignar los datos correspondientes a cada clave.
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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners).
`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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images).
`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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images) 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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/variables) 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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/steps) 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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction).
`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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction) para más detalles.
`approve`	Esta clave se utiliza para [jobs de aprobación](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/jobs/introduction) 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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/artifacts).
`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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-or)`	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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#when-andwhen-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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/when-condition/#global-configuration)`	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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/runners/#global-configuration)`	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](https://docs.catalyst.zoho.com/es/pipelines/help/catalyst-pipelines.yaml/build-the-pipeline/images/#global-configuration)`	Esta clave se puede utilizar para definir una image a nivel de pipeline, la cual es accesible en todos los stages y jobs.