# 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
조직에 있는 환경 목록 나열

GET /katello/api/organizations/:organization_id/environments
조직에 있는 환경 목록 나열

Params

Param name Description
organization_id
optional

조직 ID

Validations:

  • Must be a number.

library
optional

라이브러리 환경만 확인하려면 true로 설정

Validations:

  • Must be one of: true, false.

name
optional

이름이 포함환 환경만 필터링

Validations:

  • String

search
optional

검색 문자열

Validations:

  • String

page
optional

1 부터 페이지 번호

Validations:

  • Must be a number.

per_page
optional

반환할 페이지 당 결과 수

Validations:

  • Must be a number.

order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
optional

모든 결과를 표시할 지에 대한 여부

Validations:

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

sort
optional

'order' 매개 변수의 해시 버전

Validations:

  • Hash

sort[by]
optional

결과를 정렬할 필드

Validations:

  • String

sort[order]
optional

정렬된 결고를 정렬하는 방법 (예: 오름차순의 ASC)

Validations:

  • String


GET /katello/api/environments/:id
환경 표시

GET /katello/api/organizations/:organization_id/environments/:environment_id
환경 표시

Params

Param name Description
id
required

환경 ID

Validations:

  • Must be a number.

organization_id
optional

조직 ID

Validations:

  • Must be a number.


POST /katello/api/environments
환경 생성

POST /katello/api/organizations/:organization_id/environments
조직에 있는 환경 생성

Params

Param name Description
organization_id
required

조직 이름

Validations:

  • Must be a number.

name
required

환경 이름

Validations:

  • String

label
optional

환경 레이블

Validations:

  • String

description
optional

환경 설명

Validations:

  • String

registry_name_pattern
optional

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
optional

allow unauthenticed pull of container images

Validations:

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

prior_id
required

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
환경 업데이트

PUT /katello/api/organizations/:organization_id/environments/:id
조직에 있는 환경 업데이트

Params

Param name Description
id
required

환경 ID

Validations:

  • Must be a number.

organization_id
optional

조직 이름

Validations:

  • Must be a number.

new_name
optional

환경에 지정할 새 이름

Validations:

  • String

description
optional

환경 설명

Validations:

  • String

registry_name_pattern
optional

pattern for container image names

Validations:

  • String

registry_unauthenticated_pull
optional

allow unauthenticed pull of container images

Validations:

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

async
optional

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
환경 삭제

DELETE /katello/api/organizations/:organization_id/environments/:id
조직에서 환경 삭제

Params

Param name Description
id
required

환경 ID

Validations:

  • Must be a number.

organization_id
optional

조직 ID

Validations:

  • Must be a number.


GET /katello/api/organizations/:organization_id/environments/paths
환경 경로 목록 나열

Params

Param name Description
organization_id
optional

조직 ID

Validations:

  • Must be a number.

permission_type
optional

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

Validations:

  • String