github.com/minio/mc@v0.0.0-20240503112107-b471de8d1882/cmd/admin-service-unfreeze.go (about)

     1  // Copyright (c) 2022 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package cmd
    19  
    20  import (
    21  	"github.com/fatih/color"
    22  	"github.com/minio/cli"
    23  	json "github.com/minio/colorjson"
    24  	"github.com/minio/mc/pkg/probe"
    25  	"github.com/minio/pkg/v2/console"
    26  )
    27  
    28  var adminServiceUnfreezeCmd = cli.Command{
    29  	Name:         "unfreeze",
    30  	Usage:        "unfreeze S3 API calls on MinIO cluster",
    31  	Action:       mainAdminServiceUnfreeze,
    32  	OnUsageError: onUsageError,
    33  	Before:       setGlobalsFromContext,
    34  	Flags:        globalFlags,
    35  	CustomHelpTemplate: `NAME:
    36    {{.HelpName}} - {{.Usage}}
    37  
    38  USAGE:
    39    {{.HelpName}} TARGET
    40  
    41  FLAGS:
    42    {{range .VisibleFlags}}{{.}}
    43    {{end}}
    44  EXAMPLES:
    45    1. Unfreeze all S3 API calls on MinIO server at 'myminio/'.
    46       {{.Prompt}} {{.HelpName}} myminio/
    47  `,
    48  }
    49  
    50  // serviceUnfreezeCommand is container for service unfreeze command success and failure messages.
    51  type serviceUnfreezeCommand struct {
    52  	Status    string `json:"status"`
    53  	ServerURL string `json:"serverURL"`
    54  }
    55  
    56  // String colorized service unfreeze command message.
    57  func (s serviceUnfreezeCommand) String() string {
    58  	return console.Colorize("ServiceUnfreeze", "Unfreeze command successfully sent to `"+s.ServerURL+"`.")
    59  }
    60  
    61  // JSON jsonified service unfreeze command message.
    62  func (s serviceUnfreezeCommand) JSON() string {
    63  	serviceUnfreezeJSONBytes, e := json.MarshalIndent(s, "", " ")
    64  	fatalIf(probe.NewError(e), "Unable to marshal into JSON.")
    65  
    66  	return string(serviceUnfreezeJSONBytes)
    67  }
    68  
    69  // checkAdminServiceUnfreezeSyntax - validate all the passed arguments
    70  func checkAdminServiceUnfreezeSyntax(ctx *cli.Context) {
    71  	if len(ctx.Args()) != 1 {
    72  		showCommandHelpAndExit(ctx, 1) // last argument is exit code
    73  	}
    74  }
    75  
    76  func mainAdminServiceUnfreeze(ctx *cli.Context) error {
    77  	// Validate serivce unfreeze syntax.
    78  	checkAdminServiceUnfreezeSyntax(ctx)
    79  
    80  	// Set color.
    81  	console.SetColor("ServiceUnfreeze", color.New(color.FgGreen, color.Bold))
    82  	console.SetColor("FailedServiceUnfreeze", color.New(color.FgRed, color.Bold))
    83  
    84  	// Get the alias parameter from cli
    85  	args := ctx.Args()
    86  	aliasedURL := args.Get(0)
    87  
    88  	client, err := newAdminClient(aliasedURL)
    89  	fatalIf(err, "Unable to initialize admin connection.")
    90  
    91  	// Unfreeze the specified MinIO server
    92  	fatalIf(probe.NewError(client.ServiceUnfreeze(globalContext)), "Unable to unfreeze the server.")
    93  
    94  	// Success..
    95  	printMsg(serviceUnfreezeCommand{Status: "success", ServerURL: aliasedURL})
    96  
    97  	return nil
    98  }