# 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
Répertorier les environnements dans une organisation

GET /katello/api/organizations/:organization_id/environments
Répertorier les environnements dans une organisation

Paramètres

Nom du paramètre Description
organization_id
optionel

identifiant de l'organisation

Validations:

  • Must be a number.

library
optionel

définir comme vrai si vous souhaitez voir les environnements de bibliothèque uniquement

Validations:

  • Must be one of: true, false.

name
optionel

filtrer uniquement les environnements contenant ce nom

Validations:

  • String

search
optionel

Rechercher une chaîne

Validations:

  • String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

order
optionel

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
optionel

Afficher tous les résultats ou pas

Validations:

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

sort
optionel

Version Hash des paramètres d'« ordre »

Validations:

  • Hash

sort[by]
optionel

Champs dans lequel trier les résultats

Validations:

  • String

sort[order]
optionel

Comment classer les résultats triés (ex : ASC for ascending ou CRO pour croissant)

Validations:

  • String


GET /katello/api/environments/:id
Afficher un environnement

GET /katello/api/organizations/:organization_id/environments/:environment_id
Afficher un environnement

Paramètres

Nom du paramètre Description
id
requis

ID de l'environnement

Validations:

  • Must be a number.

organization_id
optionel

ID de l'organisation

Validations:

  • Must be a number.


POST /katello/api/environments
Créer un environnement

POST /katello/api/organizations/:organization_id/environments
Créer un environnement dans une organisation

Paramètres

Nom du paramètre Description
organization_id
requis

nom de l'organisation

Validations:

  • Must be a number.

name
requis

nom de l'environnement

Validations:

  • String

label
optionel

étiquette de l'environnement

Validations:

  • String

description
optionel

description de l'environnement

Validations:

  • String

registry_name_pattern
optionel

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
optionel

allow unauthenticed pull of container images

Validations:

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

prior_id
requis

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
Mise à jour d'un environnement

PUT /katello/api/organizations/:organization_id/environments/:id
Mettre à jour un environnement dans une organisation

Paramètres

Nom du paramètre Description
id
requis

ID de l'environnement

Validations:

  • Must be a number.

organization_id
optionel

nom de l'organisation

Validations:

  • Must be a number.

new_name
optionel

nouveau nom à donner à l'environnement

Validations:

  • String

description
optionel

description de l'environnement

Validations:

  • String

registry_name_pattern
optionel

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
optionel

allow unauthenticed pull of container images

Validations:

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

async
optionel

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
Détruire un environnement

DELETE /katello/api/organizations/:organization_id/environments/:id
Détruire un environnement dans une organisation

Paramètres

Nom du paramètre Description
id
requis

ID de l'environnement

Validations:

  • Must be a number.

organization_id
optionel

identifiant de l'organisation

Validations:

  • Must be a number.


GET /katello/api/organizations/:organization_id/environments/paths
Répertorier les chemins d'environnement

Paramètres

Nom du paramètre Description
organization_id
optionel

identifiant de l'organisation

Validations:

  • Must be a number.

permission_type
optionel

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

Validations:

  • String