From 6d5d49bfb18db76cdbbb42cf4da77d3e429931b1 Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Fri, 15 Sep 2017 07:47:42 +0530 Subject: [PATCH] Update CLI examples to be in sync with examples used on Minio website (#4920) --- README.md | 6 +++--- README_ZH.md | 6 +++--- docs/browser/README.md | 2 +- docs/config/README.md | 8 ++++---- docs/erasure/README.md | 20 +++++++++---------- docs/multi-tenancy/README.md | 12 +++++------ .../docker-compose/docker-compose.yaml | 8 ++++---- docs/orchestration/kubernetes-yaml/README.md | 8 ++++---- .../minio-standalone-deployment.yaml | 8 ++++---- docs/shared-backend/DESIGN.md | 14 ++++++------- docs/shared-backend/README.md | 4 ++-- 11 files changed, 48 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 921ba642a..96e73e2b9 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Install minio packages using [Homebrew](http://brew.sh/) ```sh brew install minio/stable/minio -minio server ~/Photos +minio server /data ``` #### Note If you previously installed minio using `brew install minio` then reinstall minio from `minio/stable/minio` official repo. Homebrew builds are unstable due to golang 1.8 bugs. @@ -40,7 +40,7 @@ brew install minio/stable/minio |Apple macOS|64-bit Intel|https://dl.minio.io/server/minio/release/darwin-amd64/minio | ```sh chmod 755 minio -./minio server ~/Photos +./minio server /data ``` ## GNU/Linux @@ -50,7 +50,7 @@ chmod 755 minio |GNU/Linux|64-bit Intel|https://dl.minio.io/server/minio/release/linux-amd64/minio | ```sh chmod +x minio -./minio server ~/Photos +./minio server /data ``` ### Snap diff --git a/README_ZH.md b/README_ZH.md index d56d04836..8baaafa66 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -42,7 +42,7 @@ $ go get -u github.com/minio/minio $ chmod +x minio $ ./minio --help -$ ./minio server ~/Photos +$ ./minio server /data 端点: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 AccessKey: USWUXHGYZQYFYFFIT3RE @@ -70,7 +70,7 @@ SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 $ chmod 755 minio $ ./minio --help -$ ./minio server ~/Photos +$ ./minio server /data 端点: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 AccessKey: USWUXHGYZQYFYFFIT3RE @@ -134,7 +134,7 @@ $ docker run -p 9000:9000 minio/minio $ chmod 755 minio $ ./minio --help -$ ./minio server ~/Photos +$ ./minio server /data 端点: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000 AccessKey: USWUXHGYZQYFYFFIT3RE diff --git a/docs/browser/README.md b/docs/browser/README.md index f3c2d1643..11ae46728 100644 --- a/docs/browser/README.md +++ b/docs/browser/README.md @@ -12,7 +12,7 @@ Currently these tokens expire after 10hrs, this is not configurable yet. ### Start minio server ``` -minio server +minio server /data ``` ### JSON RPC APIs. diff --git a/docs/config/README.md b/docs/config/README.md index 68ea5d468..11277d4af 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -6,7 +6,7 @@ Minio server stores all its configuration data in `${HOME}/.minio/config.json` f The default configuration directory is `${HOME}/.minio`. You can override the default configuration directory using `--config-dir` command-line option. Minio server generates a new `config.json` with auto-generated access credentials when its started for the first time. ```sh -minio server --config-dir /etc/minio +minio server --config-dir /etc/minio /data ``` ### Certificate Directory @@ -42,7 +42,7 @@ Example: ```sh export MINIO_ACCESS_KEY=admin export MINIO_SECRET_KEY=password -minio server ~/Photos +minio server /data ``` #### Region @@ -54,7 +54,7 @@ Example: ```sh export MINIO_REGION="my_region" -minio server ~/Photos +minio server /data ``` #### Browser @@ -66,7 +66,7 @@ Example: ```sh export MINIO_BROWSER=off -minio server ~/Photos +minio server /data ``` #### Logger diff --git a/docs/erasure/README.md b/docs/erasure/README.md index 52f735f6e..f4eb0a769 100644 --- a/docs/erasure/README.md +++ b/docs/erasure/README.md @@ -29,22 +29,22 @@ Install Minio - [Minio Quickstart Guide](https://docs.minio.io/docs/minio-quicks Example: Start Minio server in a 12 drives setup, using Minio binary. ```sh -minio server /mnt/export1/backend /mnt/export2/backend /mnt/export3/backend /mnt/export4/backend /mnt/export5/backend /mnt/export6/backend /mnt/export7/backend /mnt/export8/backend /mnt/export9/backend /mnt/export10/backend /mnt/export11/backend /mnt/export12/backend +minio server /data1 /data2 /data3 /data4 /data5 /data6 /data7 /data8 /data9 /data10 /data11 /data12 ``` Example: Start Minio server in a 8 drives setup, using Minio Docker image. ```sh docker run -p 9000:9000 --name minio \ - -v /mnt/export1/backend:/export1 \ - -v /mnt/export2/backend:/export2 \ - -v /mnt/export3/backend:/export3 \ - -v /mnt/export4/backend:/export4 \ - -v /mnt/export5/backend:/export5 \ - -v /mnt/export6/backend:/export6 \ - -v /mnt/export7/backend:/export7 \ - -v /mnt/export8/backend:/export8 \ - minio/minio server /export1 /export2 /export3 /export4 /export5 /export6 /export7 /export8 + -v /mnt/data1:/data1 \ + -v /mnt/data2:/data2 \ + -v /mnt/data3:/data3 \ + -v /mnt/data4:/data4 \ + -v /mnt/data5:/data5 \ + -v /mnt/data6:/data6 \ + -v /mnt/data7:/data7 \ + -v /mnt/data8:/data8 \ + minio/minio server /data1 /data2 /data3 /data4 /data5 /data6 /data7 /data8 ``` ### 3. Test your setup diff --git a/docs/multi-tenancy/README.md b/docs/multi-tenancy/README.md index 920afd17a..af8019475 100644 --- a/docs/multi-tenancy/README.md +++ b/docs/multi-tenancy/README.md @@ -7,9 +7,9 @@ To host multiple tenants on a single machine, run one Minio server per tenant wi This example hosts 3 tenants on a single drive. ```sh -minio --config-dir ~/tenant1 server --address :9001 /disk1/data/tenant1 -minio --config-dir ~/tenant2 server --address :9002 /disk1/data/tenant2 -minio --config-dir ~/tenant3 server --address :9003 /disk1/data/tenant3 +minio --config-dir ~/tenant1 server --address :9001 /data/tenant1 +minio --config-dir ~/tenant2 server --address :9002 /data/tenant2 +minio --config-dir ~/tenant3 server --address :9003 /data/tenant3 ``` ![Example-1](https://github.com/minio/minio/blob/master/docs/screenshots/Example-1.jpg?raw=true) @@ -34,15 +34,15 @@ This example hosts 3 tenants on a 4 node distributed setup. Execute the followin ```sh export MINIO_ACCESS_KEY= export MINIO_SECRET_KEY= -minio --config-dir ~/tenant1 server --address :9001 http://192.168.10.11/disk1/data/tenant1 http://192.168.10.12/disk1/data/tenant1 http://192.168.10.13/disk1/data/tenant1 http://192.168.10.14/disk1/data/tenant1 +minio --config-dir ~/tenant1 server --address :9001 http://192.168.10.11/data/tenant1 http://192.168.10.12/data/tenant1 http://192.168.10.13/data/tenant1 http://192.168.10.14/data/tenant1 export MINIO_ACCESS_KEY= export MINIO_SECRET_KEY= -minio --config-dir ~/tenant2 server --address :9002 http://192.168.10.11/disk1/data/tenant2 http://192.168.10.12/disk1/data/tenant2 http://192.168.10.13/disk1/data/tenant2 http://192.168.10.14/disk1/data/tenant2 +minio --config-dir ~/tenant2 server --address :9002 http://192.168.10.11/data/tenant2 http://192.168.10.12/data/tenant2 http://192.168.10.13/data/tenant2 http://192.168.10.14/data/tenant2 export MINIO_ACCESS_KEY= export MINIO_SECRET_KEY= -minio --config-dir ~/tenant3 server --address :9003 http://192.168.10.11/disk1/data/tenant3 http://192.168.10.12/disk1/data/tenant3 http://192.168.10.13/disk1/data/tenant3 http://192.168.10.14/disk1/data/tenant3 +minio --config-dir ~/tenant3 server --address :9003 http://192.168.10.11/data/tenant3 http://192.168.10.12/data/tenant3 http://192.168.10.13/data/tenant3 http://192.168.10.14/data/tenant3 ``` ![Example-3](https://github.com/minio/minio/blob/master/docs/screenshots/Example-3.jpg?raw=true) diff --git a/docs/orchestration/docker-compose/docker-compose.yaml b/docs/orchestration/docker-compose/docker-compose.yaml index 97d308713..9d1a3c192 100644 --- a/docs/orchestration/docker-compose/docker-compose.yaml +++ b/docs/orchestration/docker-compose/docker-compose.yaml @@ -11,7 +11,7 @@ services: environment: MINIO_ACCESS_KEY: minio MINIO_SECRET_KEY: minio123 - command: server http://minio1/myexport http://minio2/myexport http://minio3/myexport http://minio4/myexport + command: server http://minio1/data http://minio2/data http://minio3/data http://minio4/data minio2: image: minio/minio:RELEASE.2017-08-05T00-00-53Z ports: @@ -19,7 +19,7 @@ services: environment: MINIO_ACCESS_KEY: minio MINIO_SECRET_KEY: minio123 - command: server http://minio1/myexport http://minio2/myexport http://minio3/myexport http://minio4/myexport + command: server http://minio1/data http://minio2/data http://minio3/data http://minio4/data minio3: image: minio/minio:RELEASE.2017-08-05T00-00-53Z ports: @@ -27,7 +27,7 @@ services: environment: MINIO_ACCESS_KEY: minio MINIO_SECRET_KEY: minio123 - command: server http://minio1/myexport http://minio2/myexport http://minio3/myexport http://minio4/myexport + command: server http://minio1/data http://minio2/data http://minio3/data http://minio4/data minio4: image: minio/minio:RELEASE.2017-08-05T00-00-53Z ports: @@ -35,4 +35,4 @@ services: environment: MINIO_ACCESS_KEY: minio MINIO_SECRET_KEY: minio123 - command: server http://minio1/myexport http://minio2/myexport http://minio3/myexport http://minio4/myexport + command: server http://minio1/data http://minio2/data http://minio3/data http://minio4/data diff --git a/docs/orchestration/kubernetes-yaml/README.md b/docs/orchestration/kubernetes-yaml/README.md index b3f8b9424..3e9995cdf 100644 --- a/docs/orchestration/kubernetes-yaml/README.md +++ b/docs/orchestration/kubernetes-yaml/README.md @@ -112,7 +112,7 @@ spec: spec: # Refer to the PVC created earlier volumes: - - name: storage + - name: data persistentVolumeClaim: # Name of the PVC created earlier claimName: minio-pv-claim @@ -122,7 +122,7 @@ spec: image: minio/minio:RELEASE.2017-05-05T01-14-51Z args: - server - - /storage + - /data env: # Minio access key and secret key - name: MINIO_ACCESS_KEY @@ -134,8 +134,8 @@ spec: hostPort: 9000 # Mount the volume into the pod volumeMounts: - - name: storage # must match the volume name, above - mountPath: "/storage" + - name: data # must match the volume name, above + mountPath: "/data" ``` Create the Deployment diff --git a/docs/orchestration/kubernetes-yaml/minio-standalone-deployment.yaml b/docs/orchestration/kubernetes-yaml/minio-standalone-deployment.yaml index 4a367df8b..9bdf40da4 100644 --- a/docs/orchestration/kubernetes-yaml/minio-standalone-deployment.yaml +++ b/docs/orchestration/kubernetes-yaml/minio-standalone-deployment.yaml @@ -14,7 +14,7 @@ spec: spec: # Refer to the PVC created earlier volumes: - - name: storage + - name: data persistentVolumeClaim: # Name of the PVC created earlier claimName: minio-pv-claim @@ -24,7 +24,7 @@ spec: image: minio/minio:RELEASE.2017-08-05T00-00-53Z args: - server - - /storage + - /data env: # Minio access key and secret key - name: MINIO_ACCESS_KEY @@ -36,5 +36,5 @@ spec: hostPort: 9000 # Mount the volume into the pod volumeMounts: - - name: storage # must match the volume name, above - mountPath: "/storage" + - name: data # must match the volume name, above + mountPath: "/data" diff --git a/docs/shared-backend/DESIGN.md b/docs/shared-backend/DESIGN.md index d22d3520e..602ce75c9 100644 --- a/docs/shared-backend/DESIGN.md +++ b/docs/shared-backend/DESIGN.md @@ -21,16 +21,16 @@ Running Minio instances on shared backend is no different than running on a stan ### Ubuntu 16.04 LTS -Example 1: Start Minio instance on a shared backend mounted and available at `/mnt/nfs`. +Example 1: Start Minio instance on a shared backend mounted and available at `/path/to/nfs-volume`. On linux server1 ```shell -minio server /mnt/nfs +minio server /path/to/nfs-volume ``` On linux server2 ```shell -minio server /mnt/nfs +minio server /path/to/nfs-volume ``` ### Windows 2012 Server @@ -39,24 +39,24 @@ Example 1: Start Minio instance on a shared backend mounted and available at `\\ On windows server1 ```cmd -minio.exe server \\remote-server\cifs\export +minio.exe server \\remote-server\cifs\data ``` On windows server2 ```cmd -minio.exe server \\remote-server\cifs\export +minio.exe server \\remote-server\cifs\data ``` Alternatively if `\\remote-server\cifs` is mounted as `D:\` drive. On windows server1 ```cmd -minio.exe server D:\export +minio.exe server D:\data ``` On windows server2 ```cmd -minio.exe server D:\export +minio.exe server D:\data ``` Architecture diff --git a/docs/shared-backend/README.md b/docs/shared-backend/README.md index 1dc565f27..af3f8c5d2 100644 --- a/docs/shared-backend/README.md +++ b/docs/shared-backend/README.md @@ -31,12 +31,12 @@ To run Minio shared backend instances, you need to start multiple Minio servers #### Minio shared mode on Ubuntu 16.04 LTS. -You'll need the path to the shared volume, e.g. `/mnt/nfs`. Then run the following commands on all the nodes you'd like to launch Minio. +You'll need the path to the shared volume, e.g. `/path/to/nfs-volume`. Then run the following commands on all the nodes you'd like to launch Minio. ```sh export MINIO_ACCESS_KEY= export MINIO_SECRET_KEY= -minio server /mnt/nfs +minio server /path/to/nfs-volume ``` #### Minio shared mode on Windows 2012 Server