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

     1  // Copyright (c) 2015-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 callhome
    19  
    20  import "github.com/minio/minio/internal/config"
    21  
    22  var (
    23  	defaultHelpPostfix = func(key string) string {
    24  		return config.DefaultHelpPostfix(DefaultKVS, key)
    25  	}
    26  
    27  	// HelpCallhome - provides help for callhome config
    28  	HelpCallhome = config.HelpKVS{
    29  		config.HelpKV{
    30  			Key:         Enable,
    31  			Type:        "on|off",
    32  			Description: "set to enable callhome" + defaultHelpPostfix(Enable),
    33  			Optional:    true,
    34  		},
    35  		config.HelpKV{
    36  			Key:         Frequency,
    37  			Type:        "duration",
    38  			Description: "time duration between callhome cycles e.g. 24h" + defaultHelpPostfix(Frequency),
    39  			Optional:    true,
    40  		},
    41  	}
    42  )