Powered by Redocly

Hardware Resource Profiles

Hardware resources used to restrict resource allocation on hosts.

Create a new resource profile

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
object

Memory allocation limits and default values for hosts. Used by top site provider to control memory resources.

object

CPU allocation limits and default values for hosts. Used by a top site provider to control CPU resources.

object

Memory allocation limits and default values for hosts. Used by top site provider to control memory resources.

Array of objects

Allowed device labels.

Array of objects

Allowed GPU labels.

Array of objects

Allowed system volumes.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict (instance exists)

503

Service Unavailable (strongbox sealed)

post/v1/config/system/resource-profiles
Request samples 
name: large
memory:
  memory-limit: 8GiB
  container-memory-default: 4GiB
cpus:
  cpus-limit: 4.0
  container-cpus-default: 2.0
  cpu-shares-limit: 2048
  container-cpu-shares-default: 2048
container-storage:
  container-layer-storage-limit: 500MiB
  container-layer-size-default: 100MiB
device-labels:
  - name: rtc
  - name: tty
gpu-labels:
  - name: nvidia
system-volumes:
  - name: systemd-socket

Retrieve the configuration of all resource profiles

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/system/resource-profiles
Response samples 
- name: large
  memory:
    memory-limit: 8GiB
    container-memory-default: 4GiB
  cpus:
    cpus-limit: 4.0
    container-cpus-default: 2.0
    cpu-shares-limit: 2048
    container-cpu-shares-default: 2048
  container-storage:
    container-layer-storage-limit: 500MiB
    container-layer-size-default: 100MiB
  device-labels:
    - name: rtc
    - name: tty
  gpu-labels:
    - name: nvidia
  system-volumes:
    - name: systemd-socket

Update a resource profile

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
path Parameters
resource-profile-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of resource-profile

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
object

Memory allocation limits and default values for hosts. Used by top site provider to control memory resources.

object

CPU allocation limits and default values for hosts. Used by a top site provider to control CPU resources.

object

Memory allocation limits and default values for hosts. Used by top site provider to control memory resources.

Array of objects

Allowed device labels.

Array of objects

Allowed GPU labels.

Array of objects

Allowed system volumes.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/system/resource-profiles/{resource-profile-name}
Request samples 
name: large
memory:
  memory-limit: 8GiB
  container-memory-default: 4GiB
cpus:
  cpus-limit: 4.0
  container-cpus-default: 2.0
  cpu-shares-limit: 2048
  container-cpu-shares-default: 2048
container-storage:
  container-layer-storage-limit: 500MiB
  container-layer-size-default: 100MiB
device-labels:
  - name: rtc
  - name: tty
gpu-labels:
  - name: nvidia
system-volumes:
  - name: systemd-socket

Delete a resource profile

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
path Parameters
resource-profile-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of resource-profile

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/system/resource-profiles/{resource-profile-name}

Replace or create a new resource profile

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
path Parameters
resource-profile-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of resource-profile

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
object

Memory allocation limits and default values for hosts. Used by top site provider to control memory resources.

object

CPU allocation limits and default values for hosts. Used by a top site provider to control CPU resources.

object

Memory allocation limits and default values for hosts. Used by top site provider to control memory resources.

Array of objects

Allowed device labels.

Array of objects

Allowed GPU labels.

Array of objects

Allowed system volumes.

Responses
201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/system/resource-profiles/{resource-profile-name}
Request samples 
name: large
memory:
  memory-limit: 8GiB
  container-memory-default: 4GiB
cpus:
  cpus-limit: 4.0
  container-cpus-default: 2.0
  cpu-shares-limit: 2048
  container-cpu-shares-default: 2048
container-storage:
  container-layer-storage-limit: 500MiB
  container-layer-size-default: 100MiB
device-labels:
  - name: rtc
  - name: tty
gpu-labels:
  - name: nvidia
system-volumes:
  - name: systemd-socket

Retrieve the configuration of a resource profile

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
path Parameters
resource-profile-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of resource-profile

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/system/resource-profiles/{resource-profile-name}
Response samples 
name: large
memory:
  memory-limit: 8GiB
  container-memory-default: 4GiB
cpus:
  cpus-limit: 4.0
  container-cpus-default: 2.0
  cpu-shares-limit: 2048
  container-cpu-shares-default: 2048
container-storage:
  container-layer-storage-limit: 500MiB
  container-layer-size-default: 100MiB
device-labels:
  - name: rtc
  - name: tty
gpu-labels:
  - name: nvidia
system-volumes:
  - name: systemd-socket

Retrieve the state of all resource profiles

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/resource-profiles
Response samples 
- name: large
  memory:
    memory-limit: 8GiB
    container-memory-default: 4GiB
  cpus:
    cpus-limit: 4.0
    container-cpus-default: 2.0
    cpu-shares-limit: 2048
    container-cpu-shares-default: 2048
  container-storage:
    container-layer-storage-limit: 500MiB
    container-layer-size-default: 100MiB
  device-labels:
    - name: rtc
    - name: tty
  gpu-labels:
    - name: nvidia
  system-volumes:
    - name: systemd-socket

Retrieve the state of a resource profile

Hardware resource profiles used to restrict resource allocation on hosts.

SecurityaccessToken
Request
path Parameters
resource-profile-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of resource-profile

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/resource-profiles/{resource-profile-name}
Response samples 
name: large
memory:
  memory-limit: 8GiB
  container-memory-default: 4GiB
cpus:
  cpus-limit: 4.0
  container-cpus-default: 2.0
  cpu-shares-limit: 2048
  container-cpu-shares-default: 2048
container-storage:
  container-layer-storage-limit: 500MiB
  container-layer-size-default: 100MiB
device-labels:
  - name: rtc
  - name: tty
gpu-labels:
  - name: nvidia
system-volumes:
  - name: systemd-socket
➔ Next to Ingress Allocation