parallelvirtualcluster/docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: parallelvirtualcluster:3b11a74597e22c27e78cc625307e4c975e13a9cb
Branches Tags
parallelvirtualcluster:master
...
compare: parallelvirtualcluster:b9f3bcbb00ea788fef8cd477a89c1f1075757c36
Branches Tags
parallelvirtualcluster:master

3 Commits
3b11a74597 ... b9f3bcbb00

Author SHA1 Message Date
Joshua M. Boniface
b9f3bcbb00 Update Software diagram for 0.9.86+ 2024-01-11 10:37:40 -05:00
Joshua M. Boniface
b1e06dbf54 Add migration max downtime metafield for VMs 2024-01-10 16:30:52 -05:00
Joshua M. Boniface
1eeb3bd778 Add Zookeeper metric endpoint and update descrs 2024-01-10 16:30:32 -05:00
2 changed files with 77 additions and 4 deletions
Expand all files Collapse all files

BIN
docs/architecture/images/pvc-software.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 87 KiB

After

Width:  |  Height:  |  Size: 57 KiB

81
docs/manuals/swagger.json
View File

@ -214,6 +214,10 @@
},
"VMMetadata": {
"properties": {
"migration_max_downtime": {
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"type": "integer"
},
"migration_method": {
"description": "The preferred migration method (live, shutdown, none)",
"type": "string"
@ -1209,6 +1213,10 @@
"description": "Internal provisioner template ID",
"type": "integer"
},
"migration_max_downtime": {
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"type": "integer"
},
"migration_method": {
"description": "The preferred migration method (live, shutdown, none)",
"type": "string"
@ -1417,6 +1425,10 @@
"description": "Whether the VM has been migrated, either \"no\" or \"from <last_node>\"",
"type": "string"
},
"migration_max_downtime": {
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"type": "integer"
},
"migration_method": {
"description": "The preferred migration method (live, shutdown, none)",
"type": "string"
@ -1992,7 +2004,7 @@
},
"/api/v1/metrics": {
"get": {
"description": "the Ceph cluster metrics as one document.<br/><br/>Endpoint is unauthenticated to allow metrics exfiltration without having to deal<br/>with the Prometheus compatibility later.",
"description": "the Ceph cluster metrics as one document.<br/><br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
"responses": {
"200": {
"description": "OK"
@ -2009,7 +2021,7 @@
},
"/api/v1/metrics/ceph": {
"get": {
"description": "<br/>Proxies a metrics request to the current active MGR, since this is dynamic<br/>and can't be controlled by PVC easily.",
"description": "<br/>Proxies a metrics request to the current active MGR, since this is dynamic<br/>and can't be controlled by PVC easily.<br/><br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
"responses": {
"200": {
"description": "OK"
@ -2026,7 +2038,7 @@
},
"/api/v1/metrics/health": {
"get": {
"description": "<br/>Endpoint is unauthenticated to allow metrics exfiltration without having to deal<br/>with the Prometheus compatibility later.",
"description": "<br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
"responses": {
"200": {
"description": "OK"
@ -2043,7 +2055,7 @@
},
"/api/v1/metrics/resource": {
"get": {
"description": "<br/>Endpoint is unauthenticated to allow metrics exfiltration without having to deal<br/>with the Prometheus compatibility later.",
"description": "<br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
"responses": {
"200": {
"description": "OK"
@ -2058,6 +2070,23 @@
]
}
},
"/api/v1/metrics/zookeeper": {
"get": {
"description": "<br/>Proxies a metrics request to the current primary node, since all coordinators<br/>run an active Zookeeper instance and we want one central location.<br/><br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request"
}
},
"summary": "Return the current PVC Zookeeper Prometheus metrics",
"tags": [
"root"
]
}
},
"/api/v1/network": {
"get": {
"description": "",
@ -4505,6 +4534,13 @@
"name": "migration_method",
"required": false,
"type": "string"
},
{
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"in": "query",
"name": "migration_max_downtime",
"required": false,
"type": "integer"
}
],
"responses": {
@ -4635,6 +4671,13 @@
"name": "migration_method",
"required": false,
"type": "string"
},
{
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"in": "query",
"name": "migration_max_downtime",
"required": false,
"type": "integer"
}
],
"responses": {
@ -4712,6 +4755,12 @@
"in": "query",
"name": "migration_method",
"type": "string"
},
{
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"in": "query",
"name": "migration_max_downtime",
"type": "integer"
}
],
"responses": {
@ -6580,6 +6629,14 @@
"required": false,
"type": "string"
},
{
"default": 300,
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"in": "query",
"name": "migration_max_downtime",
"required": false,
"type": "integer"
},
{
"description": "The user tag(s) of the VM",
"in": "query",
@ -6739,6 +6796,14 @@
"required": false,
"type": "string"
},
{
"default": 300,
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"in": "query",
"name": "migration_max_downtime",
"required": false,
"type": "integer"
},
{
"description": "The user tag(s) of the VM",
"in": "query",
@ -7097,6 +7162,14 @@
"name": "migration_method",
"required": false,
"type": "string"
},
{
"default": "none",
"description": "The maximum time in milliseconds that a VM can be down for during a live migration; busy VMs may require a larger max_downtime",
"in": "query",
"name": "migration_max_downtime",
"required": false,
"type": "integer"
}
],
"responses": {