# 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 選填 |
組織識別子 Validations:
|
library 選填 |
如果僅想看函示庫環境,設為真 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] 選填 |
如何排序結果的順序(比方說 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 選填 |
組織識別子 Validations:
|
參數名字 | 描述 |
---|---|
organization_id 選填 |
組織識別子 Validations:
|
permission_type 選填 |
The associated permission type. One of (readable | promotable) Default: readable Validations:
|