docs: unify object_prefix field for oss/s3 backend

Signed-off-by: Yan Song <yansong.ys@antgroup.com>
dragonflyoss · Nov 8, 2023 · 1838200 · 1838200
1 parent 3900f25
commit 1838200
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/docs/nydus-image.md b/docs/nydus-image.md
@@ -192,9 +192,11 @@ data blobs: ["9e50ae5ac02b2ef6ffb86075720e49d95d8240eed4717dd8ac9c68cadba00762"]
 cat /path/to/backend-config.json
 {
   "endpoint": "region.aliyuncs.com",
+  "scheme": "https",
   "access_key_id": "",
   "access_key_secret": "",
-  "bucket_name": ""
+  "bucket_name": "",
+  "object_prefix": "nydus/"
 }
 
 # min_used_ratio:

diff --git a/docs/nydusd.md b/docs/nydusd.md
@@ -204,6 +204,7 @@ Document located at: https://github.com/adamqqqplay/nydus-localdisk/blob/master/
       "config": {
         ...
         "endpoint": "region.aliyuncs.com",
+        "scheme": "https",
         "access_key_id": "",
         "access_key_secret": "",
         "bucket_name": "",

diff --git a/docs/nydusify.md b/docs/nydusify.md
@@ -34,9 +34,11 @@ Nydusify uploads Nydus blob to registry by default, change this behavior by spec
 cat /path/to/backend-config.json
 {
   "endpoint": "region.aliyuncs.com",
+  "scheme": "https",
   "access_key_id": "",
   "access_key_secret": "",
-  "bucket_name": ""
+  "bucket_name": "",
+  "object_prefix": "nydus/"
 }
 ```
 
@@ -61,7 +63,8 @@ cat /path/to/backend-config.json
   "scheme": "http",
   "access_key_id": "",
   "access_key_secret": "",
-  "bucket_name": ""
+  "bucket_name": "",
+  "object_prefix": "nydus/"
 }
 ```
 
@@ -82,16 +85,16 @@ nydusify convert \
 ``` shell
 # meta_prefix:
 #  push bootstrap into oss://$bucket_name/$meta_prefix$bootstrap_name
-# blob_prefix:
-#  push blobs into oss://$bucket_name/$blob_prefix$blob_id
+# object_prefix:
+#  push blobs into oss://$bucket_name/$object_prefix$blob_id
 cat /path/to/backend-config.json
 {
   "bucket_name": "",
   "endpoint": "region.aliyuncs.com",
   "access_key_id": "",
   "access_key_secret": "",
   "meta_prefix": "meta/",
-  "blob_prefix": "blob/"
+  "object_prefix": "nydus/"
 }
 
 nydusify pack --bootstrap target.bootstrap \
@@ -107,16 +110,16 @@ nydusify pack --bootstrap target.bootstrap \
 ``` shell
 # meta_prefix:
 #  push bootstrap into s3://$bucket_name/$meta_prefix$bootstrap_name
-# blob_prefix:
-#  push blobs into s3://$bucket_name/$blob_prefix$blob_id
+# object_prefix:
+#  push blobs into s3://$bucket_name/$object_prefix$blob_id
 cat /path/to/backend-config.json
 {
   "bucket_name": "",
   "endpoint": "my-s3-service.net",
   "access_key_id": "",
   "access_key_secret": "",
   "meta_prefix": "meta/",
-  "blob_prefix": "blob/"
+  "object_prefix": "nydus/"
 }
 
 nydusify pack --bootstrap target.bootstrap \