github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/internal/config/etcd/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 etcd
    19  
    20  import "github.com/minio/minio/internal/config"
    21  
    22  // etcd config documented in default config
    23  var (
    24  	defaultHelpPostfix = func(key string) string {
    25  		return config.DefaultHelpPostfix(DefaultKVS, key)
    26  	}
    27  
    28  	Help = config.HelpKVS{
    29  		config.HelpKV{
    30  			Key:         Endpoints,
    31  			Description: `comma separated list of etcd endpoints` + defaultHelpPostfix(Endpoints),
    32  			Type:        "csv",
    33  			Sensitive:   true,
    34  		},
    35  		config.HelpKV{
    36  			Key:         PathPrefix,
    37  			Description: `namespace prefix to isolate tenants` + defaultHelpPostfix(PathPrefix),
    38  			Optional:    true,
    39  			Type:        "path",
    40  		},
    41  		config.HelpKV{
    42  			Key:         CoreDNSPath,
    43  			Description: `shared bucket DNS records` + defaultHelpPostfix(CoreDNSPath),
    44  			Optional:    true,
    45  			Type:        "path",
    46  		},
    47  		config.HelpKV{
    48  			Key:         ClientCert,
    49  			Description: `client cert for mTLS authentication` + defaultHelpPostfix(ClientCert),
    50  			Optional:    true,
    51  			Type:        "path",
    52  			Sensitive:   true,
    53  		},
    54  		config.HelpKV{
    55  			Key:         ClientCertKey,
    56  			Description: `client cert key for mTLS authentication` + defaultHelpPostfix(ClientCertKey),
    57  			Optional:    true,
    58  			Type:        "path",
    59  			Sensitive:   true,
    60  		},
    61  		config.HelpKV{
    62  			Key:         config.Comment,
    63  			Description: config.DefaultComment,
    64  			Optional:    true,
    65  			Type:        "sentence",
    66  		},
    67  	}
    68  )