System Resource Profiles

System resources used to restrict resource allocation on hosts.

Create a new resource profile

System 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:
application/yaml

name required	string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
	object Memory allocation limits for hosts. Used by site providers to control memory resources.
	object CPU allocation limits for hosts. Used by site providers to control CPU resources.
	object Container storage allocation limits for hosts. Used by site providers to control container storage.
	Array of objects
	Array of all (object) or gpu-patterns (object)
	Array of objects

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

Payload

name: large
memory:
  memory-limit: 8GiB
cpus:
  cpus-limit: 4.0
container-storage:
  container-layer-storage-limit: 500MiB
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-display
    max-number-gpus: 1
    gpu-patterns:
      - display-mode == "Enabled"
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
    mode: read-only

Retrieve the configuration of all resource profiles

System 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
where	string Retrieve only items matching the given expression. See section where
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

200

- name: large
  memory:
    memory-limit: 8GiB
  cpus:
    cpus-limit: 4.0
  container-storage:
    container-layer-storage-limit: 500MiB
  device-labels:
    - label: video-dev
      udev-patterns:
        - SUBSYSTEM=="video4linux", BUS=="usb"
  gpu-labels:
    - label: gpu-display
      max-number-gpus: 1
      gpu-patterns:
        - display-mode == "Enabled"
  system-volumes:
    - name: daemon-socket
      path: /var/run/my-daemon.sock
      mode: read-only

Update a resource profile

System 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:
application/yaml

name required	string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
	object Memory allocation limits for hosts. Used by site providers to control memory resources.
	object CPU allocation limits for hosts. Used by site providers to control CPU resources.
	object Container storage allocation limits for hosts. Used by site providers to control container storage.
	Array of objects
	Array of all (object) or gpu-patterns (object)
	Array of objects

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

Payload

name: large
memory:
  memory-limit: 8GiB
cpus:
  cpus-limit: 4.0
container-storage:
  container-layer-storage-limit: 500MiB
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-display
    max-number-gpus: 1
    gpu-patterns:
      - display-mode == "Enabled"
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
    mode: read-only

Delete a resource profile

System 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

System 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:
application/yaml

name required	string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
	object Memory allocation limits for hosts. Used by site providers to control memory resources.
	object CPU allocation limits for hosts. Used by site providers to control CPU resources.
	object Container storage allocation limits for hosts. Used by site providers to control container storage.
	Array of objects
	Array of all (object) or gpu-patterns (object)
	Array of objects

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

Payload

name: large
memory:
  memory-limit: 8GiB
cpus:
  cpus-limit: 4.0
container-storage:
  container-layer-storage-limit: 500MiB
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-display
    max-number-gpus: 1
    gpu-patterns:
      - display-mode == "Enabled"
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
    mode: read-only

Retrieve the configuration of a resource profile

System 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
where	string Retrieve only items matching the given expression. See section where
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

200

name: large
memory:
  memory-limit: 8GiB
cpus:
  cpus-limit: 4.0
container-storage:
  container-layer-storage-limit: 500MiB
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-display
    max-number-gpus: 1
    gpu-patterns:
      - display-mode == "Enabled"
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
    mode: read-only

Retrieve the state of all resource profiles

System 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
where	string Retrieve only items matching the given expression. See section where
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

200

- name: large
  memory:
    memory-limit: 8GiB
  cpus:
    cpus-limit: 4.0
  container-storage:
    container-layer-storage-limit: 500MiB
  device-labels:
    - label: video-dev
      udev-patterns:
        - SUBSYSTEM=="video4linux", BUS=="usb"
  gpu-labels:
    - label: gpu-display
      max-number-gpus: 1
      gpu-patterns:
        - display-mode == "Enabled"
  system-volumes:
    - name: daemon-socket
      path: /var/run/my-daemon.sock
      mode: read-only

Retrieve the state of a resource profile

System 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
where	string Retrieve only items matching the given expression. See section where
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

200

name: large
memory:
  memory-limit: 8GiB
cpus:
  cpus-limit: 4.0
container-storage:
  container-layer-storage-limit: 500MiB
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-display
    max-number-gpus: 1
    gpu-patterns:
      - display-mode == "Enabled"
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
    mode: read-only

System Resource Profiles

Create a new resource profile

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Retrieve the configuration of all resource profiles

query Parameters

Update a resource profile

path Parameters

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Delete a resource profile

path Parameters

query Parameters

Replace or create a new resource profile

path Parameters

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Retrieve the configuration of a resource profile

path Parameters

query Parameters

Retrieve the state of all resource profiles

query Parameters

Retrieve the state of a resource profile

path Parameters

query Parameters

Request Body schema:
application/yaml

Request Body schema:
application/yaml

Request Body schema:
application/yaml