Re: [PR] Doc: storage.yaml [trafficserver]

["masaori335 (via GitHub)" <gi...@apache.org>]

masaori335 commented on code in PR #11000:
URL: https://github.com/apache/trafficserver/pull/11000#discussion_r1483721297


##########
doc/admin-guide/files/storage.yaml.en.rst:
##########
@@ -0,0 +1,482 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+==============
+storage.yaml
+==============
+
+.. configfile:: storage.yaml
+
+The :file:`storage.yaml` file (by default, located in
+``/usr/local/etc/trafficserver/``) lists all the files, directories, and/or
+hard disk partitions that make up the Traffic Server cache. After you
+modify the :file:`storage.yaml` file the new settings will not be effective until Traffic Server is restarted.
+
+Format
+======
+
+The format of the :file:`storage.yaml` file is a series of lines of the form
+
+.. code-block:: yaml
+
+   cache:           # file level key
+     spans:         #
+       - id:        # identifier / name of the span
+         path:      # path to storage
+         size:      # size in bytes, required for file system storage, optional for raw device
+         hash_seed: # optional, used to isolate lookup from path changes
+     volumes:       # optional
+       - id:        # identifier [1-255]
+         size:      # optional, size in percentage
+         scheme:    # optional, default to "http"
+         ram-cache: # optional, default to "true"

Review Comment:
   Should be `ram_cache` to follow the naming convention.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@trafficserver.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org