Luna2 REST API
- Design decisions
- Changelog
- Fields
-
- Get group information (GET /config/group/{group})
- Get a list members of the groups (GET /config/group/{group}/_list)
- Create or update & Rename(By newgroupname) group information (POST /config/group/{group})
- Clone (By newgroupname) a group (POST /config/group/{group}/_clone)
- Deleting a group (GET /config/group/{group}/_delete)
- Get group interface information (GET /config/group/{group}/interfaces)
- Create or update group interface information (POST /config/group/{group}/interfaces)
- Retrieve group interface information (GET /config/group/{group}/interfaces/{interface})
-
Delete group interface (GET /config/group/{group}/interfaces/{interface}/_delete)
- Get node information (GET /config/node/{node})
- Create or update node information (POST /config/node/{node})
- Clone a node (POST /config/node/{node}/_clone)
- Deleting a node (GET /config/node/{node}/_delete)
- Listing node interfaces (GET /config/node/{node}/interfaces)
- Updating node interfaces (POST /config/node/{node}/interfaces)
- Showing node interfaces (GET /config/node/{node}/interfaces/{interface})
-
Delete node interfaces (GET /config/node/{node}/interfaces/{interface}/_delete)
- Get network information (GET /config/network/{networkname})
- Update network information (POST /config/network/{networkname})
- Cloning network information (POST /config/network/{networkname}/_clone)
- Deleting network information (GET /config/network/{networkname}/_delete)
- Get IP Address information (GET /config/network/{ipaddr})
- Get all taken IP address with device name (GET /config/network/{networkname}/_list)
-
Get next available IP address (GET /config/network/{networkname}/_nextfreeip)
- Get the list of nodes in BMC setup (GET /config/bmcsetup/{name}/_list)
- Show BMC setup (GET /config/bmcsetup/{bmcname})
- Create, configure or rename BMC setup (POST /config/bmcsetup/{bmcname})
- Clone BMC setup (POST /config/bmcsetup/{bmcname}/_clone)
- Get a list of images (POST /config/osimage):
- Get a list members of the osimage (GET /config/osimage/{osimage}/_list)
- Get osimage information (GET /config/osimage/{osimage})
- Updating or creating osimage information (POST /config/osimage/{osimage})
- Delete osimage (GET /config/osimage/{osimage}/_delete)
- Renaming osimage (POST /config/osimage/{osimage})
- Cloning osimage (POST /config/osimage/{osimage}/_clone)
- Packing osimage (GET /config/osimage/{osimage}/_pack)
- Changing kernel version in osimage (incl. pack) (POST /config/osimage/{osimage}/kernel)
- Get osimage+osimage tag information (GET /config/osimagetag)
- Get osimage+osimage tag information (GET /config/osimagetag/{osimage})
- Changing/creating tag in osimage (POST /config/osimage/{osimage}/tag)
- Get a list members of the osimage+osimagetag (GET /config/osimagetag/{osimage}/_member)
- Get a list of secrets, any auth (POST /config/secrets):
- Retrieve all secrets for a node (GET /config/secrets/node/{node})
- Update all secrets for a node (POST /config/secrets/node/{node})
- Retrieve a single secret from a node (GET /config/secrets/node/{node}/{secret})
- Updating a single secret from a node (POST /config/secrets/node/{node}/{secret})
- Cloning a secret from a node (GET /config/secrets/node/{node}/{secret}/_clone)
- Deleting a secret from a node (GET /config/secrets/node/{node}/{secret}/_delete)
- Deleting a secret from a node (POST /config/secrets/node/{node}/{secret}/_delete)
- Retrieve all secrets for a group (GET /config/secrets/group/{group})
- Updating all secrets for a group (POST /config/secrets/group/{group})
- Retrieve a single secret from a group (GET /config/secrets/group /{group }/{secret})
- Retrieve all secrets for a group (POST /config/secrets/group/{group})
- Updating a single secret from a group (POST /config/secrets/group /{group }/{secret})
- Cloning a secret from a group (GET /config/secrets/group /{group }/{secret}/_clone)
- Deleting a secret from a group (GET /config/secrets/group /{group }/{secret}/_delete)
-
Deleting a secret from a group (POST /config/secrets/group /{group }/{secret}/_delete)
- Get switch information (GET /config/switch/{switch}):
- Create or update switch information (POST /config/switch/{switch}):
- Clone switch (POST /config/switch/{switch}/_clone):
- Get otherdev information (GET /config/otherdev/{device}):
- Create or update otherdev information (POST/config/otherdev/{device}):
- Clone otherdev information (POST/config/otherdev/{device}/_clone):
-
Deleting otherdev device (GET /config/otherdev/{device}/_delete):
- Reload DHCP
- Monitoring DHCP service
- Monitoring Luna2 service
- Node monitoring (GET /monitor/status/{node})
-
Control API (GET /control/action/{command}/{hostname}/_{action})
- Control API (POST /control/action/power/_on)
- Control API (POST /control/action/chassis/_identify)
- Get a single rack with detailed view
- Create a new or update a rack
- Get all the inventories in detailed view
- Get all the configured or unconfigured inventories in detailed view
- Update a Inventory
- Delete a Rack
- Update journal with entries on controller
- Full spec JSON
Design decisions
-
No implementation of 300 (redirects)
-
Not all errors are implemented
-
Not all methods are supported, only GET and POST
-
All POST request body are required to have valid JSON (RFC 8259). The server will not validate for the client, simply reject any malformed request. There are ways to format and validate it in Linux / python.
-
Monitoring end-points are provided on /monitor.
-
HTTP codes must also be passed back
Changelog
Removals:
-
Removal of lweb (replaced by REST API), same port (7050)
-
auto creation of nodes is removed (Create=True), also removing the nodeprefix and nodedigits configuration items
Changes:
-
newfieldname can be used for cloning ({name}/_clone) and renaming ({name})
-
dhcp configuration has been removed from cluster level and moved to network (now enables/disables per network)
New features:
General:
-
Templating jinja2
-
Standardized jinja2 variables available in the LUNA installer for further customization
-
Full URI is also required in the request body and response body
-
URI is consistent with request and response body
Authentication
- Role based authentication, default group: admin
Provisioning
-
Provisioning default is torrent
-
Fallback via /files/{tarball} via webservice
-
Configurable via the cluster endpoint, override possible on group or node level
-
Configurable provisioning allows for future provisioning methods such as rsync, kickstart or anything scriptable
Group configuration:
-
Netboot (offering PXE menu or minimized boot menu -> LOCALDISK)
-
Localinstall (triggers Grub2 installation)
Network:
-
API to get next available IP (can be called manually) /config/network/_nextfreeip
-
Renumbering will not be done if:
-
the new group has the same network interfaces and networks
-
the IP is still valid in the new group
NTP configuration (cluster/network):
-
Can be configured cluster wide
-
Override possible on network level
BMC setup
-
Added gateway configuration (taken from network configuration)
-
Added NTP configuration (taken from network configuration)
Secrets
- Secrets can be configured on group or node level. These are placed inside the OSimage, preventing placement of sensitive information in images.
OSimage:
-
Changing kernel can be done with (/config/osimage/{osimage}/kernel) automatic packing or without (/config/osimage/{osimage}
-
Cloning includes copying of the files, done by ZFS so it should be very quick
-
Distribution flag (default redhat) which should trigger different dracut/packing in future releases
Monitor
-
Added monitoring endpoints for nodes
-
Self-monitoring daemon (/monitor/service/luna2)
Service control via daemon API
- Monitoring & control of dhcp and dns
Rest resources
Note: There is no cluster configuration. This is to be done by the ini files to prevent breaking installations
Examples
http://host:port/config/node/{node}
Structure of the URI
-
host and port define the host and port where the application lives
-
config is the context for updating or deleting the node at {node}
All POST Method(s) requires a valid token to get the response. Except /token
All Get Method will get the minimal response if the token isn’t set in the headers.
the ** key will hold the token against the apis.
Initially, Tokens are sha256 encoded.
URI Structure
See Luna2 REST API URI Structure
Fields
API Usage
Authenticate against the API (POST /token)
When talking to the API, a token is required. The token can be obtained from the token endpoint.
Request
POST /token
Request header
Request body
{
"username": "luna",
"password": "luna"
}
Response body
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
}
Response header
HTTP 201 Created
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if the credentials are invalid
HTTP 400 Bad request
when the request is invalid (field definitions)
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Version
A very simple endpoint. No auth required and no modifications allowed.
Returned:
-
Luna version
-
API version it supports (this document)
-
Commit (from Git)
Get version (GET /version)
Request
GET /version
Response body
{
"version": {
"luna": "2.0.0001",
"api": 1,
"commit": "hex(commit)"
}
}
Request header
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Booting
The boot menu entry will give out one of several templates: https://clustervision.atlassian.net/wiki/spaces/TRIX/pages/11534355/TrinityX+12.1+Design+documents#Boot-process
-
templ_boot_ipxe.cfg (default)
-
templ_boot_disk.cfg
-
templ_boot_ipxe_short.cfg
The controller writes out the DHCP configuration. The normal iPXE menu is served when the
bootmenu
and
netboot
flags have been set to True (see
TRIX-39 - Getting issue details... STATUS
)
Node is known |
Bootmenu |
Netboot |
Template |
|
|---|---|---|---|---|
1 |
Yes |
False |
True |
Short |
2 |
Yes |
True |
True |
Normal |
3 |
Yes |
Any |
False |
Disk |
4 |
No |
- |
- |
Normal |
The DHCP configuration is changed to reflect booting off different templates.
2 + 4:
host node001 {
hardware ethernet 18:c0:4d:45:00:eb;
fixed-address 10.141.0.1;
}
1:
host node001 {
hardware ethernet 18:c0:4d:45:00:eb;
fixed-address 10.141.0.1;
filename "http://10.141.255.254:7050/boot/short"
}
3:
host node001 {
hardware ethernet 18:c0:4d:45:00:eb;
fixed-address 10.141.0.1;
filename "http://10.141.255.254:7050/boot/disk"
}
Boot by MAC (or port detection)
The node will do a discovery (auto menu selection)
Request
GET /boot/search/18:c0:4d:45:00:eb
Response
The response is an iPXE script which can be booted from.
#!ipxe
imgfetch -n kernel http://10.141.255.254:7050/boot/compute-vmlinuz-4.18.0-372.26.1.el8_6.x86_64
imgload kernel
imgargs kernel root=luna luna.bootproto=static luna.mac=18:c0:4d:45:00:eb luna.ip=10.141.0.1/16 luna.url=http://10.141.255.254:7050/luna luna.node=node001 luna.hostname=node001.cluster luna.service=0 initrd=initrd.img
imgfetch --name initrd.img http://10.141.255.254:7050/boot/compute-initramfs-4.18.0-372.26.1.el8_6.x86_64
imgexec kernel
Manual boot
Request
GET /boot/manual/hostname/node002
Response
The controller will immediately change the hostname in the backend to reflect the change, removing the previous settings for the entry.
The response will allow booting from an alternative hostname. Note the changed
luna.node
and
luna.hostname
parameter.
#!ipxe
imgfetch -n kernel http://10.141.255.254:7050/boot/compute-vmlinuz-4.18.0-372.26.1.el8_6.x86_64
imgload kernel
imgargs kernel root=luna luna.bootproto=static luna.mac=18:c0:4d:45:00:eb luna.ip=10.141.0.1/16 luna.url=http://10.141.255.254:7050/luna luna.node=node002 luna.hostname=node002.cluster luna.service=0 initrd=initrd.img
imgfetch --name initrd.img http://10.141.255.254:7050/boot/compute-initramfs-4.18.0-372.26.1.el8_6.x86_64
imgexec kernel
Luna installation template (GET boot/install/{node})
The
luna.node
and
luna.hostname
are passed through the boot parameters and are used to retrieve the installation template. Note that the API must verify that the request is originating from the node itself by checking the IP address (i.e. 10.141.0.1 can only request a template belonging to node001).
Request
GET /boot/install/node001
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response
The response would be a tailored installation script for this node (See #pre, #part, #postscripts) in plain text.
export LUNA_IMAGEFILE=''
export LUNA_OSIMAGE=''
export LUNA_TOKEN="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MCwiZXhwIjoxNzM5MjcxNzA2fQ.2HUmy8sL5oFtzayjWBfUeK0huezEk6rA9qt41_VixCU"
export DECODE=""
## ----------- useful variable exports -----------
export _HOSTNAME="node001"
export _SYSTEMROOT="/sysroot"
export _BOOTIF=${LUNA_BOOTIF}
## -----------------------------------------------
export INSECURE='--insecure'
if [ -n "${LUNA_BOOTIF}" ]; then
export INTERFACE="--interface ${LUNA_BOOTIF}"
fi
if [ "$(echo LUNA_API_PROTOCOL | grep ':')" ]; then
export LUNA_URL="http://[10.141.255.254]:7050"
else
export LUNA_URL="http://10.141.255.254:7050"
fi
base64 --help &> /dev/null
if [ "$?" == "0" ]; then
DECODE=1
fi
if [ ! "$DECODE" ]; then
echo "Luna2: --WARNING-- base64 decoder not available. This will impair the installer"
fi
function update_status {
json='{"monitor": { "status": { "node001": { "state": "'$1'" } } } }'
curl $INTERFACE $INSECURE -X POST -H "x-access-tokens: $LUNA_TOKEN" -H "Content-Type: application/json" -d "$json" -s "${LUNA_URL}/monitor/node/node001"
}
function update_system_info {
dmidecode --help &> /dev/null
ret=$?
if [ "$ret" == "0" ]; then
vendor=$(dmidecode -s system-manufacturer)
assettag=$(dmidecode -s system-serial-number)
json='{"config": {"node": { "node001": { "vendor": "'$vendor'", "assettag": "'$assettag'" } } } }'
curl $INTERFACE $INSECURE -X POST -H "x-access-tokens: $LUNA_TOKEN" -H "Content-Type: application/json" -d "$json" -s "${LUNA_URL}/config/node/node001"
else
echo "Luna2: dmidecode not found and could therefor not update system information"
fi
}
function update_node_ip {
json='{"config": {"node": {"node001": {"name": "node001", "interfaces": [{"interface": "BOOTIF", "force": true, "ipaddress": "'$1'"}]}}}}'
curl $INTERFACE $INSECURE -X POST -H "x-access-tokens: $LUNA_TOKEN" -H "Content-Type: application/json" -d "$json" -s "${LUNA_URL}/config/node/node001"
}
function lunainit {
if [ ! -d /lunatmp ]; then
mkdir /lunatmp
fi
if [ ! -d //sysroot ]; then
echo "Luna2: Warning! /sysroot did not exist! it's unexpected. I will create it and try to continue"
mkdir //sysroot
fi
}
function dynamic_ip_check {
if [ "${LUNA_BOOTPROTO}" == "dhcp" ]; then
echo "Luna2: I need to update luna to reflect my dynamic IP address"
if [ "${LUNA_BOOTIF}" ]; then
MY_IP=$(ip a show dev ${LUNA_BOOTIF}|grep -oE "inet [0-9\.]+"|grep -oE "[0-9\.]+")
if [ "${MY_IP}" ]; then
update_node_ip $MY_IP
else
echo "Luna2: Could not figure out my IP address"
fi
else
echo "Luna2: BOOTIF is not defined"
fi
fi
}
...
...
...
Group configuration
Get a list of groups (GET /config/group)
Request
GET /config/group
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"group": {
"compute": {
"bmcsetup": true,
"bmcsetupname": "gigabyte",
"domain": "cluster",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
],
"osimage": "compute",
"osimagetag": "versionx",
"partscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"postscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"prescript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"provision_interface": null,
"netboot": true,
"localinstall": false,
"bootmenu": false,
"comment": "Default group",
"provision_method": "torrent",
"provision_fallback": "http"
},
"compute-ib": {
"bmcsetup": true,
"bmcsetupname": "gigabyte",
"domain": "cluster",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
],
"osimage": "compute",
"partscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"postscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"prescript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"provision_interface": null,
"netboot": true,
"localinstall": false,
"bootmenu": false,
"comment": "Default group",
"provision_method": "torrent",
"provision_fallback": "http",
"_override": False
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get group information (GET /config/group/{group})
Request
GET /config/group/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"group": {
"compute": {
"bmcsetup": true,
"bmcsetupname": "gigabyte",
"domain": "cluster",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
],
"osimage": "compute",
"osimagetag": "versionx",
"partscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"postscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"prescript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"provision_interface": null,
"netboot": true,
"localinstall": false,
"bootmenu": false,
"comment": "Default group",
"provision_method": "torrent",
"provision_fallback": "http",
"_override": False
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get a list members of the groups (GET /config/group/{group}/_list)
Request
GET /config/group/{group}/_list
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"group": {
"compute": {
"members": [
"node001",
"node002",
"node003",
"node004"
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Create or update & Rename(By newgroupname) group information (POST /config/group/{group})
Request
POST /config/group/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"group": {
"compute": {
"newgroupname": "compute-gpu",
"bmcsetup": true,
"bmcsetupname": "gigabyte",
"domain": "cluster",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
],
"osimage": "compute",
"osimagetag": "versionx",
"partscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"postscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"prescript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"provision_interface": null,
"netboot": true,
"localinstall": false,
"bootmenu": false,
"comment": "Default group",
"provision_method": "torrent",
"provision_fallback": "http",
"_override": False
}
}
}
}
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 201 Created
will be expected to be returned when a new object is created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Clone (By newgroupname) a group (POST /config/group/{group}/_clone) 
Request
POST /config/group/compute/_clone
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"group": {
"compute": {
"newgroupname": "compute-gpu",
"bmcsetup": true,
"bmcsetupname": "gigabyte",
"domain": "cluster",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
],
"osimage": "compute",
"osimagetag": "versionx",
"partscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"postscript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"prescript": "IyEvYmluL2Jhc2gKZXhpdCAw",
"provision_interface": null,
"netboot": true,
"localinstall": false,
"bootmenu": false,
"comment": "Default group",
"provision_method": "torrent",
"provision_fallback": "http"
}
}
}
}
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 201 Created
will be expected to be returned when a new object is created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting a group (GET /config/group/{group}/_delete)
Request
POST /config/group/compute/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get group interface information (GET /config/group/{group}/interfaces)
Request
GET /config/group/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"group": {
"compute": {
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Create or update group interface information (POST /config/group/{group}/interfaces)
The interfaces can accept updates to one or more interfaces.
Request
POST /config/group/compute/interfaces
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"group": {
"compute": {
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
]
}
}
}
}
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 201 Created
will be expected to be returned when created
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist (group)
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Retrieve group interface information (GET /config/group/{group}/interfaces/{interface})
Request
GET /config/group/compute/interfaces/BOOTIF
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"group": {
"compute": {
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
}
]
}
}
}
}
Response body
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist (group)
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete group interface (GET /config/group/{group}/interfaces/{interface}/_delete)
Request
GET /config/group/compute/interfaces/BOOTIF/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist (group)
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Node configuration
Get a list of nodes (GET /config/node)
Request
GET /config/node
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"node": {
"node001": {
"group": "compute",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
},
{
"interface": "BMC",
"network": "ipmi",
"ipaddress": "10.148.0.1"
},
{
"interface": "ib0",
"network": "ib",
"ipaddress": "10.149.0.1"
}
],
"macaddr": "aa:bb:cc:dd:ee:ff",
"switch": "switch01",
"switchport": 1,
"service": false,
"setupbmc": true,
"status": "installer.completed",
"comment": null,
"osimage": null,
"osimagetag": null,
"prescript": null,
"postscript": null,
"partscript": null,
"netboot": true,
"bootmenu": false,
"localinstall": false,
"provision_interface": null,
"provision_method": null,
"provision_fallback": null,
"tpm_uuid": null,
"tpm_pubkey": null,
"tpm_sha256": null,
"_override": False
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get node information (GET /config/node/{node})
Request
GET /config/node
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"node": {
"node001": {
"group": "compute",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
},
{
"interface": "BMC",
"network": "ipmi",
"ipaddress": "10.148.0.1"
},
{
"interface": "ib0",
"network": "ib",
"ipaddress": "10.149.0.1"
}
],
"macaddr": "aa:bb:cc:dd:ee:ff",
"switch": "switch01",
"switchport": 1,
"service": false,
"setupbmc": true,
"status": "installer.completed",
"comment": null,
"osimage": null,
"osimagetag": null,
"prescript": null,
"postscript": null,
"partscript": null,
"netboot": true,
"bootmenu": false,
"localinstall": false,
"provision_interface": null,
"provision_method": null,
"provision_fallback": null,
"tpm_uuid": null,
"tpm_pubkey": null,
"tpm_sha256": null
"_override": False
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Create or update node information (POST /config/node/{node})
Renaming a node is done by setting the
newhostname
field
Interfaces can be updated in bulk via the {node}, or single items via the {node}/interfaces
Request
POST /config/node/{node}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"node": {
"node001": {
"group": "compute",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
},
{
"interface": "BMC",
"network": "ipmi",
"ipaddress": "10.148.0.1"
},
{
"interface": "ib0",
"network": "ib",
"ipaddress": "10.149.0.1"
}
],
"macaddr": "aa:bb:cc:dd:ee:ff",
"switch": "switch01",
"switchport": 1,
"service": false,
"setupbmc": true,
"status": "installer.completed",
"comment": null,
"osimage": null,
"osimagetag": null,
"prescript": null,
"postscript": null,
"partscript": null,
"netboot": true,
"bootmenu": false,
"localinstall": false,
"provision_interface": null,
"provision_method": null,
"provision_fallback": null,
"tpm_uuid": null,
"tpm_pubkey": null,
"tpm_sha256": null
}
}
}
}
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 201 Created
will be expected to be returned when a new object has been created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Clone a node (POST /config/node/{node}/_clone)
Renaming a node is done by setting the
newhostname
field
Interfaces can be updated in bulk via the {node}, or single items via the {node}/interfaces
Request
POST /config/node/{node}/_clone
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"node": {
"node001": {
"group": "compute",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
},
{
"interface": "BMC",
"network": "ipmi",
"ipaddress": "10.148.0.1"
},
{
"interface": "ib0",
"network": "ib",
"ipaddress": "10.149.0.1"
}
],
"macaddr": "aa:bb:cc:dd:ee:ff",
"switch": "switch01",
"switchport": 1,
"service": false,
"setupbmc": true,
"status": "installer.completed",
"comment": null,
"osimage": null,
"osimagetag": null,
"prescript": null,
"postscript": null,
"partscript": null,
"netboot": true,
"bootmenu": false,
"localinstall": false,
"provision_interface": null,
"provision_method": null,
"provision_fallback": null,
"tpm_uuid": null,
"tpm_pubkey": null,
"tpm_sha256": null
}
}
}
}
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 201 Created
will be expected to be returned when a new object has been created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting a node (GET /config/node/{node}/_delete)
Request
GET /config/node/node001/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 401 Not Found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Listing node interfaces (GET /config/node/{node}/interfaces)
Request
GET /config/node/node001/interfaces
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"node": {
"node001": {
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
},
{
"interface": "BMC",
"network": "ipmi",
"ipaddress": "10.148.0.1"
},
{
"interface": "ib0",
"network": "ib",
"ipaddress": "10.149.0.1"
}
]
}
}
}
}
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 401 Not Found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Updating node interfaces (POST /config/node/{node}/interfaces)
Request
POST /config/node/node001/interfaces
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"node": {
"node001": {
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
},
{
"interface": "BMC",
"network": "ipmi",
"ipaddress": "10.148.0.1"
},
{
"interface": "ib0",
"network": "ib",
"ipaddress": "10.149.0.1"
}
]
}
}
}
}
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not Found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Showing node interfaces (GET /config/node/{node}/interfaces/{interface})
Request
GET /config/node/node001/interfaces/BOOTIF
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"node": {
"node001": {
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
}
]
}
}
}
}
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not Found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete node interfaces (GET /config/node/{node}/interfaces/{interface}/_delete)
Request
GET /config/node/node001/interfaces/BOOTIF/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not Found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Cluster information
The cluster endpoint mostly read-only, and can not be used to modify the configuration. All the configuration is done via the ini and will require restarting the daemon.
Only configurable items are:
-
ntp_server
-
technical_contacts
-
provisioning_method
-
provision_fallback
-
debug
Get cluster information (GET /config/cluster)
Request
GET /config/cluster
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"cluster": {
"controller1": {
"status": "primary",
"ipaddr": "10.141.255.254",
"serverport": 7050,
"luna_config": "/trinity/local/luna/config/luna-daemon.ini"
},
"controller2": {
"status": "standby",
"ipaddr": "10.141.255.253",
"serverport": 7050,
"luna_config": "/trinity/local/luna/config/luna-daemon.ini"
},
"ntp_server": "10.141.255.252",
"debug": false,
"technical_contacts": "root@localhost",
"provision_method": "torrent",
"provision_fallback": "http"
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Update cluster information (POST /config/cluster)
Request
POST /config/cluster
Request body
{
"config": {
"cluster": {
"ntp_server": "10.141.255.252",
"debug": false,
"technical_contacts": "root@localhost",
"provision_method": "torrent",
"provision_fallback": "http"
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 400 Bad request
is mandatory if the controller objects are attempted to be modified
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Network Management
Network management covers the network configuration section of the configuration management database. It does not configure the network equipment.
Get the list of networks (GET /config/network)
Request
GET /config/network
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"network": {
"cluster": {
"network": "10.141.0.0/16",
"ns_hostname": "controller.cluster",
"ns_ip": "10.141.255.254",
"ntp_server": "10.141.255.254",
"gateway": "10.141.255.254",
"comment": "Default cluster network",
"dhcp": true,
"dhcp_range_begin": "10.141.0.200",
"dhcp_range_end": "10.141.0.253"
},
"ipmi": {
"network": "10.148.0.0/16",
"ns_hostname": "controller.ipmi",
"ns_ip": "10.148.255.254",
"ntp_server": "10.148.255.254",
"gateway": "10.148.255.254",
"comment": "Default OOB network",
"dhcp": false
},
"ib": {
"network": "10.149.0.0/16",
"ns_hostname": "controller.ib",
"ns_ip": "10.149.255.254",
"ntp_server": "10.149.255.254",
"gateway": "10.149.255.254",
"comment": "Default highspeed interconnect network",
"dhcp": false
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get network information (GET /config/network/{networkname})
Request
GET /config/network/cluster
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"network": {
"cluster": {
"name": "cluster",
"network": "10.141.0.0/16",
"gateway": "10.141.255.254",
"ns_hostname": "controller.cluster",
"ns_ip": "10.141.255.254",
"ntp_server": "10.141.255.254",
"comment": "Default cluster network",
"dhcp": true,
"dhcp_range_begin": "10.141.0.200",
"dhcp_range_end": "10.141.0.253"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Update network information (POST /config/network/{networkname})
Request
POST /config/network/cluster
Request body
{
"config": {
"network": {
"cluster": {
"newnetname": "cluster2",
"network": "10.141.0.0/16",
"gateway": "10.141.255.254",
"ns_hostname": "controller.cluster",
"ns_ip": "10.141.255.254",
"ntp_server": "10.141.255.254",
"comment": "Default cluster network",
"dhcp": true,
"dhcp_range_begin": "10.141.0.200",
"dhcp_range_end": "10.141.0.253"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 201 Created
will be expected to be returned when a new object is created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Cloning network information (POST /config/network/{networkname}/_clone)
Request
POST /config/network/cluster/_clone
Request body
{
"config": {
"network": {
"cluster": {
"newnetname": "cluster2",
"network": "10.141.0.0/16",
"ns_hostname": "controller.cluster",
"ns_ip": "10.141.255.254",
"ntp_server": "10.141.255.254",
"gateway": "10.141.255.254",
"comment": "Default cluster network",
"dhcp_enable": true,
"dhcp_begin": "10.141.0.200",
"dhcp_end": "10.141.0.253"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting network information (GET /config/network/{networkname}/_delete)
Request
GET /config/network/cluster/_delete
Request body
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 201 Created
will be expected to be returned when a new object is created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get IP Address information (GET /config/network/{ipaddr})
Request
GET /config/network/cluster/10.141.0.3
Request header
Response body
{
"config": {
"network": {
"10.141.0.1": {
"status": "free"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned when the query executes. The client is responsible for handling the response
HTTP 404 Not found
when the IP is not in the network range (out-of-scope)
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get all taken IP address with device name (GET /config/network/{networkname}/_list)
This API will fetch all the taken IP address with there device names.
Request
GET /config/network/cluster/_list
Request header
Response body
{
"config": {
"network": {
"cluster": {
"taken": [
{"ipaddress": "10.141.255.254", "device": "controller"},
{"ipaddress": "10.141.0.1", "device": "node001"},
{"ipaddress": "10.141.0.2", "device": "node003"},
{"ipaddress": "10.141.0.3", "device": "switch001"},
{"ipaddress": "10.141.0.4", "device": "otherdevice003"}
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned when the query executes. The client is responsible for handling the response
HTTP 404 Not found
when the IP is not in the network range (out-of-scope)
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get next available IP address (GET /config/network/{networkname}/_nextfreeip)
The Next IP will search the database for the next available IP address:
-
check database for occupied nodes, otherdev addresses,
-
removing the gateway and network addresses
-
returning the first available address in the range
The client is responsible for processing this, no reservation is made.
Request
GET /config/network/cluster/_nextfreeip
Request header
Response body
{
"config": {
"network": {
"cluster": {
"nextip": "10.141.0.2"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned when the query executes. The client is responsible for handling the response
HTTP 404 Not found
when the IP is not in the network range (out-of-scope)
HTTP 503 Service unavailable
is returned when the backend is unavailable.
BMC Management
BMC management entails the ipmi settings. The actual trigger to setup the BMC is done in the group or node configuration using the
setupbmc
boolean.
Get the list of BMC settings (GET /config/bmcsetup)
Request
GET /config/bmcsetup
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"bmcsetup": {
"dell": {
"mgmtchannel": 1,
"netchannel": 1,
"password": "calvin",
"username": "root",
"userid": 2,
"comment": "Default DELL"
},
"gigabyte": {
"mgmtchannel": 1,
"netchannel": 1,
"password": "password",
"username": "admin",
"userid": 2,
"comment": "Default Gigabyte"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get the list of nodes in BMC setup (GET /config/bmcsetup/{name}/_list)
Request
GET /config/bmcsetup/dell/_list
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"bmcsetup": {
"ipmi": {
"members": [
"node001",
"node002",
"node003",
"node004"
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Show BMC setup (GET /config/bmcsetup/{bmcname})
Request
GET /config/bmcsetup/dell
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"bmcsetup": {
"dell": {
"mgmtchannel": 1,
"netchannel": 1,
"password": "calvin",
"username": "root",
"userid": 2,
"comment": "Default DELL"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Create, configure or rename BMC setup (POST /config/bmcsetup/{bmcname})
Renaming is done by setting the newbmcname field.
Request
POST /config/bmcsetup/dell
Request body
{
"config": {
"bmcsetup": {
"dell": {
"newbmcname": "dell2"
"mgmtchannel": 1,
"netchannel": 1,
"password": "calvin",
"username": "root",
"userid": 2,
"comment": "Default DELL"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 200 OK
will be expected to be returned when updating fields
HTTP 201 Created
will be expected when the BMC setup is created
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Clone BMC setup (POST /config/bmcsetup/{bmcname}/_clone)
Cloning is done by setting the newbmcname field. In this example the
dell
bmcsetup is cloned to
dell2
.
Request
POST /config/bmcsetup/dell/_clone
Request body
{
"config": {
"bmcsetup": {
"dell": {
"newbmcname": "dell2"
"mgmtchannel": 1,
"netchannel": 1,
"password": "calvin",
"username": "root",
"userid": 2,
"comment": "Default DELL"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 201 Created
will be expected when the BMC setup is created
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete BMC setup (GET /config/bmcsetup/{bmcname}/_delete)
Removing an object is done by calling the _delete on the object.
Request
GET /config/bmcsetup/dell/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected when the object is succesfully deleted
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Image management
Image management is mostly token based, as it made introduce breaking changes to the system.
Get a list of images (GET /config/osimage):
Request
GET /config/osimage
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"osimage": {
"compute": {
"dracutmodules": "luna, -18n, -plymouth",
"grab_exclude_list": [
"/dev",
"/proc",
"/sys"
],
"grab_filesystems": [
"/",
"/boot"
],
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"kernmodules": "ipmi_devinft, ipmi_si, ipmi_msghandler",
"kernopts": "mitigations=off nosmt noht",
"kernver": "`uname -r`",
"path": "/trinity/images/compute",
"tarball": "uuid",
"torrent": "uuid",
"comment": "Default image"
},
"compute-ib": {
"dracutmodules": "luna, -18n, -plymouth",
"grab_exclude_list": [
"/dev",
"/proc",
"/sys"
],
"grab_filesystems": [
"/",
"/boot"
],
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"kernmodules": "ipmi_devinft, ipmi_si, ipmi_msghandler",
"kernopts": "mitigations=off nosmt noht",
"kernver": "`uname -r`",
"path": "/trinity/images/compute-ib",
"tarball": "uuid",
"torrent": "uuid",
"comment": "Default image with updated drivers"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get a list of images (POST /config/osimage):
Request
POST /config/osimage
Request header
Response body
Response header
HTTP 400 Bad request
since it is unsupported
Get a list members of the osimage (GET /config/osimage/{osimage}/_list)
Request
GET /config/osimage/{osimage}/_list
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"osimage": {
"compute-b": {
"members": [
"node001",
"node002",
"node003",
"node004"
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get osimage information (GET /config/osimage/{osimage})
Request
GET /config/osimage/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"osimage": {
"compute": {
"dracutmodules": "luna, -18n, -plymouth",
"grab_exclude_list": [
"/dev",
"/proc",
"/sys"
],
"grab_filesystems": [
"/",
"/boot"
],
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"kernmodules": "ipmi_devinft, ipmi_si, ipmi_msghandler",
"kernopts": "mitigations=off nosmt noht",
"kernver": "`uname -r`",
"path": "/trinity/images/compute",
"tarball": "uuid",
"torrent": "uuid",
"comment": "Default image"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Updating or creating osimage information (POST /config/osimage/{osimage})
Note that when posting to a non-existing osimage name, it will create the image with the settings submitted.
Request
POST /config/osimage/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"osimage": {
"compute": {
"comment": "Default image",
"distribution": "redhat",
"dracutmodules": "luna, -18n, -plymouth",
"grab_exclude": [
"/dev",
"/proc",
"/sys"
],
"grab_filesystems": [
"/",
"/boot"
],
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"kernelmodules": "ipmi_devinft, ipmi_si, ipmi_msghandler",
"kerneloptions": "mitigations=off nosmt noht",
"kernelversion": "`uname -r`",
"path": "/trinity/images/compute",
"tarball": "uuid",
"torrent": "uuid"
}
}
}
}
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 201 Created
will be expected when a new object is created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete osimage (GET /config/osimage/{osimage}/_delete)
Request
GET /config/osimage/compute/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Renaming osimage (POST /config/osimage/{osimage})
This example will rename the image compute to compute-ib.
Request
POST /config/osimage/compute/
Request body
{
"config": {
"osimage": {
"compute": {
"newosimage": "compute-ib"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the newosimage field is not set.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Cloning osimage (POST /config/osimage/{osimage}/_clone)
This example will clone the image compute to compute-ib.
Request
POST /config/osimage/compute/_clone
Request body
{
"config": {
"osimage": {
"compute": {
"newosimage": "compute-ib"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response header
HTTP 201 Created
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the newosimage field is not set.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Packing osimage (GET /config/osimage/{osimage}/_pack)
This example will pack the osimage compute.
Request
GET /config/osimage/compute/_pack
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Changing kernel version in osimage (incl. pack) (POST /config/osimage/{osimage}/kernel)
This example will pack the osimage compute, as well as triggering a pack afterwards.
Request
POST /config/osimage/compute/kernel
Request body
{
"config": {
"osimage": {
"compute": {
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"kernver": "`uname -r`"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get osimage+osimage tag information (GET /config/osimagetag)
Request
GET /config/osimagetag
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"osimagetag": {[
"versionx": {
"name": "versionx",
"osimage": "compute",
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"imagefile": "uuid"
}
]}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get osimage+osimage tag information (GET /config/osimagetag/{osimage})
Request
GET /config/osimagetag/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"osimagetag": {[
"versionx": {
"name": "versionx",
"osimage": "compute",
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"imagefile": "uuid"
}
]}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Changing/creating tag in osimage (POST /config/osimage/{osimage}/tag)
Request
POST /config/osimage/compute/tag
Request body
{
"config": {
"osimage": {
"compute": {
"tag": "version1"
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned for change, create or update.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get a list members of the osimage+osimagetag (GET /config/osimagetag/{osimage}/_member)
Request
GET /config/osimagetag/{osimage}/_member
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"osimage": {
"compute-b": {
"members": [
"node001",
"node002",
"node003",
"node004"
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete osimagetag (GET /config/osimage/{osimage}/osimagetag/{tagname}/_delete) ← should we rename osimagetag to just tag to be consistent with the POST request?
Request
GET /config/osimage/compute/osimagetag/versionx/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Secret management
Secrets (encrypted data) may not be revealed without a valid token. The secrets endpoint is token only.
Secrets are stored on node and group level, proper resolving of the hierarchy is the responsibility of the API.
Secrets can be requested on different levels:
-
Global (list)
-
Overview of node (incl. group)
-
Overview of group
-
Single item from node
-
Single item from group
Get a list of secrets (GET /config/secrets):
Request
GET /config/secrets
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"secrets": {
"node": {
"node001": [
{
"secretname": "shared secret",
"content": "<ENC>",
"path": "/etc/keys.crt"
},
{
"secretname": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
},
{
"secretname": "shared secret",
"content": "<ENC>",
"path": "/etc/keys.crt"
}
],
"node002": [
{
"secretname": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
}
]
},
"group": {
"compute": [
{
"secretname": "Proprietary key",
"content": "<ENC>",
"path": "/var/lib/key.pem"
}
],
"compute-ib": [
{
"secretname": "Infiniband",
"content": "<ENC>",
"path": "/etc/rdma/license.lic"
}
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get a list of secrets, any auth (POST /config/secrets):
Request
POST /config/secrets
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 400 Bad request
since it is an unsupported request
Retrieve all secrets for a node (GET /config/secrets/node/{node})
Token is required. Note that the secrets from the group membership must also be resolved and provided.
Request
GET /config/secrets/node/node002
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"secrets": {
"node": {
"node002": [
{
"secretname": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
}
]
},
"group": {
"compute-ib": [
{
"secretname": "Infiniband",
"content": "<ENC>",
"path": "/etc/rdma/license.lic"
}
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Update all secrets for a node (POST /config/secrets/node/{node})
Request
POST /config/secrets/node/node001
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"secrets": {
"node": {
"node001": [
{
"secretname": "shared secret",
"content": "<ENC>",
"path": "/etc/keys.crt"
},
{
"secretname": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
},
{
"secretname": "shared secret",
"content": "<ENC>",
"path": "/etc/keys.crt"
}
]
}
}
}
}
Response body
Response header
HTTP 200 OK
will be expected to be returned when no updates have occurred
HTTP 201 Created
is expected when one or more creations have occurred
HTTP 204 No content
is expected when one or more updates have occurred
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Retrieve a single secret from a node (GET /config/secrets/node/{node}/{secret})
Token is required.
Request
GET /config/secrets/node/node002/software%20license
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"secrets": {
"node": {
"node002": [
{
"secretname": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
}
]
}
}
}
}
Response header
HTTP 204 No content
will be expected to be returned when the query executed successfully.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Updating a single secret from a node (POST /config/secrets/node/{node}/{secret})
In this example, a node and secret name must be specified.
Request
POST /config/secrets/node/node002/software%20license
Request body
{
"config": {
"secrets": {
"node": {
"node001": [
{
"secretname:": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
}
]
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
A
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not Found
is mandatory if the object is not found
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Cloning a secret from a node (GET /config/secrets/node/{node}/{secret}/_clone)
In this example, a nodeand secret name must be specified.
Token is required.
Request
POST /config/secrets/node/node001/software%20license/_clone
Request body
{
"config": {
"secrets": {
"node": {
"node001": [
{
"secretname": "software license",
"newsecretname": "software license2",
"content": "<ENC>",
"path": "/etc/app/license.lic"
}
]
}
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response header
HTTP 201 Created
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the newsecret field is not set.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting a secret from a node (GET /config/secrets/node/{node}/{secret}/_delete)
In this example, a node and secret name must be specified.
Token is required.
Request
GET /config/secrets/node/node002/software%20license/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
A
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not Found
is mandatory if the object is not found
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting a secret from a node (POST /config/secrets/node/{node}/{secret}/_delete)
Request
POST /config/secrets/node/node002/software%20license/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 400 Bad request
since it is an unsupported request
Retrieve all secrets for a group (GET /config/secrets/group/{group})
Token is required.
Request
GET /config/secrets/group/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"secrets": {
"group": {
"compute": [
{
"secretname": "Proprietary key",
"content": "<ENC>",
"path": "/var/lib/key.pem"
}
]
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Updating all secrets for a group (POST /config/secrets/group/{group})
Request
POST /config/secrets/group/compute
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"secrets": {
"group": {
"compute": [
{
"secretname": "Proprietary key",
"content": "<ENC>",
"path": "/var/lib/key.pem"
}
]
}
}
}
}
Response body
Response header
HTTP 200 OK
will be expected to be returned when no updates have occurred
HTTP 201 Created
is expected when one or more creations have occurred
HTTP 204 No content
is expected when one or more updates have occurred
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Retrieve a single secret from a group (GET /config/secrets/group /{group }/{secret})
Token is required.
Request
GET /config/secrets/group/compute-ib/Infiniband
Request body
{
"secrets": {
"group": {
"compute": null,
"compute-ib": [
{
"secretname": "Infiniband",
"content": "<ENC>",
"path": "/etc/rdma/license.lic"
}
]
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned when the query executed successfully.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Retrieve all secrets for a group (POST /config/secrets/group/{group})
Request
POST /config/secrets/group/compute-ib
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 400 Bad request
since it is an unsupported request
Updating a single secret from a group (POST /config/secrets/group /{group }/{secret})
In this example, a group and secret name must be specified.
Request
POST /config/secrets/group/compute-ib/Infiniband
{
"secrets": {
"group": {
"compute-ib": [
{
"secretname": "Infiniband",
"content": "<ENC>",
"path": "/etc/rdma/license.lic"
}
]
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
A
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not Found
is mandatory if the object is not found
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Cloning a secret from a group (GET /config/secrets/group /{group }/{secret}/_clone)
In this example, a group and secret name must be specified.
Token is required.
Request
POST /config/secrets/group/compute-ib/Infiniband/_clone
Request body
{
"secrets": {
"group": {
"compute-ib": [
{
"secretname": "Infiniband",
"newsecretname": "Infiniband2"
"content": "<ENC>",
"path": "/etc/rdma/license.lic"
}
]
}
}
}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response header
HTTP 201 Created
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the newsecret field is not set.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting a secret from a group (GET /config/secrets/group /{group }/{secret}/_delete)
In this example, a group and secret name must be specified.
Token is required.
Request
GET /config/secrets/group/compute-ib/Infiniband/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
A
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not Found
is mandatory if the object is not found
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting a secret from a group (POST /config/secrets/group /{group }/{secret}/_delete)
Request
POST /config/secrets/group/compute-ib/Infiniband/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 400 Bad request
since it is an unsupported request
Switch management
Switches are used for identifying nodes. Also creating them and assigning them an IP address will create an entry into the CMDB.
Get a list of switches (GET /config/switch):
Request
GET /config/switch
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"switch": {
"switch01": {
"network": "cluster",
"ipaddress": "10.141.253.1",
"oid": ".1.3.6.1.2.1.17.7.1.2.2.1.2",
"read": "public",
"rw": "private",
"comments": "Bootswitch"
},
"switch02": {
"network": "ipmi",
"ipaddress": "10.148.253.1",
"oid": ".1.3.6.1.2.1.17.7.1.2.2.1.2",
"read": "public",
"rw": "private",
"comments": "Bootswitch"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get switch information (GET /config/switch/{switch}):
Request
GET /config/switch/switch01
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"switch": {
"switch01": {
"network": "cluster",
"ipaddress": "10.141.253.1",
"oid": ".1.3.6.1.2.1.17.7.1.2.2.1.2",
"read": "public",
"rw": "private",
"comments": "Bootswitch"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not found
is mandatory if object doesn’t exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Create or update switch information (POST /config/switch/{switch}):
Renaming the switch is done by passing the
newswitchname
field.
Note that a switch with the
network
and
ipaddress
configured will create an entry in the CMDB.
Request
POST /config/switch/switch01
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"switch": {
"switch01": {
"network": "cluster",
"ipaddress": "10.141.253.1",
"oid": ".1.3.6.1.2.1.17.7.1.2.2.1.2",
"read": "public",
"rw": "private",
"comments": "Bootswitch"
}
}
}
}
Response body
Response header
HTTP 201 Created
will be expected to be returned when a switch is created
HTTP 204 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Clone switch (POST /config/switch/{switch}/_clone):
Cloning is done by passing the
newswitchname
field.
Request
POST /config/switch/switch01
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"switch": {
"switch01": {
"network": "cluster",
"newswitchname": "mgmsw01",
"ipaddress": "10.141.253.1",
"oid": ".1.3.6.1.2.1.17.7.1.2.2.1.2",
"read": "public",
"rw": "private",
"comments": "Bootswitch"
}
}
}
}
Response body
Response header
HTTP 201 Created
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not found
is mandatory if object doesn’t exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete switch (GET /config/switch/{switch}/_delete):
Request
GET /config/switch/switch01/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Other devices management
The otherdev section is used to create entries in the CMDB, for non-bootable devices and switches. These objects are usually PDU, UPS or other externally managed devices.
Get a list of otherdev devices (GET /config/otherdev):
Request
GET /config/otherdev
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"otherdev": {
"apc01": {
"network": "cluster",
"ipaddress": "10.141.250.1",
"comments": "APC for rack01a"
},
"ups01": {
"network": "ipmi",
"ipaddress": "10.148.250.1",
"comments": "UPS for the head node"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get otherdev information (GET /config/otherdev/{device}):
Request
GET /config/otherdev/apc01
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"otherdev": {
"apc01": {
"network": "cluster",
"ipaddress": "10.141.250.1",
"comments": "APC for rack01a"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not found
is mandatory if object doesn’t exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Create or update otherdev information (POST/config/otherdev/{device}):
Renaming is done by passing the
newotherdevname
field.
Request
POST /config/otherdev/apc01
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"otherdev": {
"apc01": {
"network": "cluster",
"ipaddress": "10.141.250.1",
"comments": "APC for rack01a"
}
}
}
}
Response body
Response header
HTTP 201 Created
will be expected to be returned when a new device is created
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Clone otherdev information (POST/config/otherdev/{device}/_clone):
Cloning is done by passing the
newotherdevname
field.
Request
POST /config/otherdev/apc01/_clone
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"config": {
"otherdev": {
"apc01": {
"network": "cluster",
"newotherdevname": "apc01b",
"ipaddress": "10.141.250.1",
"comments": "APC for rack01a"
}
}
}
}
Response body
Response header
HTTP 201 Created
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Deleting otherdev device (GET /config/otherdev/{device}/_delete):
Request
GET /config/otherdev/apc01/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
Response header
HTTP 204 No Content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Service management
Reload DNS
Note that Luna2 will automatically schedule a reload once changes have been made to objects which have changed the
network
and/or
ipaddress
field.
Request
GET /service/dns/reload
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 204 No Content
will be returned when the service is in cooldown
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Reload DHCP
Request
GET /service/dhcp/reload
Request body
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 204 No Content
will be returned when the service is in cooldown
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Reload Luna2
This is required when templates on the filesystem have manually changed.
Request
GET /service/luna2/reload
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 204 No Content
will be returned when the service is in cooldown
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Monitoring handles
Monitoring DNS service
Request
GET /monitor/service/dns
Request header
Response body
{
"monitor": {
"service": {
"dns": "OK, running"
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 204 No Content
will be returned when the service is in cooldown
HTTP 500 Internal Server Error
is returned when the service is unavailable.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Monitoring DHCP service
Request
GET /monitor/service/dhcp
Request header
Response body
{
"monitor": {
"service": {
"dns": "OK, reloaded"
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 204 No Content
will be returned when the service is in cooldown
HTTP 500 Internal Server Error
is returned when the service is unavailable.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Monitoring Luna2 service
Request
GET /monitor/service/luna2
Request header
Response body
{
"monitor": {
"service": {
"luna2": "OK"
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 204 No Content
will be returned when the service is in cooldown
HTTP 500 Internal Server Error
is returned when the service is unavailable.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Node monitoring (GET /monitor/status/{node})
Request
GET /monitor/status/node001
Request header
Response body
{
"monitor": {
"status": {
"node001": {
"status": "Luna installer: No errors",
"state": "installer.ok"
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned when the node is OK
HTTP 500 Internal Server Error
is when the node is not OK
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Node monitoring (POST /monitor/status/{node})
Meant to be called from the LUNA installer only. Once the node is only, a monitoring stack will be available.
Request
POST /monitor/status/node001
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"monitor": {
"status": {
"node001": {
"status": "Luna installer: No errors",
"state": "installer.ok"
}
}
}
}
Response body
Response header
HTTP 204 No Content
will be expected when the node contents have been succesfully updated
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not Found
is to be returned when the node does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Control API
The control API is used by the Luna tools such as lpower or any scripts to control nodes.
Currently implemented:
- power control (on, off, reset, identify, noidentify,status)
Control API (GET /control/action/{command}/{hostname}/_{action})
The control GET API supports a single hostname
Request
GET /control/action/power/node001/_on
GET /control/action/power/node001/_off
GET /control/action/power/node001/_status
GET /control/action/sel/node001/_list
GET /control/action/sel/node001/_clear
GET /control/action/chassis/node001/_identify
GET /control/action/chassis/node001/_noidentify
POST /control/action/redfish/node001/_upload -> connect naar BMC address -> uploads json
POST /control/action/redfish/node001/_setting -> connect naar BMC address -> set "uri /redfish/v1/Systems/{system}/BootOptions"
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
Response body
No body is expected for on, off, reset, identify, noidentify
{
control: {
(command){
# This only commands / fire forget
ok: { "command issued" } (returned with sel/identify only) <- catch exit 0 for fire and forget stuff
# status
on: {
node001: None,
node002: None,
},(returned with power)
off: {
node002: None,
} (returned with power)
}
failed: {
node005: None,
node003: "blabla" <- ipmitool stacktrace / command failed / connection lost / time out / command does not exist <- exit not 0
}
}
A body is expected for the status
Only for the status command, return status, e.g. on, off. For all other commands empty return with the corresponding HTTP code
Response header
HTTP 204 No Content
will be expected when the command executed
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not Found
is to be returned when the node does not exist
HTTP 500 Internal Server error
is to be returned when the command failed
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Control API (POST /control/action/power/_on)
{
control: {
power: {
"on":{
hostlist: "node[001-004]"
}
}
}
Control API (POST /control/action/chassis/_identify)
{
control: {
chassis: {
"identify":{
hostlist: "node[001-004]"
}
}
}
Control API (POST /control/action/{command}/_{action})
The control POST API supports multiple hostnames (specified as python hostlists)
Currently implemented:
- power control (on, off, reset, identify, noidentify,status)
After a success, the hostname and action need to be returned. On a partial or failure, the hosts need to be sorted under that action.
Request
POST /control/action/sel/_list
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Request body
{
"control": {
"power": {
"on": {
"hostlist": "node[001-004]"
}
}
}
}
Response body
In this example output, node002 has failed, while node001,003 and 004 are succesful:
{
"control": {
"power": {
"on": {
"hostlist": "node[001,node003-004]"
},
"failed": {
"hostlist": "node[002]"
}
}
}
}
Another example when the status command is issued; the status may differ
{
"control": {
"power": {
"on": {
"hostlist": "node[001,node004]"
},
"off": {
"hostlist": "node[003]"
},
"failed": {
"hostlist": "node[002]"
}
}
}
}
Response header
HTTP 200 OK
will be expected when the control command(s) have been carried out (incl. failed results)
HTTP 401 Unauthorized
is mandatory if there is no valid token
HTTP 404 Not Found
is to be returned when the hostlist is invalid
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Rack View
Get all the racks in detailed view
Request
GET /config/rack
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"rack": {
"rack001": {
"size": 52,
"order": "ascending",
"room": "Basement",
"site": "ClusterVision Amsterdam",
"name": "rack001",
"devices": [
{"name": "controller", "type": "controller", "vendor": "Supermicro", "orientation": "front", "height": 1, "position": 5},
{"name": "node001", "type": "node", "vendor": "Dell", "orientation": "front", "height": 2, "position": 8}
]
},
"rack002": {
"size": 52,
"order": "descending",
"room": "Basement",
"site": "ClusterVision Amsterdam",
"name": "rack002",
"devices": [
{"name": "node002", "type": "node", "vendor": "GigaByte", "orientation": "front", "height": 4, "position": 27}
]
},
"rack006": {
"size": 42,
"order": "descending",
"room": "1st Floor",
"site": "ClusterVision Schiphol",
"name": "rack006",
"devices": []
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get a single rack with detailed view
Request
GET /config/rack/{RACK-NAME}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"rack": {
"rack001": {
"size": 52,
"order": "ascending",
"room": "Basement",
"site": "ClusterVision Amsterdam",
"name": "rack001",
"devices": [
{"name": "node001", "type": "node", "vendor": "HP", "orientation": "front", "height": 1, "position": 5},
{"name": "node002", "type": "node", "vendor": "Lenovo", "orientation": "front", "height": 2, "position": 8}
]
}
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Create a new or update a rack
Request
POST /config/rack/{RACK-NAME}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"rack": {
"rack001": {
"size": 52,
"order": "ascending",
"room": "Basement",
"site": "ClusterVision Amsterdam",
"name": "rack001",
"devices": [
{"name": "node001", "type": "node", "vendor": "HP", "orientation": "front", "height": 1, "position": 5},
{"name": "node002", "type": "node", "vendor": "Lenovo", "orientation": "front", "height": 2, "position": 8}
]
}
}
}
}
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 201 Created
will be expected when a new object is created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get all the inventories in detailed view
Request
GET /config/rack/inventory
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"rack": {
"inventory": [
{"name": "node001", "type": "node", "vendor": "Dell", "height": 1, "orientation": "front"},
{"name": "node002", "type": "node", "vendor": "Dell", "height": 2, "orientation": "front"}
]
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Get all the configured or unconfigured inventories in detailed view
Request
GET /config/rack/inventory/{SUBSET}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"rack": {
"inventory": [
{"name": "node001", "type": "node", "vendor": "Dell", "height": 1, "orientation": "front"},
{"name": "node002", "type": "node", "vendor": "Dell", "height": 2, "orientation": "front"}
]
}
}
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Update a Inventory
Request
POST /config/rack/inventory
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"config": {
"rack": {
"inventory": [
{"name": "node001", "type": "node", "vendor": "Dell", "height": 1, "orientation": "front"},
{"name": "node002", "type": "node", "vendor": "Dell", "height": 2, "orientation": "front"}
]
}
}
}
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 201 Created
will be expected when a new object is created.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete a Rack
Request
GET /config/rack/{RACK-NAME}/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
Response header
HTTP 204 No content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Delete a Inventory [Remove it from the Rack]
Request
GET /config/rack/inventory/{DEVICE_NAME}/type/{DEVICE_TYPE}/_delete
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"message": "Inventory cleared"
}
Response header
HTTP 201 With content
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist.
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Journal
Get all the journal entries for a controller
Request
GET /journal/{controller}
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"journal": [
{"function": "node_update", "object": "node001", "param": None, "payload": "IyBUaGlzIGZpbGUgd2FzIGdlbmVyYXRlZCBieSB3Zy1xdWljayg4KSBmb3IgdXNlIHdpdGgKIyB0", "masteronly": "0", "misc": None, "sendfor": "controller2", "sendby": "controller1", "created": "1713520340"},
{"function": "osimage_pack", "object": "compute", "param": None, "payload": None, "masteronly": "1", "misc": "1703678426.721102268962463531", "sendfor": "controller2", "sendby": "controller1", "created": "1713520344"},
]
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Update journal with entries on controller
Request
POST /journal
Request header
x-access-tokens: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjY4ODQyMTQwfQ"
Response body
{
"journal": [
{"function": "node_update", "object": "node001", "param": None, "payload": "IyBUaGlzIGZpbGUgd2FzIGdlbmVyYXRlZCBieSB3Zy1xdWljayg4KSBmb3IgdXNlIHdpdGgKIyB0", "masteronly": "0", "misc": None, "sendfor": "controller2", "sendby": "controller1", "created": "1713520340"},
{"function": "osimage_pack", "object": "compute", "param": None, "payload": None, "masteronly": "1", "misc": "1703678426.721102268962463531", "sendfor": "controller2", "sendby": "controller1", "created": "1713520344"},
]
}
Response header
HTTP 200 OK
will be expected to be returned.
HTTP 401 Unauthorized
is mandatory if there is no valid token.
HTTP 404 Not found
is mandatory if the object does not exist
HTTP 503 Service unavailable
is returned when the backend is unavailable.
Error handling
Status code |
Description |
Content |
|---|---|---|
|
Indicates the request has succeeded |
Return response required, if just a confirmation, send a 204 |
|
Indicates the request has succeeded and a new resource has been created |
The new id |
|
The server has fulfilled the request but there is no response body |
None |
|
The request could not be understood. |
The faulty fields may be indicated by the server |
|
The request requires user authentication |
None |
|
The client does not have access rights to the content |
None |
|
The server can not find the resource |
The faulty fields may be indicated by the server |
|
The server encountered an unexpected condition. |
Send feedback |
|
The server is not ready to handle the request. |
Send feedback |
Note there are no 300 codes: Either the system is in fault (500), it doesn’t exist (400), but there is no (300) redirection to any other endpoint.
Full spec JSON
JSON
{
"config": {
"node": {
"node001": {
"newhostname": "gpu001",
"group": "compute",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet",
"ipaddress": "10.141.0.1"
},
{
"interface": "BMC",
"network": "ipmi",
"ipaddress": "10.148.0.1"
},
{
"interface": "ib0",
"network": "ib",
"ipaddress": "10.149.0.1"
}
],
"macaddr": "aa:bb:cc:dd:ee:ff",
"switch": "switch01",
"switchport": 1,
"service": false,
"setupbmc": true,
"status": "installer.completed",
"comment": null,
"osimage": "compute",
"prescript": "#!/bin/bash \n exit 0;",
"partscript": "#!/bin/bash \n exit 0;",
"postscript": "#!/bin/bash \n exit 0;",
"netboot": true,
"bootmenu": false,
"localinstall": false,
"provision_interface": null,
"provision_method": null,
"provision_fallback": null,
"tpm_uuid": null,
"tpm_pubkey": null,
"tpm_sha256": null
}
},
"group": {
"compute": {
"newgroupname": "compute-gpu",
"bmcsetup": true,
"domain": "cluster",
"interfaces": [
{
"interface": "BOOTIF",
"network": "clusternet"
},
{
"interface": "BMC",
"network": "ipmi"
},
{
"interface": "ib0",
"network": "ib"
}
],
"osimage": "compute",
"partscript": "#!/bin/bash \n exit 0",
"postscript": "#!/bin/bash \n exit 0",
"prescript": "#!/bin/bash \n exit 0",
"provision_interface": null,
"netboot": true,
"localinstall": false,
"bootmenu": false,
"comment": "Default group",
"provision_method": "torrent",
"provision_fallback": "http"
"members": [
"node001",
"node002",
"node003",
"node004"
]
}
},
"cluster": {
"controller1": {
"status": "primary",
"ipaddr": "10.141.255.254",
"serverport": 7050,
"luna_config": "/trinity/local/luna/config/luna-daemon.ini"
},
"controller2": {
"status": "standby",
"ipaddr": "10.141.255.253",
"serverport": 7050,
"luna_config": "/trinity/local/luna/config/luna-daemon.ini"
},
"ntp_server": "10.141.255.252",
"debug": false,
"technical_contacts": "root@localhost",
"provision_method": "torrent",
"provision_fallback": "http"
},
"network": {
"cluster": {
"newnetname": "cluster2",
"network": "10.141.0.0/16",
"ns_hostname": "controller.cluster",
"ns_ip": "10.141.255.254",
"ntp_server": "10.141.255.254",
"gateway": "10.141.255.254",
"comment": "Default cluster network",
"dhcp_enable": true,
"dhcp_begin": "10.141.0.200",
"dhcp_end": "10.141.0.253"
},
"ipmi": {
"newnetname": "ipmi2",
"network": "10.148.0.0/16",
"ns_hostname": "controller.ipmi",
"ns_ip": "10.148.255.254",
"ntp_server": "10.148.255.254",
"gateway": "10.148.255.254",
"comment": "Default OOB network",
"dhcp_enable": false
},
"ib": {
"newnetname": "ib2",
"network": "10.149.0.0/16",
"ns_hostname": "controller.ib",
"ns_ip": "10.149.255.254",
"ntp_server": "10.149.255.254",
"gateway": "10.149.255.254",
"comment": "Default highspeed interconnect network",
"dhcp_enable": false
}
},
"bmcsetup": {
"dell": {
"newbmcname": "newname",
"mgmtchannel": 1,
"netchannel": 1,
"password": "calvin",
"username": "root",
"userid": 2,
"comment": "Default DELL",
"unmanaged_bmc_users": "skip",
"members": [
"node003",
"node004"
]
},
"gigabyte": {
"newbmcname": "newname2",
"mgmtchannel": 1,
"netchannel": 1,
"password": "password",
"username": "admin",
"userid": 2,
"comment": "Default Gigabyte",
"unmanaged_bmc_users": "disable",
"members": [
"node001",
"node002"
]
}
},
"switch": {
"switch01": {
"network": "cluster",
"newswitchname": "mgmsw01",
"ipaddress": "10.141.253.1",
"oid": ".1.3.6.1.2.1.17.7.1.2.2.1.2",
"readcommunity": "public",
"rwcommunity": "private",
"comment": "Bootswitch"
},
"switch02": {
"network": "ipmi",
"newswitchname": "mgmsw02",
"ipaddress": "10.148.253.1",
"oid": ".1.3.6.1.2.1.17.7.1.2.2.1.2",
"readcommunity": "public",
"rwcommunity": "private",
"comment": "Bootswitch"
}
},
"otherdev": {
"apc01": {
"network": "cluster",
"newotherdevname": "apc01a",
"ipaddress": "10.141.250.1",
"comment": "APC for rack01a"
},
"ups01": {
"network": "ipmi",
"newotherdevname": "ups-01",
"ipaddress": "10.148.250.1",
"comment": "UPS for the head node"
}
},
"osimage": {
"compute": {
"dracutmodules": "luna, -18n, -plymouth",
"grab_exclude_list": [
"/dev",
"/proc",
"/sys"
],
"grab_filesystems": [
"/",
"/boot"
],
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"kernmodules": "ipmi_devinft, ipmi_si, ipmi_msghandler",
"kernopts": "mitigations=off nosmt noht",
"kernver": "`uname -r`",
"path": "/trinity/images/compute",
"tarball": "uuid",
"torrent": "uuid",
"comment": "Default image"
"members": [
"node003",
"node004"
]
},
"compute-ib": {
"dracutmodules": "luna, -18n, -plymouth",
"grab_exclude_list": [
"/dev",
"/proc",
"/sys"
],
"grab_filesystems": [
"/",
"/boot"
],
"initrdfile": "compute-initramfs-`uname -r`",
"kernelfile": "compute-kernel-`uname -r`",
"kernmodules": "ipmi_devinft, ipmi_si, ipmi_msghandler",
"kernopts": "mitigations=off nosmt noht",
"kernver": "`uname -r`",
"path": "/trinity/images/compute-ib",
"tarball": "uuid",
"torrent": "uuid",
"comment": "Default image with updated drivers"
"members": [
"node001",
"node002"
]
}
},
"secrets": {
"node": {
"node001": [
{
"secretname": "shared secret",
"content": "<ENC>",
"path": "/etc/keys.crt"
},
{
"secretname": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
},
{
"secretname": "shared secret",
"content": "<ENC>",
"path": "/etc/keys.crt"
}
],
"node002": [
{
"name": "software license",
"content": "<ENC>",
"path": "/etc/app/license.lic"
}
]
},
"group": {
"compute": [
{
"secretname": "Proprietary key",
"content": "<ENC>",
"path": "/var/lib/key.pem"
}
],
"compute-ib": [
{
"secretname": "Infiniband",
"content": "<ENC>",
"path": "/etc/rdma/license.lic"
}
]
}
}
},
"version": {
"luna": "2.0-001",
"api": 1,
"commit": "hex(commit)"
},
"monitor": {
"service": {
"dns": "OK, running",
"dhcp": "OK, reloaded",
"luna2": "OK"
},
"status": {
"node001": {
"status": "Luna installer: No errors",
"state": "installer.ok"
},
"node002": {
"status": "Luna installer: No errors",
"state": "installer.ok"
},
"beegfs01": {
"status": "Luna installer: No errors",
"state": "installer.ok"
},
"login01": {
"status": "Luna installer: Error in partscript",
"state": "installer.error"
}
}
},
"control": {
"power": {
"on": {
"hostlist": "node[001,node003-004]"
},
"fail": {
"hostlist": "node[002]"
}
}
}
}
YAML
---
config:
node:
node001:
newhostname: gpu001
group: compute
interfaces:
- interface: BOOTIF
network: clusternet
ipaddress: 10.141.0.1
- interface: BMC
network: ipmi
ipaddress: 10.148.0.1
- interface: ib0
network: ib
ipaddress: 10.149.0.1
macaddr: aa:bb:cc:dd:ee:ff
switch: switch01
switchport: 1
service: False
setupbmc: True
status: installer.completed
comment:
osimage: compute
prescript: "#!/bin/bash \n exit 0;"
partscript: "#!/bin/bash \n exit 0;"
postscript: "#!/bin/bash \n exit 0;"
netboot: True
bootmenu: False
localinstall: False
provision_interface:
provision_method:
provision_fallback:
tpm_uuid:
tpm_pubkey:
tpm_sha256:
group:
compute:
newgroupname: compute-gpu
bmcsetup: True
domain: cluster
interfaces:
- interface: BOOTIF
network: clusternet
- interface: BMC
network: ipmi
- interface: ib0
network: ib
osimage: compute
partscript: "#!/bin/bash \n exit 0"
postscript: "#!/bin/bash \n exit 0"
prescript: "#!/bin/bash \n exit 0"
provision_interface:
netboot: True
localinstall: False
bootmenu: False
comment: "Default group"
provision_method: torrent
provision_fallback: http
members:
- node001
- node002
- node003
- node004
cluster:
controller1:
status: primary
ipaddr: 10.141.255.254
serverport: 7050
luna_config: /trinity/local/luna/config/luna-daemon.ini
controller2:
status: standby
ipaddr: 10.141.255.253
serverport: 7050
luna_config: /trinity/local/luna/config/luna-daemon.ini
ntp_server: 10.141.255.252
debug: False
technical_contacts: root@localhost
provision_method: torrent
provision_fallback: http
network:
cluster:
newnetname: cluster2
network: 10.141.0.0/16
ns_hostname: controller.cluster
ns_ip: 10.141.255.254
ntp_server: 10.141.255.254
gateway: 10.141.255.254
comment: "Default cluster network"
dhcp_enable: True
dhcp_begin: 10.141.0.200
dhcp_end: 10.141.0.253
ipmi:
newnetname: ipmi2
network: 10.148.0.0/16
ns_hostname: controller.ipmi
ns_ip: 10.148.255.254
ntp_server: 10.148.255.254
gateway: 10.148.255.254
comment: "Default OOB network"
dhcp_enable: False
ib:
newnetname: ib2
network: 10.149.0.0/16
ns_hostname: controller.ib
ns_ip: 10.149.255.254
ntp_server: 10.149.255.254
gateway: 10.149.255.254
comment: "Default highspeed interconnect network"
dhcp_enable: False
bmcsetup:
dell:
newbmcname: newname
mgmtchannel: 1
netchannel: 1
password: calvin
username: root
userid: 2
comment: "Default DELL"
unmanaged_bmc_users: "skip"
members:
- node003
- node004
gigabyte:
newbmcname: newname2
mgmtchannel: 1
netchannel: 1
password: password
username: admin
userid: 2
comment: "Default Gigabyte"
unmanaged_bmc_users: "disable"
members:
- node001
- node002
switch:
switch01:
network: cluster
newswitchname: mgmsw01
ipaddress: 10.141.253.1
oid: ".1.3.6.1.2.1.17.7.1.2.2.1.2"
readcommunity: public
rwcommunity: private
comment: Bootswitch
switch02:
network: ipmi
newswitchname: mgmsw02
ipaddress: 10.148.253.1
oid: ".1.3.6.1.2.1.17.7.1.2.2.1.2"
readcommunity: public
rwcommunity: private
comment: Bootswitch
otherdev:
apc01:
network: cluster
newotherdevname: apc01a
ipaddress: 10.141.250.1
comment: APC for rack01a
ups01:
network: ipmi
newotherdevname: ups-01
ipaddress: 10.148.250.1
comment: UPS for the head node
osimage:
compute:
dracutmodules: "luna, -18n, -plymouth"
grab_exclude_list:
- /dev
- /proc
- /sys
grab_filesystems:
- /
- /boot
initrdfile: "compute-initramfs-`uname -r`"
kernelfile: "compute-kernel-`uname -r`"
kernmodules: "ipmi_devinft, ipmi_si, ipmi_msghandler"
kernopts: "mitigations=off nosmt noht"
kernver: "`uname -r`"
path: /trinity/images/compute
tarball: uuid
torrent: uuid
comment: "Default image"
members:
- node003
- node004
compute-ib:
dracutmodules: "luna, -18n, -plymouth"
grab_exclude_list:
- /dev
- /proc
- /sys
grab_filesystems:
- /
- /boot
initrdfile: "compute-initramfs-`uname -r`"
kernelfile: "compute-kernel-`uname -r`"
kernmodules: "ipmi_devinft, ipmi_si, ipmi_msghandler"
kernopts: "mitigations=off nosmt noht"
kernver: "`uname -r`"
path: /trinity/images/compute-ib
tarball: uuid
torrent: uuid
comment: "Default image with updated drivers"
members:
- node001
- node002
secrets:
node:
node001:
- secretname: shared secret
content: <ENC>
path: /etc/keys.crt
- secretname: software license
content: <ENC>
path: /etc/app/license.lic
- secretname: shared secret
content: <ENC>
path: /etc/keys.crt
node002:
- name: software license
content: <ENC>
path: /etc/app/license.lic
group:
compute:
- secretname: Proprietary key
content: <ENC>
path: /var/lib/key.pem
compute-ib:
- secretname: Infiniband
content: <ENC>
path: /etc/rdma/license.lic
version:
luna: 2.0-001
api: 1.0
commit: hex(commit)
monitor:
service:
dns: "OK, running"
dhcp: "OK, reloaded"
luna2: "OK"
status:
node001:
status: "Luna installer: No errors"
state: "installer.ok"
node002:
status: "Luna installer: No errors"
state: "installer.ok"
beegfs01:
status: "Luna installer: No errors"
state: "installer.ok"
login01:
status: "Luna installer: Error in partscript"
state: "installer.error"
control:
power:
on:
hostlist: node[001,node003-004]
fail:
hostlist: node[002]