github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/internal/config/heal/help.go (about)

     1  // Copyright (c) 2015-2021 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 heal
    19  
    20  import "github.com/minio/minio/internal/config"
    21  
    22  // Help template for caching feature.
    23  var (
    24  	defaultHelpPostfix = func(key string) string {
    25  		return config.DefaultHelpPostfix(DefaultKVS, key)
    26  	}
    27  
    28  	// Help provides help for config values
    29  	Help = config.HelpKVS{
    30  		config.HelpKV{
    31  			Key:         Bitrot,
    32  			Description: `perform bitrot scan on drives when checking objects during scanner` + defaultHelpPostfix(Bitrot),
    33  			Optional:    true,
    34  			Type:        "on|off",
    35  		},
    36  		config.HelpKV{
    37  			Key:         Sleep,
    38  			Description: `maximum sleep duration between objects to slow down heal operation` + defaultHelpPostfix(Sleep),
    39  			Optional:    true,
    40  			Type:        "duration",
    41  		},
    42  		config.HelpKV{
    43  			Key:         IOCount,
    44  			Description: `maximum IO requests allowed between objects to slow down heal operation` + defaultHelpPostfix(IOCount),
    45  			Optional:    true,
    46  			Type:        "int",
    47  		},
    48  		config.HelpKV{
    49  			Key:         DriveWorkers,
    50  			Description: `the number of workers per drive to heal a new disk replacement` + defaultHelpPostfix(DriveWorkers),
    51  			Optional:    true,
    52  			Type:        "int",
    53  		},
    54  	}
    55  )