big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

HDDS-990. Typos in Ozone doc.

Browse Source 
Contributed by Doroszlai, Attila.
This commit is contained in:
Nanda kumar 2019-01-25 12:17:36 +05:30
parent 45c4cfe790
commit 2181b18850
7 changed files with 39 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
hadoop-hdds/docs/content/BucketCommands.md
View File

@ -32,7 +32,7 @@ Ozone shell supports the following bucket commands.
### Create
The bucket create command allows a user to create a bucket.
The bucket create command allows users to create a bucket.
***Params:***
@ -49,7 +49,7 @@ Since no scheme was specified this command defaults to O3 (RPC) protocol.
### Delete
The bucket delete commands allows an user to delete a volume. If the
The bucket delete command allows users to delete a bucket. If the
bucket is not empty then this command will fail.
***Params:***
@ -59,7 +59,7 @@ bucket is not empty then this command will fail.
| Uri | The name of the bucket
{{< highlight bash >}}
ozone sh volume delete /hive/jan
ozone sh bucket delete /hive/jan
{{< /highlight >}}
The above command will delete _jan_ bucket if it is empty.
@ -81,7 +81,7 @@ The above command will print out the information about _jan_ bucket.
### List
The bucket list commands allows uset to list the buckets in a volume.
The bucket list command allows users to list the buckets in a volume.
***Params:***

17
hadoop-hdds/docs/content/Dozone.md
View File

@ -23,7 +23,7 @@ menu:
limitations under the License.
-->
Dozone stands for docker for ozone. Ozone supports docker to make it easy to develop and test ozone. Starting a docker based ozone container is simple.
Dozone stands for docker for ozone. Ozone supports docker to make it easy to develop and test ozone. Starting a docker-based ozone container is simple.
In the `compose/ozone` directory there are two files that define the docker and ozone settings.
@ -41,13 +41,13 @@ docker-compose up -d
to run a ozone cluster on docker.
This command will launch a Namenode, OM, SCM and a data node.
This command will launch OM, SCM and a data node.
To access the OM UI, one can run 'http://localhost:9874'.
To access the OM UI, one can view http://localhost:9874.
_Please note_: dozone does not map the data node ports to the 9864. Instead, it maps to the ephemeral port range. So many examples in the command shell will not work if you run those commands from the host machine. To find out where the data node port is listening, you can run the `docker ps` command or always ssh into a container before running ozone commands.
To shutdown a running docker based ozone cluster, please run
To shutdown a running docker-based ozone cluster, please run
{{< highlight bash >}}
docker-compose down
@ -63,7 +63,7 @@ Useful Docker & Ozone Commands
If you make any modifications to ozone, the simplest way to test it is to run freon and unit tests.
Here are the instructions to run freon in a docker based cluster.
Here are the instructions to run freon in a docker-based cluster.
{{< highlight bash >}}
docker-compose exec datanode bash
@ -76,7 +76,7 @@ Now we can execute freon for load generation.
ozone freon randomkeys --numOfVolumes=10 --numOfBuckets 10 --numOfKeys 10
{{< /highlight >}}
Here is a set helpful commands while working with docker for ozone.
Here is a set of helpful commands for working with docker for ozone.
To check the status of the components:
{{< highlight bash >}}
@ -93,9 +93,8 @@ docker-compose logs scm
As the WebUI ports are forwarded to the external machine, you can check the web UI:
* For the Storage Container Manager: http://localhost:9876
* For the Ozone Managerr: http://localhost:9874
* For the Datanode: check the port with docker ps (as there could be multiple data node ports are mapped to the ephemeral port range)
* For the Namenode: http://localhost:9870
* For the Ozone Manager: http://localhost:9874
* For the Datanode: check the port with `docker ps` (as there could be multiple data nodes, ports are mapped to the ephemeral port range)
You can start multiple data nodes with:

32
hadoop-hdds/docs/content/JavaApi.md
View File

