github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/internal/config/subnet/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 subnet
    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  	// HelpSubnet - provides help for subnet api key config
    28  	HelpSubnet = config.HelpKVS{
    29  		config.HelpKV{
    30  			Key:         config.License, // Deprecated Dec 2021
    31  			Type:        "string",
    32  			Description: "[DEPRECATED use api_key] Subnet license token for the cluster" + defaultHelpPostfix(config.License),
    33  			Optional:    true,
    34  			Sensitive:   true,
    35  		},
    36  		config.HelpKV{
    37  			Key:         config.APIKey,
    38  			Type:        "string",
    39  			Description: "Subnet api key for the cluster" + defaultHelpPostfix(config.APIKey),
    40  			Optional:    true,
    41  			Sensitive:   true,
    42  		},
    43  		config.HelpKV{
    44  			Key:         config.Proxy,
    45  			Type:        "string",
    46  			Description: "HTTP(S) proxy URL to use for connecting to SUBNET" + defaultHelpPostfix(config.Proxy),
    47  			Optional:    true,
    48  			Sensitive:   true,
    49  		},
    50  	}
    51  )