# Description

An environment is a basic organization structure that groups hosts, products, repositories, etc. Every host belongs to one environment and it's isolated inside so that it can see only content that is in its environment.

## Chains

Environments are ordered into chains and their content (products, repositories, tempaltes, packages) can be moved to an environment only from its prior environment. You can have for example chain like:

Library -> Development -> Testing -> Production

Each change in an environment is done through a changeset in an action called promotion.

## Library

Library is a special environment that has no ascendant: All the content starts in this environment. More chains can start from the library environment but no further branching of a chain is enabled.


GET /katello/api/environments
Mostrar entornos en una organización

GET /katello/api/organizations/:organization_id/environments
Mostrar entornos en una organización

Parámetros

Nombre del parámetro Descripción
organization_id
opcional

identificador de la organización

Validations:

  • Must be a number.

library
opcional

establecer a verdadero, si solo desea ver entornos de biblioteca

Validations:

  • Must be one of: true, false.

name
opcional

filtrar solo entornos que contengan este nombre

Validations:

  • String

search
opcional

Buscar cadena

Validations:

  • String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

order
opcional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
opcional

Si se muestran o no todos los resultados

Validations:

  • Must be one of: true, false, 1, 0

sort
opcional

Versión de hash del parámetro 'orden'

Validations:

  • Hash

sort[by]
opcional

Campo en el que ordenar los resultados

Validations:

  • String

sort[order]
opcional

Cómo ordenar los resultados clasificados (p. ej., ASC para orden ascendente)

Validations:

  • String


GET /katello/api/environments/:id
Mostrar un entorno

GET /katello/api/organizations/:organization_id/environments/:environment_id
Mostrar un entorno

Parámetros

Nombre del parámetro Descripción
id
requerido

ID del entorno

Validations:

  • Must be a number.

organization_id
opcional

ID de la organización

Validations:

  • Must be a number.


POST /katello/api/environments
Crear un entorno

POST /katello/api/organizations/:organization_id/environments
Crear un entorno en una organización

Parámetros

Nombre del parámetro Descripción
organization_id
requerido

nombre de la organización

Validations:

  • Must be a number.

name
requerido

nombre del entorno

Validations:

  • String

label
opcional

etiqueta del entorno

Validations:

  • String

description
opcional

descripción del entorno

Validations:

  • String

registry_name_pattern
opcional

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
opcional

allow unauthenticed pull of container images

Validations:

  • Must be one of: true, false, 1, 0

prior_id
requerido

ID of an environment that is prior to the new environment in the chain. It has to be either the ID of Library or the ID of an environment at the end of a chain.

Validations:

  • Integer


PUT /katello/api/environments/:id
Actualizar un entorno

PUT /katello/api/organizations/:organization_id/environments/:id
Actualizar un entorno en una organización

Parámetros

Nombre del parámetro Descripción
id
requerido

ID del entorno

Validations:

  • Must be a number.

organization_id
opcional

nombre de la organización

Validations:

  • Must be a number.

new_name
opcional

nuevo nombre para el entorno

Validations:

  • String

description
opcional

descripción del entorno

Validations:

  • String

registry_name_pattern
opcional

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
opcional

allow unauthenticed pull of container images

Validations:

  • Must be one of: true, false, 1, 0

async
opcional

Do not wait for the update action to finish. Default: true

Validations:

  • Must be one of: true, false, 1, 0


DELETE /katello/api/environments/:id
Destruir un entorno

DELETE /katello/api/organizations/:organization_id/environments/:id
Destruir un entorno en una organización

Parámetros

Nombre del parámetro Descripción
id
requerido

ID del entorno

Validations:

  • Must be a number.

organization_id
opcional

identificador de la organización

Validations:

  • Must be a number.


GET /katello/api/organizations/:organization_id/environments/paths
Mostrar rutas de entornos

Parámetros

Nombre del parámetro Descripción
organization_id
opcional

identificador de la organización

Validations:

  • Must be a number.

permission_type
opcional

The associated permission type. One of (readable | promotable) Default: readable

Validations:

  • String