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

     1  // Copyright (c) 2015-2023 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 lambda
    19  
    20  import (
    21  	"github.com/minio/minio/internal/config"
    22  	"github.com/minio/minio/internal/event/target"
    23  )
    24  
    25  // Help template inputs for all lambda targets
    26  var (
    27  	HelpWebhook = config.HelpKVS{
    28  		config.HelpKV{
    29  			Key:         target.WebhookEndpoint,
    30  			Description: "webhook server endpoint e.g. http://localhost:8080/minio/lambda",
    31  			Type:        "url",
    32  			Sensitive:   true,
    33  		},
    34  		config.HelpKV{
    35  			Key:         target.WebhookAuthToken,
    36  			Description: "opaque string or JWT authorization token",
    37  			Optional:    true,
    38  			Type:        "string",
    39  			Sensitive:   true,
    40  			Secret:      true,
    41  		},
    42  		config.HelpKV{
    43  			Key:         config.Comment,
    44  			Description: config.DefaultComment,
    45  			Optional:    true,
    46  			Type:        "sentence",
    47  		},
    48  		config.HelpKV{
    49  			Key:         target.WebhookClientCert,
    50  			Description: "client cert for Webhook mTLS auth",
    51  			Optional:    true,
    52  			Type:        "string",
    53  			Sensitive:   true,
    54  		},
    55  		config.HelpKV{
    56  			Key:         target.WebhookClientKey,
    57  			Description: "client cert key for Webhook mTLS auth",
    58  			Optional:    true,
    59  			Type:        "string",
    60  			Sensitive:   true,
    61  		},
    62  	}
    63  )