From 6492be22d7a2bc82c363cbd94c1af9eaca662fd0 Mon Sep 17 00:00:00 2001 From: Jenkins Date: Wed, 4 Sep 2024 22:12:34 +0000 Subject: [PATCH] Automated API docs swagger to md conversion (https://jenkins.algol60.net/job/Cray-HPE/job/csm/job/v1.6.0-alpha.65/1/) --- api/bos.md | 79 +++-------------------------- api/ims.md | 143 +++++++++++++++++++++++++++++++++++++++++++++++++++++ api/sls.md | 56 +++++++++++++++++++++ 3 files changed, 205 insertions(+), 73 deletions(-) diff --git a/api/bos.md b/api/bos.md index d1d14963abd3..fb92f20080f2 100644 --- a/api/bos.md +++ b/api/bos.md @@ -5118,7 +5118,7 @@ group of Components. |enable_cfs|[EnableCfs](#schemaenablecfs)|false|none|Whether to enable the Configuration Framework Service (CFS).| |cfs|[V2CfsParameters](#schemav2cfsparameters)|false|none|This is the collection of parameters that are passed to the Configuration
Framework Service when configuration is enabled. Can be set as the global value for
a Session Template, or individually within a Boot Set.| |boot_sets|object|true|none|Mapping from Boot Set names to Boot Sets.

* Boot Set names must be 1-127 characters in length.
* Boot Set names must use only letters, digits, periods (.), dashes (-), and underscores (_).
* Boot Set names must begin and end with a letter or digit.| -|» **additionalProperties**|[V2BootSet](#schemav2bootset)|false|none|none| +|» **additionalProperties**|[V2BootSet](#schemav2bootset)|false|none|A Boot Set is a collection of nodes defined by an explicit list, their functional
role, and their logical groupings. This collection of nodes is associated with one
set of boot artifacts and optional additional records for configuration and root
filesystem provisioning.

A boot set requires at least one of the following fields to be specified:
node_list, node_roles_groups, node_groups

If specified, the name field must match the key mapping to this boot set in the
boot_sets field of the containing V2SessionTemplate.| |links|[LinkListReadOnly](#schemalinklistreadonly)|false|none|List of links to other resources|

V2SessionTemplateValidation

@@ -5326,12 +5326,12 @@ Information on the status of a Session. |status|[V2SessionStatusLabel](#schemav2sessionstatuslabel)|false|none|The status of a Session.| |error|string¦null|false|none|Error which prevented the Session from running.
A null value means the Session has not encountered an error.| -

V2BootSetData

+

V2BootSet

- - - - + + + + ```json { @@ -5398,73 +5398,6 @@ boot_sets field of the containing V2SessionTemplate. |arch|Other| |arch|Unknown| -

V2BootSet

- - - - - - -```json -{ - "name": "compute", - "path": "s3://boot-images/9e3c75e1-ac42-42c7-873c-e758048897d6/manifest.json", - "cfs": { - "configuration": "compute-23.4.0" - }, - "type": "s3", - "etag": "1cc4eef4f407bd8a62d7d66ee4b9e9c8", - "kernel_parameters": "console=ttyS0,115200 bad_page=panic crashkernel=340M hugepagelist=2m-2g intel_iommu=off intel_pstate=disable iommu=pt ip=dhcp numa_interleave_omit=headless numa_zonelist_order=node oops=panic pageblock_order=14 pcie_ports=native printk.synchronous=y rd.neednet=1 rd.retry=10 rd.shell turbo_boost_limit=999 spire_join_token=${SPIRE_JOIN_TOKEN}", - "node_list": [ - "x3000c0s19b1n0", - "x3000c0s19b2n0" - ], - "node_roles_groups": [ - "Compute", - "Application" - ], - "node_groups": [ - "string" - ], - "arch": "X86", - "rootfs_provider": "cpss3", - "rootfs_provider_passthrough": "dvs:api-gw-service-nmn.local:300:nmn0" -} - -``` - -### Properties - -allOf - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|[V2BootSetData](#schemav2bootsetdata)|false|none|A Boot Set is a collection of nodes defined by an explicit list, their functional
role, and their logical groupings. This collection of nodes is associated with one
set of boot artifacts and optional additional records for configuration and root
filesystem provisioning.

A boot set requires at least one of the following fields to be specified:
node_list, node_roles_groups, node_groups

If specified, the name field must match the key mapping to this boot set in the
boot_sets field of the containing V2SessionTemplate.| - -and - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|any|false|none|none| - -anyOf - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|» *anonymous*|object|false|none|none| - -or - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|» *anonymous*|object|false|none|none| - -or - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|» *anonymous*|object|false|none|none| -

V2SessionTemplateArray

diff --git a/api/ims.md b/api/ims.md index 7464dd95d828..f322a70c077b 100644 --- a/api/ims.md +++ b/api/ims.md @@ -8443,6 +8443,117 @@ To perform this operation, you must be authenticated by means of one of the foll bearerAuth +

remote build node status

+ +## get_all_v3_remote_build_status + + + +> Code samples + +```http +GET https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status HTTP/1.1 +Host: api-gw-service-nmn.local +Accept: application/json + +``` + +```shell +# You can also use wget +curl -X GET https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status \ + -H 'Accept: application/json' \ + -H 'Authorization: Bearer {access-token}' + +``` + +```python +import requests +headers = { + 'Accept': 'application/json', + 'Authorization': 'Bearer {access-token}' +} + +r = requests.get('https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status', headers = headers) + +print(r.json()) + +``` + +```go +package main + +import ( + "bytes" + "net/http" +) + +func main() { + + headers := map[string][]string{ + "Accept": []string{"application/json"}, + "Authorization": []string{"Bearer {access-token}"}, + } + + data := bytes.NewBuffer([]byte{jsonReq}) + req, err := http.NewRequest("GET", "https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status", data) + req.Header = headers + + client := &http.Client{} + resp, err := client.Do(req) + // ... +} + +``` + +`GET /v3/remote-build-nodes/status` + +*List remote build node status objects* + +Retrieve the status of all remote build nodes that are registered with IMS. + +> Example responses + +> 200 Response + +```json +[ + { + "xname": "x3000c1s10b1n0", + "nodeArch": "x86_64", + "numCurrentJobs": 15, + "podmanStatus": "Podman present at /usr/bin/podman", + "sshStatus": "SSH connection established", + "ableToRunJobs": true + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|A collection of the status of each remote build node|Inline| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|An internal error occurred. Re-running the request may or may not succeed.|[ProblemDetails](#schemaproblemdetails)| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[RemoteBuildNodeStatus](#schemaremotebuildnodestatus)]|false|none|[A Remote Build Node Status]| +|» xname|string|true|none|Xname of the remote build node| +|» nodeArch|string|false|none|Architecture of the remote build node| +|» numCurrentJobs|integer|false|none|Number of current jobs running on the remote build node| +|» podmanStatus|string|false|none|Status of the podman executable on the remote build node| +|» sshStatus|string|false|none|Status of the ssh connection to the remote build node| +|» ableToRunJobs|boolean|false|none|If the node is able to run new jobs| + + + # Schemas

SSHConnectionInfo

@@ -8641,6 +8752,38 @@ A Remote Build Node Record |---|---|---|---|---| |xname|string|true|none|Xname of the remote build node| +

RemoteBuildNodeStatus

+ + + + + + +```json +{ + "xname": "x3000c1s10b1n0", + "nodeArch": "x86_64", + "numCurrentJobs": 15, + "podmanStatus": "Podman present at /usr/bin/podman", + "sshStatus": "SSH connection established", + "ableToRunJobs": true +} + +``` + +A Remote Build Node Status + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|xname|string|true|none|Xname of the remote build node| +|nodeArch|string|false|none|Architecture of the remote build node| +|numCurrentJobs|integer|false|none|Number of current jobs running on the remote build node| +|podmanStatus|string|false|none|Status of the podman executable on the remote build node| +|sshStatus|string|false|none|Status of the ssh connection to the remote build node| +|ableToRunJobs|boolean|false|none|If the node is able to run new jobs| +

ArtifactLinkRecord

diff --git a/api/sls.md b/api/sls.md index cd3931b65fa3..f7c2332c8177 100644 --- a/api/sls.md +++ b/api/sls.md @@ -329,6 +329,14 @@ Status Code **200** *xor* +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|»» *anonymous*|[hardware_comptype_virtual_node](#schemahardware_comptype_virtual_node)|false|none|none| +|»»» NodeType|string|true|none|The role type assigned to this node.| +|»»» nid|integer|false|none|none| + +*xor* + |Name|Type|Required|Restrictions|Description| |---|---|---|---|---| |»» *anonymous*|[hardware_ip_and_creds_optional](#schemahardware_ip_and_creds_optional)|false|none|none| @@ -349,6 +357,7 @@ Status Code **200** |NodeType|Application| |NodeType|Storage| |NodeType|Management| +|NodeType|Management|