# 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.
パラメーター名 | 記述 |
---|---|
organization_id 任意 |
組織 ID Validations:
|
library 任意 |
ライブラリー環境のみを表示する場合 true に設定 Validations:
|
name 任意 |
この名前を含む環境のみをフィルター Validations:
|
search 任意 |
検索文字列 Validations:
|
page 任意 |
1 から始まるページ番号 Validations:
|
per_page 任意 |
戻されるページごとの結果数 Validations:
|
order 任意 |
Sort field and order, eg. 'id DESC' Validations:
|
full_result 任意 |
すべての結果を表示するかどうか Validations:
|
sort 任意 |
ハッシュバージョンの 'order' パラメーター Validations:
|
sort[by] 任意 |
結果をソートするフィールド Validations:
|
sort[order] 任意 |
ソートされた結果を順序付ける方法 (例: ascending (昇順) の ASC) Validations:
|
パラメーター名 | 記述 |
---|---|
id 必須 |
環境の ID Validations:
|
organization_id 任意 |
組織の ID Validations:
|
パラメーター名 | 記述 |
---|---|
organization_id 必須 |
組織の名前 Validations:
|
name 必須 |
環境の名前 Validations:
|
label 任意 |
環境のラベル Validations:
|
description 任意 |
環境の説明 Validations:
|
registry_name_pattern 任意 |
pattern for container image names Validations:
|
registry_unauthenticated_pull 任意 |
allow unauthenticed pull of container images Validations:
|
prior_id 必須 |
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:
|
パラメーター名 | 記述 |
---|---|
id 必須 |
環境の ID Validations:
|
organization_id 任意 |
組織の名前 Validations:
|
new_name 任意 |
環境に付与される新規の名前 Validations:
|
description 任意 |
環境の説明 Validations:
|
registry_name_pattern 任意 |
pattern for container image names Validations:
|
registry_unauthenticated_pull 任意 |
allow unauthenticed pull of container images Validations:
|
async 任意 |
Do not wait for the update action to finish. Default: true Validations:
|
パラメーター名 | 記述 |
---|---|
id 必須 |
環境の ID Validations:
|
organization_id 任意 |
組織 ID Validations:
|
パラメーター名 | 記述 |
---|---|
organization_id 任意 |
組織 ID Validations:
|
permission_type 任意 |
The associated permission type. One of (readable | promotable) Default: readable Validations:
|