diff --git a/api/bos.md b/api/bos.md
index cc71d88f0c28..76f08a9fb43c 100644
--- a/api/bos.md
+++ b/api/bos.md
@@ -190,6 +190,7 @@ Return list of versions currently running.
|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|A collection of Versions|Inline|
+|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|An Internal Server Error occurred handling the request.|[ProblemDetails](#schemaproblemdetails)|
Response Schema
@@ -305,7 +306,7 @@ The versioning system uses [semver](https://semver.org/).
## Link Relationships
* self : Link to itself
* versions : Link back to the versions resource|[Version](#schemaversion)|
-|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Bad Request|[ProblemDetails](#schemaproblemdetails)|
+|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|An Internal Server Error occurred handling the request.|[ProblemDetails](#schemaproblemdetails)|
To perform this operation, you must be authenticated by means of one of the following methods:
@@ -4102,7 +4103,8 @@ Update one or more of the BOS service options.
"max_power_on_wait_time": 1048576,
"max_power_off_wait_time": 1048576,
"polling_frequency": 1048576,
- "default_retry_policy": 1
+ "default_retry_policy": 1,
+ "max_component_batch_size": 1000
}
```
@@ -4128,7 +4130,8 @@ Update one or more of the BOS service options.
"max_power_on_wait_time": 1048576,
"max_power_off_wait_time": 1048576,
"polling_frequency": 1048576,
- "default_retry_policy": 1
+ "default_retry_policy": 1,
+ "max_component_batch_size": 1000
}
```
@@ -4328,7 +4331,8 @@ Retrieve the list of BOS service options.
"max_power_on_wait_time": 1048576,
"max_power_off_wait_time": 1048576,
"polling_frequency": 1048576,
- "default_retry_policy": 1
+ "default_retry_policy": 1,
+ "max_component_batch_size": 1000
}
```
@@ -6466,7 +6470,8 @@ Mapping from Component staged Session statuses to Components with that status.
"max_power_on_wait_time": 1048576,
"max_power_off_wait_time": 1048576,
"polling_frequency": 1048576,
- "default_retry_policy": 1
+ "default_retry_policy": 1,
+ "max_component_batch_size": 1000
}
```
@@ -6488,4 +6493,5 @@ Options for the Boot Orchestration Service.
|max_power_off_wait_time|integer|false|none|How long BOS will wait for a node to power off before forcefully powering off (in seconds)|
|polling_frequency|integer|false|none|How frequently the BOS operators check Component state for needed actions. (in seconds)|
|default_retry_policy|integer|false|none|The default maximum number attempts per node for failed actions.|
+|max_component_batch_size|integer|false|none|The maximum number of components that a BOS operator will process at once. 0 means no limit.|
diff --git a/api/cfs.md b/api/cfs.md
index f9e455a26085..cc19803e5518 100644
--- a/api/cfs.md
+++ b/api/cfs.md
@@ -1072,9 +1072,9 @@ Retrieve all the configuration framework sessions on the system.
|Name|In|Type|Required|Description|
|---|---|---|---|---|
-|age|query|string|false|Return only sessions older than the given age. Age is given in the format "1d" or "6h" DEPRECATED: This field has been replaced by min_age and max_age|
-|min_age|query|string|false|Return only sessions older than the given age. Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age. Age is given in the format "1d" or "6h"|
+|age|query|string|false|Return only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. DEPRECATED: This field has been replaced by min_age and max_age|
+|min_age|query|string|false|Return only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Return only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
|status|query|string|false|Return only sessions with the given status.|
|name_contains|query|string|false|Return only sessions whose session name contains the given string.|
|succeeded|query|string|false|Return only sessions that have succeeded/failed.|
@@ -1420,13 +1420,13 @@ Delete multiple configuration sessions. If filters are provided, only sessions
|Name|In|Type|Required|Description|
|---|---|---|---|---|
-|age|query|string|false|Deletes only sessions older than the given age. Age is given in the format "1d" or "6h" DEPRECATED: This field has been replaced by min_age and max_age|
-|min_age|query|string|false|Return only sessions older than the given age. Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age. Age is given in the format "1d" or "6h"|
+|age|query|string|false|Deletes only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. DEPRECATED: This field has been replaced by min_age and max_age|
+|min_age|query|string|false|Deletes only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Deletes only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
|status|query|string|false|Deletes only sessions with the given status.|
|name_contains|query|string|false|Delete only sessions whose session name contains the given string.|
|succeeded|query|string|false|Delete only sessions that have succeeded/failed.|
-|tags|query|string|false|Return only sessions whose have the matching tags. Key-value pairs should be separated using =, and tags can be a comma-separated list. Only sessions that match all tags will be deleted.|
+|tags|query|string|false|Deletes only sessions whose have the matching tags. Key-value pairs should be separated using =, and tags can be a comma-separated list. Only sessions that match all tags will be deleted.|
#### Enumerated Values
@@ -1923,8 +1923,8 @@ Retrieve all the configuration framework sessions on the system.
|---|---|---|---|---|
|limit|query|integer|false|When set, CFS will only return a number of sessions up to this limit. Combined with after_id, this enables paging across results|
|after_id|query|string|false|When set, CFS will only return the sessions after the session specified. Combined with limit, this enables paging across results.|
-|min_age|query|string|false|Return only sessions older than the given age. Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age. Age is given in the format "1d" or "6h"|
+|min_age|query|string|false|Return only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Return only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
|status|query|string|false|Return only sessions with the given status.|
|name_contains|query|string|false|Return only sessions whose session name contains the given string.|
|succeeded|query|string|false|Return only sessions that have succeeded/failed.|
@@ -2285,8 +2285,8 @@ Delete multiple configuration sessions. If filters are provided, only sessions
|Name|In|Type|Required|Description|
|---|---|---|---|---|
-|min_age|query|string|false|Return only sessions older than the given age. Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age. Age is given in the format "1d" or "6h"|
+|min_age|query|string|false|Deletes only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Deletes only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
|status|query|string|false|Deletes only sessions with the given status.|
|name_contains|query|string|false|Delete only sessions whose session name contains the given string.|
|succeeded|query|string|false|Delete only sessions that have succeeded/failed.|
@@ -6601,7 +6601,7 @@ Configuration options for the configuration service.
|defaultBatcherRetryPolicy|integer|false|none|The default maximum number retries per node when configuration fails.|
|defaultPlaybook|string|false|none|The default playbook to be used if not specified in a node's desired state.|
|defaultAnsibleConfig|string|false|none|The Kubernetes ConfigMap which holds the default ansible.cfg for a given CFS session. This ConfigMap must be present in the same Kubernetes namespace as the CFS service.|
-|sessionTTL|string|false|none|A time-to-live applied to all completed CFS sessions. Specified in hours or days. e.g. 3d or 24h. Set to an empty string to disable.|
+|sessionTTL|string|false|none|A time-to-live applied to all completed CFS sessions. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. Set to an empty string to disable.|
|additionalInventoryUrl|string|false|none|The git clone URL of a repo with additional inventory files. All files in the repo will be copied into the hosts directory of CFS.|
|batcherMaxBackoff|integer|false|none|The maximum number of seconds that batcher will backoff from session creation if problems are detected.|
|batcherDisable|boolean|false|none|Disables cfs-batcher's automatic session creation if set to True.|
@@ -6651,7 +6651,7 @@ Configuration options for the configuration service.
|default_batcher_retry_policy|integer|false|none|The default maximum number retries per node when configuration fails.|
|default_playbook|string|false|read-only|[DEPRECATED] The default playbook to be used if not specified in a node's desired state. This option is read-only via the v3 API and remains only for compatibility with the v2 API. This option will be removed from v3 when the v2 API is removed.|
|default_ansible_config|string|false|none|The Kubernetes ConfigMap which holds the default ansible.cfg for a given CFS session. This ConfigMap must be present in the same Kubernetes namespace as the CFS service.|
-|session_ttl|string|false|none|A time-to-live applied to all completed CFS sessions. Specified in hours or days. e.g. 3d or 24h. Set to an empty string to disable.|
+|session_ttl|string|false|none|A time-to-live applied to all completed CFS sessions. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. Set to an empty string to disable.|
|additional_inventory_url|string|false|none|The git clone URL of a repo with additional inventory files. All files in the repo will be copied into the hosts directory of CFS. This is mutually exclusive with the additional_inventory_source option and only one can be set.|
|additional_inventory_source|string|false|none|A CFS source with additional inventory files. All files in the repo will be copied into the hosts directory of CFS. This is mutually exclusive with the additional_source_url option and only one can be set.|
|batcher_max_backoff|integer|false|none|The maximum number of seconds that batcher will backoff from session creation if problems are detected.|
diff --git a/api/ims.md b/api/ims.md
index bc93969db56f..7464dd95d828 100644
--- a/api/ims.md
+++ b/api/ims.md
@@ -208,7 +208,11 @@ Retrieve a list of ImageRecords indicating images that are registered with IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
]
```
@@ -235,6 +239,9 @@ Status Code **200**
|»» etag|string|false|none|Opaque identifier used to uniquely identify the artifact in the artifact repository|
|»» type|string|true|none|Identifier specifying the artifact repository where the artifact is located|
|» arch|string|false|none|Target architecture for the recipe.|
+|» metadata|object|false|none|User supplied annotations about an image|
+|»» key|string|false|none|Template variable to associate with the IMS image|
+|»» value|string|false|none|Value variable to associate with the IMS image|
#### Enumerated Values
@@ -328,7 +335,11 @@ Create a new ImageRecord and register the new image with IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -352,7 +363,11 @@ Create a new ImageRecord and register the new image with IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -549,7 +564,11 @@ Retrieve an image by image_id.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -645,7 +664,12 @@ Update an ImageRecord in IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "operation": "set",
+ "key": "includes_additional_packages",
+ "value": "vim,emacs,man"
+ }
}
```
@@ -670,7 +694,11 @@ Update an ImageRecord in IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -872,7 +900,11 @@ Retrieve a list of DeletedImageRecords indicating images that have been deleted
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
]
```
@@ -900,6 +932,9 @@ Status Code **200**
|»» etag|string|false|none|Opaque identifier used to uniquely identify the artifact in the artifact repository|
|»» type|string|true|none|Identifier specifying the artifact repository where the artifact is located|
|» arch|string|false|none|Target architecture for the recipe.|
+|» metadata|object|false|none|User supplied annotations about an image|
+|»» key|string|false|none|Template variable to associate with the IMS image|
+|»» value|string|false|none|Value variable to associate with the IMS image|
#### Enumerated Values
@@ -1208,7 +1243,11 @@ Retrieve deleted image details by using deleted_image_id.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -1522,7 +1561,11 @@ Retrieve a list of ImageRecords indicating images that are registered with the I
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
]
```
@@ -1549,6 +1592,9 @@ Status Code **200**
|»» etag|string|false|none|Opaque identifier used to uniquely identify the artifact in the artifact repository|
|»» type|string|true|none|Identifier specifying the artifact repository where the artifact is located|
|» arch|string|false|none|Target architecture for the recipe.|
+|» metadata|object|false|none|User supplied annotations about an image|
+|»» key|string|false|none|Template variable to associate with the IMS image|
+|»» value|string|false|none|Value variable to associate with the IMS image|
#### Enumerated Values
@@ -1642,7 +1688,11 @@ Create a new ImageRecord and register the new image with IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -1667,7 +1717,11 @@ Create a new ImageRecord and register the new image with IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -1870,7 +1924,11 @@ Retrieve an image by image_id.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -1966,7 +2024,12 @@ Update an ImageRecord in IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "operation": "set",
+ "key": "includes_additional_packages",
+ "value": "vim,emacs,man"
+ }
}
```
@@ -1991,7 +2054,11 @@ Update an ImageRecord in IMS.
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
@@ -8781,39 +8848,42 @@ Values to update a RecipeRecord with
|arch|aarch64|
|arch|x86_64|
-ImageRecord
+ImagePatchRecord
-
-
-
-
+
+
+
+
```json
{
- "id": "46a2731e-a1d0-4f98-ba92-4f78c756bb12",
- "created": "2018-07-28T03:26:01.234Z",
- "name": "centos7.5_barebones",
"link": {
"path": "s3://boot-images/1fb58f4e-ad23-489b-89b7-95868fca7ee6/manifest.json",
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "operation": "set",
+ "key": "includes_additional_packages",
+ "value": "vim,emacs,man"
+ }
}
```
-An Image Record
+Values used to update an existing IMS Image Record
### Properties
|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
-|id|string(uuid)|false|read-only|Unique ID of the image.|
-|created|string(date-time)|false|read-only|Time the image record was created|
-|name|string|true|none|Name of the image|
|link|[ArtifactLinkRecord](#schemaartifactlinkrecord)|false|none|An Artifact Link Record|
|arch|string|false|none|Target architecture for the recipe.|
+|metadata|object|false|none|An object which indicates a number of annotation patch operations relating to image tags.|
+|» operation|string|true|none|How to update a given key within the context of a patch operation|
+|» key|string|true|none|The key to update for a given image|
+|» value|string|false|none|The value to associate with a key during a patch operation|
#### Enumerated Values
@@ -8821,31 +8891,36 @@ An Image Record
|---|---|
|arch|aarch64|
|arch|x86_64|
+|operation|set|
+|operation|remove|
-DeletedImageRecord
+ImageRecord
-
-
-
-
+
+
+
+
```json
{
"id": "46a2731e-a1d0-4f98-ba92-4f78c756bb12",
"created": "2018-07-28T03:26:01.234Z",
- "deleted": "2018-07-28T03:26:01.234Z",
"name": "centos7.5_barebones",
"link": {
"path": "s3://boot-images/1fb58f4e-ad23-489b-89b7-95868fca7ee6/manifest.json",
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
-A Deleted Image Record
+An Image Record
### Properties
@@ -8853,10 +8928,12 @@ A Deleted Image Record
|---|---|---|---|---|
|id|string(uuid)|false|read-only|Unique ID of the image.|
|created|string(date-time)|false|read-only|Time the image record was created|
-|deleted|string(date-time)|false|read-only|Time the image record was deleted|
|name|string|true|none|Name of the image|
|link|[ArtifactLinkRecord](#schemaartifactlinkrecord)|false|none|An Artifact Link Record|
|arch|string|false|none|Target architecture for the recipe.|
+|metadata|object|false|none|User supplied annotations about an image|
+|» key|string|false|none|Template variable to associate with the IMS image|
+|» value|string|false|none|Value variable to associate with the IMS image|
#### Enumerated Values
@@ -8865,33 +8942,48 @@ A Deleted Image Record
|arch|aarch64|
|arch|x86_64|
-ImagePatchRecord
+DeletedImageRecord
-
-
-
-
+
+
+
+
```json
{
+ "id": "46a2731e-a1d0-4f98-ba92-4f78c756bb12",
+ "created": "2018-07-28T03:26:01.234Z",
+ "deleted": "2018-07-28T03:26:01.234Z",
+ "name": "centos7.5_barebones",
"link": {
"path": "s3://boot-images/1fb58f4e-ad23-489b-89b7-95868fca7ee6/manifest.json",
"etag": "f04af5f34635ae7c507322985e60c00c-131",
"type": "s3"
},
- "arch": "aarch64"
+ "arch": "aarch64",
+ "metadata": {
+ "key": "includes_additional_packages",
+ "value": "foo,bar,baz"
+ }
}
```
-Values to update an ImageRecord with
+A Deleted Image Record
### Properties
|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
+|id|string(uuid)|false|read-only|Unique ID of the image.|
+|created|string(date-time)|false|read-only|Time the image record was created|
+|deleted|string(date-time)|false|read-only|Time the image record was deleted|
+|name|string|true|none|Name of the image|
|link|[ArtifactLinkRecord](#schemaartifactlinkrecord)|false|none|An Artifact Link Record|
|arch|string|false|none|Target architecture for the recipe.|
+|metadata|object|false|none|User supplied annotations about an image|
+|» key|string|false|none|Template variable to associate with the IMS image|
+|» value|string|false|none|Value variable to associate with the IMS image|
#### Enumerated Values