Skip to content
StratumStratum Docs

The disks installs reserved for a day-2 Ceph bootstrap — bootstrap-admin.

GET
/v1/admin/storage/ceph/osd-candidates
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/admin/storage/ceph/osd-candidates \
  --header 'Authorization: Bearer <token>'

The disks an install wiped and set aside for Ceph (the installer’s “use for Ceph”, node.yaml storage.ceph_osd_disks), one entry per node. Nothing Ceph runs at install: each node records its own disks, by /dev/disk/by-id path, and its control plane reports them in its disk inventory (reservation on GET /v1/compute/nodes/{nodeId}/disks). This gathers those reports. It reads no Ceph cluster, so it answers before one exists.

Each entry’s host and devices are an osdPaths entry of POST /v1/admin/storage/ceph/bootstrap as they stand: the console’s bootstrap form pre-selects them. devices holds the reserved disks that are still blank; one written to since the install, or already an OSD, is listed under disks with ready: false and left out of devices. A bootstrap that names neither osdPaths nor osdDevices uses these same disks (the hardware plan’s ceph-osd marks,): osdSelection on GET…/ceph/cluster shows what it applies.

Install-scope; gates on storage:ListCephDevices, like the Ceph device inventory it complements.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The reserved disks, per node.

Media typeapplication/json

The disks installs reserved for Ceph, one entry per node.

object
items
required
Array<object>

One node’s reserved disks. host and devices drop into CephBootstrapRequest.osdPaths as they are.

object
nodeId
required

The Stratum node id.

string
host
required

The node’s reported hostname: the name cephadm keys the host on, and what osdPaths[].host takes. Empty until the node has reported one.

string
devices
required

The /dev/disk/by-id paths of the reserved disks that are still blank, ready to become OSDs: osdPaths[].devices.

Array<string>
disks
required

Every disk the install reserved on this node, ready or not.

Array<object>

One disk an install reserved for Ceph, as its node last reported it.

object
byId
required

The stable /dev/disk/by-id path the install recorded.

string
path
required

The device it points at now, e.g. /dev/nvme1n1.

string
sizeBytes
required
integer format: int64
rotational
required
boolean
model
string
serial
string
usage
required

The disk’s usage, as in the node disk inventory.

string
Allowed values: available partitioned filesystem lvm-member ceph mounted
ready
required

True when the disk is still blank (usage: available), so a bootstrap can make it an OSD. ceph means it already is one.

boolean
recordedAt
required

When the install recorded it.

string format: date-time

Example 

{
  "items": [
    {
      "disks": [
        {
          "usage": "available"
        }
      ]
    }
  ]
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}