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

     1  // Copyright (c) 2015-2024 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 ilm
    19  
    20  import "github.com/minio/minio/internal/config"
    21  
    22  const (
    23  	transitionWorkers = "transition_workers"
    24  	expirationWorkers = "expiration_workers"
    25  	// EnvILMTransitionWorkers env variable to configure number of transition workers
    26  	EnvILMTransitionWorkers = "MINIO_ILM_TRANSITION_WORKERS"
    27  	// EnvILMExpirationWorkers env variable to configure number of expiration workers
    28  	EnvILMExpirationWorkers = "MINIO_ILM_EXPIRATION_WORKERS"
    29  )
    30  
    31  var (
    32  	defaultHelpPostfix = func(key string) string {
    33  		return config.DefaultHelpPostfix(DefaultKVS, key)
    34  	}
    35  
    36  	// HelpILM holds configuration keys and their default values for the ILM
    37  	// subsystem
    38  	HelpILM = config.HelpKVS{
    39  		config.HelpKV{
    40  			Key:         transitionWorkers,
    41  			Type:        "number",
    42  			Description: `set the number of transition workers` + defaultHelpPostfix(transitionWorkers),
    43  			Optional:    true,
    44  		},
    45  		config.HelpKV{
    46  			Key:         expirationWorkers,
    47  			Type:        "number",
    48  			Description: `set the number of expiration workers` + defaultHelpPostfix(expirationWorkers),
    49  			Optional:    true,
    50  		},
    51  	}
    52  )