Skip to content

Commit

Permalink
docs: document storage metrics API endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
Greg Bruno committed Jun 24, 2024
1 parent 349e5d7 commit f9f83e9
Show file tree
Hide file tree
Showing 3 changed files with 239 additions and 11 deletions.
18 changes: 9 additions & 9 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module manifold-doc

go 1.22.1

require git.softiron.com/sw/hc/sifi.git v0.43.0
require git.softiron.com/sw/hc/sifi.git v0.45.0

require (
dario.cat/mergo v1.0.0 // indirect
Expand Down Expand Up @@ -65,15 +65,15 @@ require (
github.com/xanzy/ssh-agent v0.3.3 // indirect
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/crypto v0.23.0 // indirect
golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 // indirect
golang.org/x/mod v0.17.0 // indirect
golang.org/x/net v0.25.0 // indirect
golang.org/x/crypto v0.24.0 // indirect
golang.org/x/exp v0.0.0-20240530194437-404ba88c7ed0 // indirect
golang.org/x/mod v0.18.0 // indirect
golang.org/x/net v0.26.0 // indirect
golang.org/x/sync v0.7.0 // indirect
golang.org/x/sys v0.20.0 // indirect
golang.org/x/term v0.20.0 // indirect
golang.org/x/text v0.15.0 // indirect
golang.org/x/tools v0.21.0 // indirect
golang.org/x/sys v0.21.0 // indirect
golang.org/x/term v0.21.0 // indirect
golang.org/x/text v0.16.0 // indirect
golang.org/x/tools v0.22.0 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/warnings.v0 v0.1.2 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
Expand Down
11 changes: 11 additions & 0 deletions go.sum
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ git.softiron.com/sw/hc/sifi.git v0.40.1 h1:o6iA0fj0Ay3zWmzsEiltpo40CHgakreH41FoV
git.softiron.com/sw/hc/sifi.git v0.40.1/go.mod h1:n83DoSBdcAx8wDYHPdxkH+v7c/wtmXxyubbE4bKutPc=
git.softiron.com/sw/hc/sifi.git v0.43.0 h1:3d57wa5rwv8UVzFa0Cb9VtsXwRl7nLrrAwJgt8nfdBk=
git.softiron.com/sw/hc/sifi.git v0.43.0/go.mod h1:fBz6ZtQVwgy8maxb0OVv6V2DhztrnpOmopAJ90DVY1A=
git.softiron.com/sw/hc/sifi.git v0.45.0 h1:FOwr74k/oWpXNDZ3LzqByPLGEF2ZVCxWfoYJKggt0oQ=
git.softiron.com/sw/hc/sifi.git v0.45.0/go.mod h1:kPHK34xOwHAYKK7KA9do0K/3vUrEr1slv0cZYmIpbx4=
github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc=
github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE=
github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY=
Expand Down Expand Up @@ -189,15 +191,18 @@ golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU
golang.org/x/crypto v0.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30=
golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M=
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5DM=
golang.org/x/exp v0.0.0-20240416160154-fe59bbe5cc7f h1:99ci1mjWVBWwJiEKYY6jWa4d2nTQVIEhZIptnrVb1XY=
golang.org/x/exp v0.0.0-20240416160154-fe59bbe5cc7f/go.mod h1:/lliqkxwWAhPjf5oSOIJup2XcqJaw8RGS6k3TGEc7GI=
golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842/go.mod h1:XtvwrStGgqGPLc4cjQfWqZHG1YFdYs6swckp8vpsjnc=
golang.org/x/exp v0.0.0-20240530194437-404ba88c7ed0/go.mod h1:XtvwrStGgqGPLc4cjQfWqZHG1YFdYs6swckp8vpsjnc=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic=
golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA=
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/mod v0.18.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
Expand All @@ -208,6 +213,7 @@ golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc=
golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w=
golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8=
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
Expand All @@ -234,6 +240,7 @@ golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
Expand All @@ -242,6 +249,7 @@ golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U=
golang.org/x/term v0.19.0 h1:+ThwsDv+tYfnJFhF4L8jITxu1tdTWRTZpdsWgEgjL6Q=
golang.org/x/term v0.19.0/go.mod h1:2CuTdWZ7KHSQwUzKva0cbMg6q2DMI3Mmxp+gKJbskEk=
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
golang.org/x/term v0.21.0/go.mod h1:ooXLefLobQVslOqselCNF4SxFAaoS6KujMbsGzSDmX0=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
Expand All @@ -252,6 +260,7 @@ golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
Expand All @@ -262,6 +271,8 @@ golang.org/x/tools v0.20.0 h1:hz/CVckiOxybQvFw6h7b/q80NTr9IUQb4s1IIzW7KNY=
golang.org/x/tools v0.20.0/go.mod h1:WvitBU7JJf6A4jOdg4S1tviW9bhUxkgeCui/0JHctQg=
golang.org/x/tools v0.21.0 h1:qc0xYgIbsSDt9EyWz05J5wfa7LOVW0YTLOXrqdLAWIw=
golang.org/x/tools v0.21.0/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
golang.org/x/tools v0.22.0 h1:gqSGLZqv+AI9lIQzniJ0nZDRG5GBPsSi+DRNHWNz6yA=
golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
gopkg.in/VividCortex/ewma.v1 v1.1.1/go.mod h1:TekXuFipeiHWiAlO1+wSS23vTcyFau5u3rxXUSXj710=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
Expand Down
221 changes: 219 additions & 2 deletions swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17257,6 +17257,70 @@
}
}
},
"/v2/metal/capacity": {
"get": {
"security": [
{
"Token": []
}
],
"description": "Returns overall capacity metrics for the cluster.",
"tags": [
"default"
],
"summary": "Get overall capacity metrics for the cluster",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/metal.TotalCapacity"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"423": {
"description": "Locked",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"503": {
"description": "Service Unavailable",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
}
}
}
},
"/v2/metal/datastore": {
"post": {
"security": [
Expand Down Expand Up @@ -35204,6 +35268,70 @@
}
}
},
"/v3-preview/metal/capacity": {
"get": {
"security": [
{
"Token": []
}
],
"description": "Returns overall capacity metrics for the cluster.",
"tags": [
"preview"
],
"summary": "Get overall capacity metrics for the cluster",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/metal.TotalCapacity"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"423": {
"description": "Locked",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"503": {
"description": "Service Unavailable",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
}
}
}
},
"/v3-preview/metal/datastore": {
"post": {
"security": [
Expand Down Expand Up @@ -35627,6 +35755,70 @@
}
}
},
"/v3-preview/metal/storage": {
"get": {
"security": [
{
"Token": []
}
],
"description": "Returns metrics for the cluster's storage subsystem.",
"tags": [
"preview"
],
"summary": "Get metrics for the cluster's storage subsystem",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/github_com_softiron_manifold-api_metal.SummaryResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"423": {
"description": "Locked",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
},
"503": {
"description": "Service Unavailable",
"schema": {
"$ref": "#/definitions/manifold.ResponseError"
}
}
}
}
},
"/v3-preview/snapper/snapshots/archive": {
"get": {
"security": [
Expand Down Expand Up @@ -37591,7 +37783,17 @@
"type": "object",
"properties": {
"auth": {
"type": "string"
"type": "string",
"enum": [
"core",
"public",
"ssh",
"x509",
"ldap",
"server_cipher",
"server_x509",
"custom"
]
},
"gids": {
"type": "array",
Expand Down Expand Up @@ -38805,7 +39007,7 @@
"github_com_softiron_manifold-api_cloud.InstantiateTemplateResponse": {
"type": "object",
"properties": {
"template": {
"instance": {
"type": "integer"
}
}
Expand Down Expand Up @@ -51202,6 +51404,9 @@
"HEALTH_ERROR"
]
},
"io_per_sec": {
"type": "integer"
},
"monitors_in_quorum": {
"type": "integer"
},
Expand All @@ -51227,9 +51432,18 @@
"pg_count": {
"type": "integer"
},
"pgs_by_state": {
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"pool_count": {
"type": "integer"
},
"read_bytes_per_sec": {
"type": "integer"
},
"storage_total_MB": {
"type": "integer"
},
Expand All @@ -51246,6 +51460,9 @@
"version_number": {
"description": "The Ceph version",
"type": "string"
},
"write_bytes_per_sec": {
"type": "integer"
}
}
},
Expand Down

0 comments on commit f9f83e9

Please sign in to comment.