github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/internal/config/policy/plugin/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 plugin
    19  
    20  import "github.com/minio/minio/internal/config"
    21  
    22  // Help template for Access Management Plugin policy feature.
    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:         URL,
    31  			Description: `plugin hook endpoint (HTTP(S)) e.g. "http://localhost:8181/v1/data/httpapi/authz/allow"` + defaultHelpPostfix(URL),
    32  			Type:        "url",
    33  			Sensitive:   true,
    34  		},
    35  		config.HelpKV{
    36  			Key:         AuthToken,
    37  			Description: "authorization header for plugin hook endpoint" + defaultHelpPostfix(AuthToken),
    38  			Optional:    true,
    39  			Type:        "string",
    40  			Sensitive:   true,
    41  			Secret:      true,
    42  		},
    43  		config.HelpKV{
    44  			Key:         EnableHTTP2,
    45  			Description: "Enable experimental HTTP2 support to connect to plugin service" + defaultHelpPostfix(EnableHTTP2),
    46  			Optional:    true,
    47  			Type:        "bool",
    48  		},
    49  		config.HelpKV{
    50  			Key:         config.Comment,
    51  			Description: config.DefaultComment,
    52  			Optional:    true,
    53  			Type:        "sentence",
    54  		},
    55  	}
    56  )