From 3457e504cf599db90d4d480d495e0633b258fdc1 Mon Sep 17 00:00:00 2001 From: Eco <41090896+eco-minio@users.noreply.github.com> Date: Wed, 17 Oct 2018 10:55:55 -0700 Subject: [PATCH] Spelling changes and fixed link (#6596) --- docs/bucket/notifications/README.md | 2 +- docs/config/README.md | 6 +++--- docs/disk-caching/DESIGN.md | 2 +- docs/disk-caching/README.md | 2 +- docs/distributed/README.md | 29 ++--------------------------- docs/docker/README.md | 2 +- docs/gateway/gcs.md | 2 +- docs/orchestration/README.md | 2 +- docs/tls/README.md | 2 +- 9 files changed, 12 insertions(+), 37 deletions(-) diff --git a/docs/bucket/notifications/README.md b/docs/bucket/notifications/README.md index c224ed494..48b595ed9 100644 --- a/docs/bucket/notifications/README.md +++ b/docs/bucket/notifications/README.md @@ -409,7 +409,7 @@ This notification target supports two formats: _namespace_ and _access_. When the _namespace_ format is used, Minio synchronizes objects in the bucket with entries in a hash. For each entry, the key is formatted as "bucketName/objectName" for an object that exists in the bucket, and the value is the JSON-encoded event data about the operation that created/replaced the object in Minio. When objects are updated or deleted, the corresponding entry in the hash is also updated or deleted. -When the _access_ format is used, Minio appends events to a list using [RPUSH](https://redis.io/commands/rpush). Each item in the list is a JSON encoded list with two items, where the first item is a timestamp string, and second item is a JSON object containing evnet data about the operation that happened in the bucket. No entries appended to the list are updated or deleted by Minio in this format. +When the _access_ format is used, Minio appends events to a list using [RPUSH](https://redis.io/commands/rpush). Each item in the list is a JSON encoded list with two items, where the first item is a timestamp string, and the second item is a JSON object containing event data about the operation that happened in the bucket. No entries appended to the list are updated or deleted by Minio in this format. The steps below show how to use this notification target in `namespace` and `access` format. diff --git a/docs/config/README.md b/docs/config/README.md index 22a5dec58..742c64af5 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -25,13 +25,14 @@ $ tree ~/.minio │   └── public.crt ``` + ### Accessing configuration file All configuration changes can be made using [`mc admin config` get/set commands](https://github.com/minio/mc/blob/master/docs/minio-admin-complete-guide.md). Following sections provide brief explanation of fields and how to customize them. A complete example of `config.json` is available [here](https://raw.githubusercontent.com/minio/minio/master/docs/config/config.sample.json) #### Editing configuration file fields -Configuration changes should be done using [mc]((https://docs.minio.io/docs/minio-client-quickstart-guide)) + ##### Get current configuration for Minio deployment @@ -144,8 +145,7 @@ minio server /data ### Domain -By default, Minio supports path-style requests which look like http://mydomain.com/bucket/object. MINIO_DOMAIN environmental variable is used to enable virtual-host-style requests. If the request `Host` header matches with `(.+).mydomain.com` then the mattched pattern `$1` is used as bucket and the path is used as object. More information on path-style and virtual-host-style [here](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAPI.html) - +By default, Minio supports path-style requests that are of the format http://mydomain.com/bucket/object. MINIO_DOMAIN environment variable is used to enable virtual-host-style requests. If the request `Host` header matches with `(.+).mydomain.com` then the matched pattern `$1` is used as bucket and the path is used as object. More information on path-style and virtual-host-style [here](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAPI.html) Example: ```sh diff --git a/docs/disk-caching/DESIGN.md b/docs/disk-caching/DESIGN.md index c83aa2ade..ab9ed1ea9 100644 --- a/docs/disk-caching/DESIGN.md +++ b/docs/disk-caching/DESIGN.md @@ -18,7 +18,7 @@ minio server -h 7. Start minio server with edge caching enabled on '/mnt/drive1', '/mnt/drive2' and '/mnt/export1 ... /mnt/export24', exclude all objects under 'mybucket', exclude all objects with '.pdf' as extension - with expiry upto 40 days. + with expiry up to 40 days. $ export MINIO_CACHE_DRIVES="/mnt/drive1;/mnt/drive2;/mnt/export{1..24}" $ export MINIO_CACHE_EXCLUDE="mybucket/*;*.pdf" $ export MINIO_CACHE_EXPIRY=40 diff --git a/docs/disk-caching/README.md b/docs/disk-caching/README.md index e3482ff10..a2bea8d52 100644 --- a/docs/disk-caching/README.md +++ b/docs/disk-caching/README.md @@ -30,7 +30,7 @@ After updating the cache configuration in /tmp/myconfig , use `mc admin config s ```sh $ mc admin config set myminio < /tmp/myconfig ``` -The cache settings may also be set through environment variables. When set, environment variables override any `cache` config settings for Minio server. Following example uses `/mnt/drive1`, `/mnt/drive2` ,`/mnt/cache1` ... `/mnt/cache3` for caching, with expiry upto 90 days while excluding all objects under bucket `mybucket` and all objects with '.pdf' as extension while starting a standalone erasure coded setup. Cache max usage is restricted to 80% of disk capacity in this example. +The cache settings may also be set through environment variables. When set, environment variables override any `cache` config settings for Minio server. Following example uses `/mnt/drive1`, `/mnt/drive2` ,`/mnt/cache1` ... `/mnt/cache3` for caching, with expiry up to 90 days while excluding all objects under bucket `mybucket` and all objects with '.pdf' as extension while starting a standalone erasure coded setup. Cache max usage is restricted to 80% of disk capacity in this example. ```bash export MINIO_CACHE_DRIVES="/mnt/drive1;/mnt/drive2;/mnt/cache{1...3}" diff --git a/docs/distributed/README.md b/docs/distributed/README.md index 9c3faa4c3..0d90e988e 100644 --- a/docs/distributed/README.md +++ b/docs/distributed/README.md @@ -43,7 +43,7 @@ To start a distributed Minio instance, you just need to pass drive locations as *Note* - All the nodes running distributed Minio need to have same access key and secret key for the nodes to connect. To achieve this, it is **mandatory** to export access key and secret key as environment variables, `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY`, on all the nodes before executing Minio server command. -- All the nodes running distributed Minio need to be on homogenous environments i.e same operating system, same number of disks and same interconnects. +- All the nodes running distributed Minio need to be in a homogeneous environment, i.e. same operating system, same number of disks and same interconnects. - `MINIO_DOMAIN` environment variable should be defined and exported if domain is needed to be set. - Minio distributed mode requires fresh directories. If required, the drives can be shared with other applications. You can do this by using a sub-directory exclusive to minio. For example, if you have mounted your volume under `/export`, pass `/export/data` as arguments to Minio server. - The IP addresses and drive paths below are for demonstration purposes only, you need to replace these with the actual IP addresses and drive paths/folders. @@ -60,31 +60,6 @@ export MINIO_SECRET_KEY= minio server http://192.168.1.1{1...8}/export1 ``` -#### Windows (experimental) - -```cmd -set MINIO_ACCESS_KEY= -set MINIO_SECRET_KEY= -minio.exe server http://192.168.1.1{1...8}/C:/data -``` - - -Example 2: Start distributed Minio instance on 4 nodes with 4 disks (pictured below), by running this command on all the 4 nodes: -![Distributed Minio, 4 nodes with 4 disks each](https://github.com/minio/minio/blob/master/docs/screenshots/Architecture-diagram_distributed_16.jpg?raw=true) - -#### GNU/Linux and macOS -```sh -export MINIO_ACCESS_KEY= -export MINIO_SECRET_KEY= -minio server http://192.168.1.1{1...4}/export{1...4} -``` - -#### Windows (experimental) -```cmd -set MINIO_ACCESS_KEY= -set MINIO_SECRET_KEY= -minio.exe server http://192.168.1.1{1...4}/C:/data{1...4} -``` __NOTE:__ `{1...n}` shown have 3 dots! Using only 2 dots `{1..4}` will be interpreted by your shell and won't be passed to minio server, affecting the erasure coding order, which may impact performance and high availability. __Always use `{1...n}` (3 dots!) to allow minio server to optimally erasure-code data__ @@ -92,7 +67,7 @@ __NOTE:__ `{1...n}` shown have 3 dots! Using only 2 dots `{1..4}` will be interp To test this setup, access the Minio server via browser or [`mc`](https://docs.minio.io/docs/minio-client-quickstart-guide). ## Explore Further -- [Minio Large Bucket Suppport Guide](https://docs.minio.io/docs/minio-large-bucket-support-quickstart-guide) +- [Minio Large Bucket Support Guide](https://docs.minio.io/docs/minio-large-bucket-support-quickstart-guide) - [Minio Erasure Code QuickStart Guide](https://docs.minio.io/docs/minio-erasure-code-quickstart-guide) - [Use `mc` with Minio Server](https://docs.minio.io/docs/minio-client-quickstart-guide) - [Use `aws-cli` with Minio Server](https://docs.minio.io/docs/aws-cli-with-minio) diff --git a/docs/docker/README.md b/docs/docker/README.md index fb6947814..6c0e26991 100644 --- a/docs/docker/README.md +++ b/docs/docker/README.md @@ -74,7 +74,7 @@ docker service create --name="minio-service" --secret="access_key" --secret="sec Read more about `docker service` [here](https://docs.docker.com/engine/swarm/how-swarm-mode-works/services/) #### Minio Custom Access and Secret Key files -To use other secret names follow the instuctions above and replace `access_key` and `secret_key` with your custom names (e.g. `my_secret_key`,`my_custom_key`). Run your service with +To use other secret names follow the instructions above and replace `access_key` and `secret_key` with your custom names (e.g. `my_secret_key`,`my_custom_key`). Run your service with ``` docker service create --name="minio-service" \ --secret="my_access_key" \ diff --git a/docs/gateway/gcs.md b/docs/gateway/gcs.md index f54c00b0c..e95065563 100644 --- a/docs/gateway/gcs.md +++ b/docs/gateway/gcs.md @@ -8,7 +8,7 @@ Minio GCS Gateway adds Amazon S3 compatibility to Google Cloud Storage. 3. On the Credentials page, select the __Create credentials__ drop-down, then select __Service account key__. 4. From the __Service account__ drop-down, select __New service account__ 5. Fill up __Service account name__ and __Service account ID__ -6. For the __Role__, click the selec dropdown to choose __Storage__ -> __Storage Admin__ _(Full control of GCS resources)_ +6. For the __Role__, click the select dropdown to choose __Storage__ -> __Storage Admin__ _(Full control of GCS resources)_ 7. Click the __Create__ button. This will download a credentials file to your desktop. Let's call this credentials.json Note: Alternate ways to setup *Application Default Credentials* is explained [here](https://developers.google.com/identity/protocols/application-default-credentials) diff --git a/docs/orchestration/README.md b/docs/orchestration/README.md index a43d53e20..99b775a6e 100644 --- a/docs/orchestration/README.md +++ b/docs/orchestration/README.md @@ -14,7 +14,7 @@ The term cloud-native revolves around the idea of applications deployed as micro While containers provide isolated application execution environment, orchestration platforms allow seamless scaling by helping replicate and manage containers. Minio extends this by adding isolated storage environment for each tenant. -Minio is built ground up on the cloud-native premise. With features like erasure-coding, distributed and shared setup, it focusses only on storage and does it very well. While, it can be scaled by just replicating Minio instances per tenant via an orchestration platform. +Minio is built ground up on the cloud-native premise. With features like erasure-coding, distributed and shared setup, it focuses only on storage and does it very well. While, it can be scaled by just replicating Minio instances per tenant via an orchestration platform. > In a cloud-native environment, scalability is not a function of the application but the orchestration platform. diff --git a/docs/tls/README.md b/docs/tls/README.md index 0571d6880..408da72eb 100644 --- a/docs/tls/README.md +++ b/docs/tls/README.md @@ -168,7 +168,7 @@ ip_address = "127.0.0.1" tls_www_server # Whether this certificate will be used to encrypt data (needed -# in TLS RSA ciphersuites). Note that it is preferred to use different +# in TLS RSA cipher suites). Note that it is preferred to use different # keys for encryption and signing. encryption_key ```