storj.io/minio@v0.0.0-20230509071714-0cbc90f649b1/cmd/config/cache/help.go (about)

     1  /*
     2   * MinIO Cloud Storage, (C) 2019 MinIO, Inc.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package cache
    18  
    19  import "storj.io/minio/cmd/config"
    20  
    21  // Help template for caching feature.
    22  var (
    23  	Help = config.HelpKVS{
    24  		config.HelpKV{
    25  			Key:         Drives,
    26  			Description: `comma separated mountpoints e.g. "/optane1,/optane2"`,
    27  			Type:        "csv",
    28  		},
    29  		config.HelpKV{
    30  			Key:         Expiry,
    31  			Description: `cache expiry duration in days e.g. "90"`,
    32  			Optional:    true,
    33  			Type:        "number",
    34  		},
    35  		config.HelpKV{
    36  			Key:         Quota,
    37  			Description: `limit cache drive usage in percentage e.g. "90"`,
    38  			Optional:    true,
    39  			Type:        "number",
    40  		},
    41  		config.HelpKV{
    42  			Key:         Exclude,
    43  			Description: `exclude cache for following patterns e.g. "bucket/*.tmp,*.exe"`,
    44  			Optional:    true,
    45  			Type:        "csv",
    46  		},
    47  		config.HelpKV{
    48  			Key:         After,
    49  			Description: `minimum number of access before caching an object`,
    50  			Optional:    true,
    51  			Type:        "number",
    52  		},
    53  		config.HelpKV{
    54  			Key:         WatermarkLow,
    55  			Description: `% of cache use at which to stop cache eviction`,
    56  			Optional:    true,
    57  			Type:        "number",
    58  		},
    59  		config.HelpKV{
    60  			Key:         WatermarkHigh,
    61  			Description: `% of cache use at which to start cache eviction`,
    62  			Optional:    true,
    63  			Type:        "number",
    64  		},
    65  		config.HelpKV{
    66  			Key:         Range,
    67  			Description: `set to "on" or "off" caching of independent range requests per object, defaults to "on"`,
    68  			Optional:    true,
    69  			Type:        "string",
    70  		},
    71  		config.HelpKV{
    72  			Key:         Commit,
    73  			Description: `set to control cache commit behavior, defaults to "writethrough"`,
    74  			Optional:    true,
    75  			Type:        "string",
    76  		},
    77  		config.HelpKV{
    78  			Key:         config.Comment,
    79  			Description: config.DefaultComment,
    80  			Optional:    true,
    81  			Type:        "sentence",
    82  		},
    83  	}
    84  )