mirror of
https://github.com/minio/minio.git
synced 2025-11-11 06:20:14 -05:00
Move admin APIs to new path and add redesigned heal APIs (#5351)
- Changes related to moving admin APIs
- admin APIs now have an endpoint under /minio/admin
- admin APIs are now versioned - a new API to server the version is
added at "GET /minio/admin/version" and all API operations have the
path prefix /minio/admin/v1/<operation>
- new service stop API added
- credentials change API is moved to /minio/admin/v1/config/credential
- credentials change API and configuration get/set API now require TLS
so that credentials are protected
- all API requests now receive JSON
- heal APIs are disabled as they will be changed substantially
- Heal API changes
Heal API is now provided at a single endpoint with the ability for a
client to start a heal sequence on all the data in the server, a
single bucket, or under a prefix within a bucket.
When a heal sequence is started, the server returns a unique token
that needs to be used for subsequent 'status' requests to fetch heal
results.
On each status request from the client, the server returns heal result
records that it has accumulated since the previous status request. The
server accumulates upto 1000 records and pauses healing further
objects until the client requests for status. If the client does not
request any further records for a long time, the server aborts the
heal sequence automatically.
A heal result record is returned for each entity healed on the server,
such as system metadata, object metadata, buckets and objects, and has
information about the before and after states on each disk.
A client may request to force restart a heal sequence - this causes
the running heal sequence to be aborted at the next safe spot and
starts a new heal sequence.
This commit is contained in:
committed by
Harshavardhana
parent
f3f09ed14e
commit
a337ea4d11
@@ -18,69 +18,79 @@
|
||||
package madmin
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"io/ioutil"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"time"
|
||||
)
|
||||
|
||||
// ServiceStatusMetadata - contains the response of service status API
|
||||
type ServiceStatusMetadata struct {
|
||||
Uptime time.Duration `json:"uptime"`
|
||||
// ServerVersion - server version
|
||||
type ServerVersion struct {
|
||||
Version string `json:"version"`
|
||||
CommitID string `json:"commitID"`
|
||||
}
|
||||
|
||||
// ServiceStatus - Connect to a minio server and call Service Status Management API
|
||||
// to fetch server's storage information represented by ServiceStatusMetadata structure
|
||||
func (adm *AdminClient) ServiceStatus() (ServiceStatusMetadata, error) {
|
||||
// ServiceStatus - contains the response of service status API
|
||||
type ServiceStatus struct {
|
||||
ServerVersion ServerVersion `json:"serverVersion"`
|
||||
Uptime time.Duration `json:"uptime"`
|
||||
}
|
||||
|
||||
// Prepare web service request
|
||||
reqData := requestData{}
|
||||
reqData.queryValues = make(url.Values)
|
||||
reqData.queryValues.Set("service", "")
|
||||
reqData.customHeaders = make(http.Header)
|
||||
reqData.customHeaders.Set(minioAdminOpHeader, "status")
|
||||
|
||||
// Execute GET on bucket to list objects.
|
||||
resp, err := adm.executeMethod("GET", reqData)
|
||||
// ServiceStatus - Connect to a minio server and call Service Status
|
||||
// Management API to fetch server's storage information represented by
|
||||
// ServiceStatusMetadata structure
|
||||
func (adm *AdminClient) ServiceStatus() (ss ServiceStatus, err error) {
|
||||
// Request API to GET service status
|
||||
resp, err := adm.executeMethod("GET", requestData{relPath: "/v1/service"})
|
||||
defer closeResponse(resp)
|
||||
if err != nil {
|
||||
return ServiceStatusMetadata{}, err
|
||||
return ss, err
|
||||
}
|
||||
|
||||
// Check response http status code
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return ServiceStatusMetadata{}, httpRespToErrorResponse(resp)
|
||||
return ss, httpRespToErrorResponse(resp)
|
||||
}
|
||||
|
||||
// Unmarshal the server's json response
|
||||
var serviceStatus ServiceStatusMetadata
|
||||
|
||||
respBytes, err := ioutil.ReadAll(resp.Body)
|
||||
if err != nil {
|
||||
return ServiceStatusMetadata{}, err
|
||||
return ss, err
|
||||
}
|
||||
|
||||
err = json.Unmarshal(respBytes, &serviceStatus)
|
||||
if err != nil {
|
||||
return ServiceStatusMetadata{}, err
|
||||
}
|
||||
|
||||
return serviceStatus, nil
|
||||
err = json.Unmarshal(respBytes, &ss)
|
||||
return ss, err
|
||||
}
|
||||
|
||||
// ServiceRestart - Call Service Restart API to restart a specified Minio server
|
||||
func (adm *AdminClient) ServiceRestart() error {
|
||||
//
|
||||
reqData := requestData{}
|
||||
reqData.queryValues = make(url.Values)
|
||||
reqData.queryValues.Set("service", "")
|
||||
reqData.customHeaders = make(http.Header)
|
||||
reqData.customHeaders.Set(minioAdminOpHeader, "restart")
|
||||
// ServiceActionValue - type to restrict service-action values
|
||||
type ServiceActionValue string
|
||||
|
||||
// Execute GET on bucket to list objects.
|
||||
resp, err := adm.executeMethod("POST", reqData)
|
||||
const (
|
||||
// ServiceActionValueRestart represents restart action
|
||||
ServiceActionValueRestart ServiceActionValue = "restart"
|
||||
// ServiceActionValueStop represents stop action
|
||||
ServiceActionValueStop = "stop"
|
||||
)
|
||||
|
||||
// ServiceAction - represents POST body for service action APIs
|
||||
type ServiceAction struct {
|
||||
Action ServiceActionValue `json:"action"`
|
||||
}
|
||||
|
||||
// ServiceSendAction - Call Service Restart/Stop API to restart/stop a
|
||||
// Minio server
|
||||
func (adm *AdminClient) ServiceSendAction(action ServiceActionValue) error {
|
||||
body, err := json.Marshal(ServiceAction{action})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Request API to Restart server
|
||||
resp, err := adm.executeMethod("POST", requestData{
|
||||
relPath: "/v1/service",
|
||||
contentBody: bytes.NewReader(body),
|
||||
contentSHA256Bytes: sum256(body),
|
||||
})
|
||||
defer closeResponse(resp)
|
||||
if err != nil {
|
||||
return err
|
||||
|
||||
Reference in New Issue
Block a user