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

Add Zookeeper metric endpoint and update descrs

This commit is contained in:
Joshua Boniface 2024-01-10 16:26:00 -05:00
parent 3b11a74597
commit 1eeb3bd778
1 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/manuals/swagger.json
View File

@ -1992,7 +1992,7 @@
}, },
"/api/v1/metrics": { "/api/v1/metrics": {
"get": { "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": { "responses": {
"200": { "200": {
"description": "OK" "description": "OK"
@ -2009,7 +2009,7 @@
}, },
"/api/v1/metrics/ceph": { "/api/v1/metrics/ceph": {
"get": { "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": { "responses": {
"200": { "200": {
"description": "OK" "description": "OK"
@ -2026,7 +2026,7 @@
}, },
"/api/v1/metrics/health": { "/api/v1/metrics/health": {
"get": { "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": { "responses": {
"200": { "200": {
"description": "OK" "description": "OK"
@ -2043,7 +2043,7 @@
}, },
"/api/v1/metrics/resource": { "/api/v1/metrics/resource": {
"get": { "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": { "responses": {
"200": { "200": {
"description": "OK" "description": "OK"
@ -2058,6 +2058,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": { "/api/v1/network": {
"get": { "get": {
"description": "", "description": "",