From da568996afdeb42c401338607ba623ffa5741422 Mon Sep 17 00:00:00 2001 From: dineshchitlangia Date: Fri, 28 Jun 2019 18:59:33 -0400 Subject: [PATCH] HDDS-1733. Fix Ozone documentation (#1031) --- hadoop-hdds/docs/content/_index.md | 6 +++--- hadoop-hdds/docs/content/beyond/Containers.md | 3 ++- hadoop-hdds/docs/content/recipe/Prometheus.md | 2 +- .../recipe}/prometheus-key-allocate.png | Bin .../{static => content/recipe}/prometheus.png | Bin hadoop-hdds/docs/content/start/_index.md | 16 ++++++++-------- 6 files changed, 14 insertions(+), 13 deletions(-) rename hadoop-hdds/docs/{static => content/recipe}/prometheus-key-allocate.png (100%) rename hadoop-hdds/docs/{static => content/recipe}/prometheus.png (100%) diff --git a/hadoop-hdds/docs/content/_index.md b/hadoop-hdds/docs/content/_index.md index 7558ce3022..bb1bf9a744 100644 --- a/hadoop-hdds/docs/content/_index.md +++ b/hadoop-hdds/docs/content/_index.md @@ -34,11 +34,11 @@ ref "JavaApi.md" >}}), [S3 protocol support] ({{< ref "S3.md" >}}), and a [command line interface] ({{< ref "shell/_index.md" >}}) which makes it easy to use Ozone. -Ozone consists of volumes, buckets, and Keys: +Ozone consists of volumes, buckets, and keys: * Volumes are similar to user accounts. Only administrators can create or delete volumes. -* Buckets are similar to directories. A bucket can contain any number of keys, but buckets cannot contain other buckets. -* Keys are similar to files. A bucket can contain any number of keys. +* Buckets are similar to directories. A bucket can contain any number of keys, but buckets cannot contain other buckets. +* Keys are similar to files. }}"> diff --git a/hadoop-hdds/docs/content/beyond/Containers.md b/hadoop-hdds/docs/content/beyond/Containers.md index 1f3390f668..b4dc94fc2e 100644 --- a/hadoop-hdds/docs/content/beyond/Containers.md +++ b/hadoop-hdds/docs/content/beyond/Containers.md @@ -202,7 +202,7 @@ Ozone related container images and source locations: docker-hadoop-runner centos jdk11,jdk8,latest - This is the base image used for testing Hadoop Ozone. + This is the base image used for testing Hadoop Ozone. This is a set of utilities that make it easy for us run ozone. @@ -211,6 +211,7 @@ Ozone related container images and source locations: https://github.com/apache/hadoop-docker-ozone ozone-build + TODO: Add more documentation here. diff --git a/hadoop-hdds/docs/content/recipe/Prometheus.md b/hadoop-hdds/docs/content/recipe/Prometheus.md index 0c0239da87..9151b318ce 100644 --- a/hadoop-hdds/docs/content/recipe/Prometheus.md +++ b/hadoop-hdds/docs/content/recipe/Prometheus.md @@ -81,7 +81,7 @@ http://localhost:9090/targets http://localhost:9090/graph?g0.range_input=1h&g0.expr=om_metrics_num_key_allocate&g0.tab=1 -![Prometheus target page example](prometheus-key-allocate.png) +![Prometheus metrics page example](prometheus-key-allocate.png) ## Note diff --git a/hadoop-hdds/docs/static/prometheus-key-allocate.png b/hadoop-hdds/docs/content/recipe/prometheus-key-allocate.png similarity index 100% rename from hadoop-hdds/docs/static/prometheus-key-allocate.png rename to hadoop-hdds/docs/content/recipe/prometheus-key-allocate.png diff --git a/hadoop-hdds/docs/static/prometheus.png b/hadoop-hdds/docs/content/recipe/prometheus.png similarity index 100% rename from hadoop-hdds/docs/static/prometheus.png rename to hadoop-hdds/docs/content/recipe/prometheus.png diff --git a/hadoop-hdds/docs/content/start/_index.md b/hadoop-hdds/docs/content/start/_index.md index 9334e55a50..5529661b0a 100644 --- a/hadoop-hdds/docs/content/start/_index.md +++ b/hadoop-hdds/docs/content/start/_index.md @@ -38,7 +38,7 @@ Kubernetes or bare-metal.

Running Ozone from Docker Hub

You can try out Ozone using docker hub without downloading the official release. This makes it easy to explore Ozone. - +
{{}} The simplest and easiest way to start an ozone cluster to explore what it can do is to start ozone via docker. @@ -54,21 +54,21 @@ You can try out Ozone using docker hub without downloading the official release.

Running Ozone from an Official Release

Apache Ozone can also be run from the official release packages. Along with the official source releases, we also release a set of convenience binary packages. It is easy to run these binaries in different configurations. - - {{}} +
+ {{}} Ozone is designed to work concurrently with HDFS. The physical cluster instructions explain each component of Ozone and how to deploy with maximum control. {{}} - {{}} -Ozone is designed to work well under Kubernetes. These are instructions on how to deploy Ozone on K8s platform. Ozone provides a replicated storage solution for K8s based Applications. + {{}} +Ozone is designed to work well under Kubernetes. These are instructions to deploy Ozone on K8s. Ozone provides a replicated storage solution for K8s based apps. {{}} - {{}} + {{}} Ozone comes with a standard set of K8s resources. You can deploy them to MiniKube and experiment with the K8s based deployments. {{}} - {{}} - We also ship standard docker files with official release, if you want to use them. These are part of official release and not depend upon Docker Hub. + {{}} + We also ship standard docker files with official release. These are part of official release and not depend upon Docker Hub. {{}}