From 7a6ce0d4c8d458dfbd12c8efc56cc7675c8a6b3e Mon Sep 17 00:00:00 2001 From: Kevin Lamenzo Date: Thu, 12 Sep 2019 13:48:06 -0400 Subject: [PATCH] minor clean up for metering docs --- _topic_map.yml | 2 ++ .../metering-configure-persistent-storage.adoc | 2 +- metering/metering-about-installing-metering.adoc | 6 ++++++ metering/metering-installing-metering.adoc | 7 ++++--- modules/metering-about-install.adoc | 4 ++-- 5 files changed, 15 insertions(+), 6 deletions(-) diff --git a/_topic_map.yml b/_topic_map.yml index 312136f376..f7fb79befd 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -816,6 +816,8 @@ Topics: File: metering-about-reports - Name: Using metering File: metering-using-metering +- Name: Troubleshooting and debugging + File: metering-troubleshooting-debugging --- Name: Telemetry Dir: telemetry diff --git a/metering/configuring-metering/metering-configure-persistent-storage.adoc b/metering/configuring-metering/metering-configure-persistent-storage.adoc index ec6302d7a2..aa2ef002c6 100644 --- a/metering/configuring-metering/metering-configure-persistent-storage.adoc +++ b/metering/configuring-metering/metering-configure-persistent-storage.adoc @@ -1,5 +1,5 @@ [id="metering-configure-persistent-storage"] -= Configuring Persistent Storage += Configuring persistent storage include::modules/common-attributes.adoc[] :context: metering diff --git a/metering/metering-about-installing-metering.adoc b/metering/metering-about-installing-metering.adoc index df70e8facc..31fa686a3e 100644 --- a/metering/metering-about-installing-metering.adoc +++ b/metering/metering-about-installing-metering.adoc @@ -10,3 +10,9 @@ Before installing Metering into your cluster, review the following sections. include::modules/metering-about-install.adoc[leveloffset=+1] include::modules/metering-install-prerequisites.adoc[leveloffset=+1] + +== Additional Resources + +* For more information on configuration steps and available storage platforms, see xref:../../metering/configuring-metering/metering-configure-persistent-storage.adoc#metering-configure-persistent-storage[Configuring persistent storage]. + +* For the steps to configure Hive, see xref:../../metering/configuring-metering/metering-configure-hive-metastore.adoc#metering-configure-hive-metastore[Configuring the Hive metastore]. diff --git a/metering/metering-installing-metering.adoc b/metering/metering-installing-metering.adoc index 469cc65ec5..f80b89a4cb 100644 --- a/metering/metering-installing-metering.adoc +++ b/metering/metering-installing-metering.adoc @@ -18,12 +18,13 @@ To install the metering stack, create a `MeteringConfig` resource and add your c Before creating your `MeteringConfig`: * Review the installation options in xref:../metering/metering-about-installing-metering.adoc#metering-about-install_about-installing-metering[About installing metering] +* At a minimum, you need to xref:../metering/configuring-metering/metering-configure-persistent-storage.adoc#metering-configure-persistent-storage[configure persistent storage] and xref:../metering/configuring-metering/metering-configure-hive-metastore.adoc#metering-configure-hive-metastore[configure the Hive metastore]. -After entering you configuration details, the MeteringConfig resource installs all the necessary metering components inside the openshift-metering namespace. +After entering your configuration details, the `MeteringConfig` resource installs all the necessary metering components inside the openshift-metering namespace. [IMPORTANT] ==== -There can only be one MeteringConfig resource in the `openshift-metering` namespace. Any other configuration is not supported. +There can only be one `MeteringConfig` resource in the `openshift-metering` namespace. Any other configuration is not supported. ==== .Procedure @@ -40,7 +41,7 @@ You can review example configuration files and all supported configuration optio . Enter your configuration details into the YAML editor and click *Create*. -The MeteringConfig resource will beging to create the necessary resources for your metering stack. You can now move on to verifying your installation. +The `MeteringConfig` resource begins to create the necessary resources for your metering stack. You can now move on to verifying your installation. [id="metering-install-verify_{context}"] == Verify Installation diff --git a/modules/metering-about-install.adoc b/modules/metering-about-install.adoc index cd56bfbb72..b077e8ea6f 100644 --- a/modules/metering-about-install.adoc +++ b/modules/metering-about-install.adoc @@ -6,5 +6,5 @@ = About Installing Metering Metering leverages a SQL database called Presto. -Presto itself does not actually store the data itself; instead its storage is decoupled from it, often in the form of object storage. -This means, at a minimum, you need to configure persistent storage to hold reporting data, and the Hive metastore to hold metadata about database tables managed by Presto and Hive. +Presto does not store the data itself. Instead, its storage is decoupled from it, often in the form of object storage. +This means at a minimum you need to configure persistent storage to hold reporting data, and the Hive metastore to hold metadata about database tables managed by Presto and Hive.