cubefs/docs/source/user-guide/objectnode.rst
Mofei Zhang d609fedb5c feature: object storage interface
Add ObjectNode provides S3-compatibile APIs.
Fusion Storage interface expose two interface (POSIX and S3-compatible) for file operation.

Signed-off-by: Mofei Zhang <mofei2816@gmail.com>
2019-12-17 17:36:53 +08:00

58 lines
1.7 KiB
ReStructuredText

Object Storage Service
==============================
How To Provide Object Storage Service with ObjectNode
-----------------------
Start a ObjectNode process by execute the server binary of ChubaoFS you built with ``-c`` argument and specify configuration file.
.. code-block:: bash
nohup cfs-server -c s3gateway.json &
Configurations
-----------------------
.. csv-table:: Properties
:header: "Key", "Type", "Description", "Mandatory"
"role", "string", "Role of process and must be set to *objectnode*", "Yes"
"listen", "string", "Listen and accept port of the server. Default: 80", "Yes"
"region", "string", "Region of this gateway. Used by S3-like interface signature validation. Default: cfs_default", "No"
"domains", "string slice", "
| Format: *DOMAIN*.
| DOMAIN: Domain of S3-like interface which makes wildcard domain support", "No"
"logDir", "string", "Log directory", "Yes"
"logLevel", "string", "Level operation for logging. Default is *error*", "No"
"masters", "string slice", "
| Format: *HOST:PORT*.
| HOST: Hostname, domain or IP address of master (resource manager).
| PORT: port number which listened by this master", "Yes"
"exporterPort", "string", "Port for monitor system", "No"
"prof", "string", "Pprof port", "Yes"
**Example:**
.. code-block:: json
{
"role": "objectnode",
"listen": 80,
"region": "test",
"domains": [
"object.cfs.local"
],
"logDir": "/opt/cfs/objectnode/logs",
"logLevel": "debug",
"masters": [
"172.20.240.95:7002",
"172.20.240.94:7002",
"172.20.240.67:7002"
],
"exporterPort": 9512,
"prof": "7013"
}