@ -25,8 +25,8 @@ menu:
Introduction
-------------
Ozone ships with it own client library, that supports both RPC(Remote
Procedure call) and REST(Representational State Transfer). This library is
Ozone ships with its own client library that supports both RPC (Remote
Procedure Call) and REST (Representational State Transfer). This library is
the primary user interface to ozone.
It is trivial to switch from RPC to REST or vice versa, by setting the
@ -77,10 +77,10 @@ An object store represents an active cluster against which the client is working
{{< highlight java >}}
// Let us create a volume to store our game assets.
// This uses default arguments for creating that volume.
objectStore.createVolume(“assets”);
objectStore.createVolume("assets");
// Let us verify that the volume got created.
OzoneVolume assets = objectStore.getVolume(“assets”);
OzoneVolume assets = objectStore.getVolume("assets");
{{< /highlight >}}
@ -92,8 +92,8 @@ Once you have a volume, you can create buckets inside the volume.
{{< highlight bash >}}
// Let us create a bucket called videos.
assets.createBucket(“videos”);
Ozonebucket video = assets.getBucket(“videos”);
assets.createBucket("videos");
OzoneBucket video = assets.getBucket("videos");
{{< /highlight >}}
At this point we have a usable volume and a bucket. Our volume is called assets and bucket is called videos.
@ -106,10 +106,10 @@ With a bucket object the users can now read and write keys. The following code r
{{< highlight bash >}}
// read data from the file, this is a user provided function.
byte [] vidoeData = readFile(“into.mp4”);
byte [] videoData = readFile("intro.mp4");
// Create an output stream and write data.
OzoneOutputStream videoStream = video.createKey(“intro.mp4”, 1048576);
OzoneOutputStream videoStream = video.createKey("intro.mp4", 1048576);
videoStream.write(videoData);
// Close the stream when it is done.
@ -119,7 +119,7 @@ videoStream.write(videoData);
// We can use the same bucket to read the file that we just wrote, by creating an input Stream.
// Let us allocate a byte array to hold the video first.
byte[] data = new byte[(int)1048576];
OzoneInputStream introStream = video.readKey(“intro.mp4”);
OzoneInputStream introStream = video.readKey("intro.mp4");
// read intro.mp4 into the data buffer
introStream.read(data);
introStream.close();
@ -137,20 +137,20 @@ ObjectStore objectStore = ozClient.getObjectStore();
// Let us create a volume to store our game assets.
// This default arguments for creating that volume.
objectStore.createVolume(“assets”);
objectStore.createVolume("assets");
// Let us verify that the volume got created.
OzoneVolume assets = objectStore.getVolume(“assets”);
OzoneVolume assets = objectStore.getVolume("assets");
// Let us create a bucket called videos.
assets.createBucket(“videos”);
Ozonebucket video = assets.getBucket(“videos”);
assets.createBucket("videos");
OzoneBucket video = assets.getBucket("videos");
// read data from the file, this is assumed to be a user provided function.
byte [] vidoeData = readFile(“into.mp4”);
byte [] videoData = readFile("intro.mp4");
// Create an output stream and write data.
OzoneOutputStream videoStream = video.createKey(“intro.mp4”, 1048576);
OzoneOutputStream videoStream = video.createKey("intro.mp4", 1048576);
videoStream.write(videoData);
// Close the stream when it is done.
@ -161,7 +161,7 @@ videoStream.write(videoData);
// Let us allocate a byte array to hold the video first.
byte[] data = new byte[(int)1048576];
OzoneInputStream introStream = video.readKey(“into.mp4”);
OzoneInputStream introStream = video.readKey("intro.mp4");
introStream.read(data);
// Close the stream when it is done.

6
hadoop-hdds/docs/content/KeyCommands.md
View File

@ -69,7 +69,7 @@ The above command will put the sales.orc as a new key into _/hive/jan/corrected-
### Delete
The delete key command removes the key from the bucket.
The key delete command removes the key from the bucket.
***Params:***
@ -102,7 +102,7 @@ key.
### List
The key list commands allows user to list all keys in a bucket.
The key list command allows user to list all keys in a bucket.
***Params:***
@ -117,7 +117,7 @@ The key list commands allows user to list all keys in a bucket.
ozone sh key list /hive/jan
{{< /highlight >}}
This command will list all key in the bucket _/hive/jan_.
This command will list all keys in the bucket _/hive/jan_.

2
hadoop-hdds/docs/content/Rest.md
View File

@ -219,7 +219,7 @@ this request gets all volumes owned by *bilbo* and each volume's name contains p
### Create Bucket
This API allows an user to create a bucket in a volume.
This API allows users to create a bucket in a volume.
Schema:

6
hadoop-hdds/docs/content/S3.md
View File

@ -54,7 +54,7 @@ By default it uses the path-style addressing. To use virtual host style URLs set
## Bucket browser
Bucket's could be browsed from the browser with adding `?browser=true` to the bucket URL.
Buckets could be browsed from the browser by adding `?browser=true` to the bucket URL.
For example the content of the 'testbucket' could be checked from the browser using the URL http://localhost:9878/testbucket?browser=true
@ -92,7 +92,7 @@ HEAD Object | implemented |
Security is not yet implemented, you can *use* any AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
Note: Ozone has a notion for 'volumes' which is missing from the S3 Rest endpoint. Under the hood S3 bucket names are mapped to Ozone 'volume/bucket' locations (depending from the given authentication information).
Note: Ozone has a notion for 'volumes' which is missing from the S3 Rest endpoint. Under the hood S3 bucket names are mapped to Ozone 'volume/bucket' locations (depending on the given authentication information).
To show the storage location of a S3 bucket, use the `ozone sh bucket path <bucketname>` command.
@ -122,7 +122,7 @@ aws s3 ls --endpoint http://localhost:9878 s3://buckettest
### S3 Fuse driver (goofys)
Goofys is a S3 FUSE driver. It could be used to any mount any Ozone bucket as posix file system:
Goofys is a S3 FUSE driver. It could be used to mount any Ozone bucket as posix file system:
```

2
hadoop-hdds/docs/content/VolumeCommands.md
View File

@ -52,7 +52,7 @@ volume has a quota of 1TB, and the owner is _bilbo_.
### Delete
The volume delete commands allows an administrator to delete a volume. If the
The volume delete command allows an administrator to delete a volume. If the
volume is not empty then this command will fail.
***Params:***