Installation
What can be done to the installation as a whole, such as a roll-out.
| Operation | Kind | HTTP |
|---|---|---|
installation.actions | call | GET /v1/installation/actions |
installation.act | call | POST /v1/installation/actions/{action} |
installation.actions
What can be done to the installation as a whole, such as a roll-out over its hosts.
Needs the role view.
Result
Action[]
{
"id": 1,
"op": "installation.actions"
}{
"id": 1,
"result": [
{
"name": "status"
}
]
}installation.act
Run one of the installation's actions, as a job.
Needs the role view.
Arguments
| Name | Where | Required | Description |
|---|---|---|---|
action | path | yes | The action, as installation.actions names it |
Input
Its arguments, and a token that makes asking again safe
Act | null
Errors
| Status | When |
|---|---|
| 400 | An argument is wrong, or the body is not one |
| 403 | The caller's role is below the action's |
| 404 | No such action, or a host it names |
| 409 | Another one is running |
{
"id": 1,
"op": "installation.act",
"args": {
"action": "VALUE"
},
"data": {
"arguments": {},
"cols": 120,
"input_b64": "aGVsbG8K",
"rows": 40,
"sudo_password": "text",
"token": "text"
}
}{
"id": 1,
"result": null
}Types
The named types used on this page.
Action
Something that can be done to a subject: a host, the installation, and later a provisioner or a resource. It says enough to build a form from.
| Field | Type | Description |
|---|---|---|
arguments (optional) | Argument[] | |
available (optional) | boolean | False, with why, when the subject's state rules it out now. |
changes (optional) | boolean | False when it only reads, and may be called at any time. |
collection (optional) | string | The id of the provisioner's collection it belongs to, whose items it makes, acts on or lists. The screens offer it there and not on the provisioner's page. |
confirm (optional) | string | null | The question to answer yes to before it runs. |
group (optional) | string | The group of the page it is listed in; Host when empty. |
help (optional) | string | |
label (optional) | string | |
name | string | |
role (optional) | Role | The least role that may run it. |
runs (optional) | Runs | Where an action runs. |
steps (optional) | ActionStep[] | What plugins add to it, in the order they run. |
terminal (optional) | boolean | It needs a terminal session attached; only a host runs these. |
why (optional) | string |
Act
What running an action is given.
| Field | Type | Description |
|---|---|---|
arguments (optional) | map of string | |
cols (optional) | integer | null | |
input_b64 (optional) | string | null | Bytes for the standard input of an action that takes them, in base64: the build context of a rookery for upgrade-server source=here. They go over HTTP when they are more than the portal carries. |
rows (optional) | integer | null | The size of the terminal, for an action that runs in one. |
sudo_password (optional) | string | null | The SSH user's sudo password, for an action that logs in to a host whose sudo asks for one. It is neither shown nor kept. |
token (optional) | string | null | Any text of the caller's. The same token again for the same subject and action answers with the job the first call started. |
Argument
| Field | Type | Description |
|---|---|---|
choices (optional) | string | A command whose lines are the values to offer. |
confirm (optional) | string | For a yes or no: the question to answer yes to before the action runs with it on, instead of the action's own. |
default (optional) | string | |
fixed (optional) | string | Why it keeps its default here and cannot be given another value, such as destroying a machine no provisioner made. The screens show it greyed and say this instead of changing it. Empty when it can be changed. |
help (optional) | string | What it is for, in a sentence or two, beside its short label. |
kind (optional) | string | resource for an argument of a provisioner that sizes the machine: its CPUs, memory or disk. text for one whose value has several lines. boolean for a yes or no, which the screens show as a switch. Empty for any other argument. |
label (optional) | string | |
name | string | |
required (optional) | boolean | |
secret (optional) | boolean | What is given is a secret, such as a password: it is not shown as it is typed, nor kept, nor written to a job's output. |
values (optional) | string[] | The values a provisioner's argument takes, when it is a choice of a few. Empty for one that takes any text. |
Role
What a caller has to be allowed for an operation. Each role includes the ones before it.
What a caller has to be allowed for an operation. Each role includes the ones before it.
Runs
Where an action runs.
Where an action runs.
ActionStep
What a plugin adds to an action: a step run after it in the same run.
| Field | Type | Description |
|---|---|---|
help (optional) | string | |
label | string |