Files
madmin-go/cordon-commands.go
M AlveeandGitHub 47606f6238 distributed job framework (#557)
* feat: add DistJobType enum and sync distjob status types

Adds an iota-based DistJobType enum (mirrors the HealingDriveReason/
OfflineReason pattern already used in heal-commands.go) so distributed
job identity is a typed wire value instead of a bare string, per review
feedback on the eos distributed-job framework PR.

Also syncs DistJobLeaderStatus/DistJobNodeStatus field shapes to match
the current server-side JSON response (JobID/JobType replace JobName;
drops the unused Generation/AssignedSets/top-level CurrentBucket
fields that were never populated by the server).

* fix: bump vulnerable prometheus dep

- Add msgp generation (//msgp:tag json + //go:generate msgp) for
  DistJobLeaderStatus/DistJobNodeStatus, matching the pattern used by
  every other *-commands.go file in this package.
- Add unit tests for ListDistJobStatuses (success path, job-filter
  query param, DistJobTypeUnknown no-filter case, non-200 error path).
- Bump github.com/prometheus/prometheus v0.304.1 -> v0.312.0 to clear
  3 of the 4 govulncheck findings on this branch (GO-2026-5710,
  GO-2026-5381, GO-2026-5264, all fixed by that version). The 4th,
  GO-2026-5662, has no fix published upstream yet and also currently
  fails govulncheck on main independent of this branch.

* fix: pin go:generate directives to go.mod tool versions

Consolidate distjob-commands.go's separate //msgp:tag json directive
into the //go:generate msgp -d "tag json" flag, matching net-stats.go's
style (review feedback, PR #557).

Change every //go:generate msgp / //go:generate stringer directive
(31 occurrences, 30 files) to //go:generate go tool msgp / go tool
stringer, so generation always resolves the exact version pinned in
go.mod's tool block instead of whatever binary happens to be on PATH.
This was the root cause of the earlier stringer-drift CI failure.
Drop the now-unnecessary `go install -v tool` step from lint.yml.
2026-07-01 05:10:23 -04:00

131 lines
4.2 KiB
Go

//
// Copyright (c) 2015-2025 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
package madmin
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/url"
"slices"
)
//msgp:tag json
//go:generate go tool msgp -d clearomitted -d "timezone utc" -file $GOFILE
const (
CordonAction = "cordon"
UncordonAction = "uncordon"
DrainAction = "drain"
StateCordoned = "cordoned"
StateDraining = "draining"
)
// CordonActionValidate validates if the given action is one of the known, allowed actions.
func CordonActionValidate(action string) error {
validActions := []string{CordonAction, UncordonAction, DrainAction}
if !slices.Contains(validActions, action) {
return fmt.Errorf("invalid action '%s', must be one of '%s'", action, validActions)
}
return nil
}
// CordonNodeResult represents the result of a cordon, uncordon or drain operation on a node.
// Node will be the targeted node, in the format <host>:<port>.
// Errors will contain any errors that occurred communicating the Cordon to peers, each item in the slice
// will have the node name and the error message from that node, e.g. "node1:9000: <error message>".
type CordonNodeResult struct {
Node string `json:"node"`
Errors []string `json:"errors,omitempty"`
}
//msgp:ignore cordonNodeOpts
// cordonNodeOpts is used internally to pass options to the cordonAction method.
type cordonNodeOpts struct {
Action string
Node string
}
// Cordon will cordon a node, preventing it from receiving new requests and putting it in a maintenance mode.
// The node name is given in the format <host>:<port>, for example: "node1:9000".
func (adm *AdminClient) Cordon(ctx context.Context, node string) (CordonNodeResult, error) {
return adm.cordonAction(ctx, cordonNodeOpts{
Action: CordonAction,
Node: node,
})
}
// Uncordon will uncordon a node, allowing it to receive requests again.
// The node name is given in the format <host>:<port>, for example: "node1:9000".
func (adm *AdminClient) Uncordon(ctx context.Context, node string) (CordonNodeResult, error) {
return adm.cordonAction(ctx, cordonNodeOpts{
Action: UncordonAction,
Node: node,
})
}
// Drain will drain a node, preventing it from receiving new requests and allowing existing requests to finish.
// The node name is given in the format <host>:<port>, for example: "node1:9000".
// The node will Cordon itself once the drain is completel and there are 0 remaining connections.
func (adm *AdminClient) Drain(ctx context.Context, node string) (CordonNodeResult, error) {
return adm.cordonAction(ctx, cordonNodeOpts{
Action: DrainAction,
Node: node,
})
}
// cordonAction can cordon, drain or uncordon a node
func (adm *AdminClient) cordonAction(ctx context.Context, opts cordonNodeOpts) (CordonNodeResult, error) {
if err := CordonActionValidate(opts.Action); err != nil {
return CordonNodeResult{}, err
}
if opts.Node == "" {
return CordonNodeResult{}, ErrInvalidArgument("node must be specified")
}
queryValues := url.Values{}
queryValues.Set("action", opts.Action)
queryValues.Set("node", opts.Node)
resp, err := adm.executeMethod(ctx,
http.MethodPost, requestData{
relPath: adminAPIPrefix + "/cordon",
queryValues: queryValues,
},
)
defer closeResponse(resp)
if err != nil {
return CordonNodeResult{}, err
}
if resp.StatusCode != http.StatusOK {
return CordonNodeResult{}, httpRespToErrorResponse(resp)
}
result := CordonNodeResult{}
dec := json.NewDecoder(resp.Body)
if err = dec.Decode(&result); err != nil {
return CordonNodeResult{}, err
}
return result, nil
}