diff --git a/_topic_map.yml b/_topic_map.yml index 41fbcb0cd1..79cfca2bf3 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1011,8 +1011,6 @@ Distros: openshift-enterprise,openshift-origin Topics: - Name: About metering File: metering-about-metering -- Name: About installing metering - File: metering-about-installing-metering - Name: Installing metering File: metering-installing-metering - Name: Configuring metering diff --git a/metering/metering-about-installing-metering.adoc b/metering/metering-about-installing-metering.adoc deleted file mode 100644 index 3dcaf03eab..0000000000 --- a/metering/metering-about-installing-metering.adoc +++ /dev/null @@ -1,25 +0,0 @@ -[id="metering-about-installing-metering"] -= About installing Metering -include::modules/common-attributes.adoc[] -:context: metering-about-installing-metering - -toc::[] - -Before installing metering into your cluster, review the following sections. - -[WARNING] -==== -Installing Metering on an Openshift FIPS-enabled cluster with TLS enabled will fail while attempting to generate TLS certificates for the user. - -See link:https://bugzilla.redhat.com/show_bug.cgi?id=1787745[BZ#1787745] for details. -==== - -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 40df66e754..dfaec5764a 100644 --- a/metering/metering-installing-metering.adoc +++ b/metering/metering-installing-metering.adoc @@ -5,9 +5,18 @@ include::modules/common-attributes.adoc[] toc::[] -On {product-title} 4 clusters, metering can be installed through OperatorHub. If you are using an earlier version of {product-title} or a Kubernetes cluster without OpenShift, use the link:https://github.com/operator-framework/operator-metering/tree/master/Documentation[upstream documentation] to install, configure, and use metering. +Review the the following sections before installing metering into your cluster. -To get started installing metering, first install the Metering Operator from OperatorHub. Next, configure your instance of metering by creating a `CustomResource`, referred to here as your MeteringConfig. The installation process creates a default MeteringConfig that you can modify using the examples in the documentation. After creating your MeteringConfig, install the metering stack. Last, verify your installation. +[WARNING] +==== +Installing Metering on an {product-title} cluster that uses FIPS validated / Implementation Under Test cryptographic libraries with TLS will fail while attempting to generate TLS certificates for the user. + +See link:https://bugzilla.redhat.com/show_bug.cgi?id=1787745[BZ#1787745] for details. +==== + +To get started installing metering, first install the Metering Operator from OperatorHub. Next, configure your instance of metering by creating a `CustomResource`, referred to here as your MeteringConfig. Installing the Metering Operator creates a default MeteringConfig that you can modify using the examples in the documentation. After creating your MeteringConfig, install the metering stack. Last, verify your installation. + +include::modules/metering-install-prerequisites.adoc[leveloffset=+1] include::modules/metering-install-operator.adoc[leveloffset=+1] @@ -22,7 +31,6 @@ After adding the Metering Operator to your cluster you can install the component * Review the xref:../metering/configuring-metering/metering-about-configuring.adoc#metering-about-configuring[configuration options] * Create a MeteringConfig resource. You can begin the following process to generate a default MeteringConfig, then use the examples in the documentation to modify this default file for your specific installation. Review the following topics to create your MeteringConfig resource: -** For prerequisites and general requirements, review the installation options in xref:../metering/metering-about-installing-metering.adoc#metering-about-installing-metering[About installing metering]. ** For configuration options, review xref:../metering/configuring-metering/metering-about-configuring.adoc#metering-about-configuring[About configuring 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]. @@ -47,3 +55,11 @@ For example configuration files and all supported configuration options, review The MeteringConfig resource begins to create the necessary resources for your metering stack. You can now move on to verifying your installation. include::modules/metering-install-verify.adoc[leveloffset=+1] + +[id="metering-install-additional-resources_{context}"] +== 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-troubleshooting-debugging.adoc b/metering/metering-troubleshooting-debugging.adoc index 4913e988db..480c902f5b 100644 --- a/metering/metering-troubleshooting-debugging.adoc +++ b/metering/metering-troubleshooting-debugging.adoc @@ -9,7 +9,7 @@ Use the following sections to help troubleshoot and debug specific issues with m In addition to the information in this section, be sure to review the following topics: -* xref:../metering/metering-about-installing-metering.adoc#metering-install-prerequisites_metering-about-installing-metering[Prerequities for installing metering]. +* xref:../metering/metering-installing-metering.adoc#metering-install-prerequisites_installing-metering[Prerequities for installing metering]. * xref:../metering/configuring-metering/metering-about-configuring.adoc#metering-about-configuring[About configuring metering] include::modules/metering-troubleshooting.adoc[leveloffset=+1] diff --git a/modules/metering-about-install.adoc b/modules/metering-about-install.adoc deleted file mode 100644 index b077e8ea6f..0000000000 --- a/modules/metering-about-install.adoc +++ /dev/null @@ -1,10 +0,0 @@ -// Module included in the following assemblies: -// -// * metering/metering-installing-metering.adoc - -[id="metering-about-install_{context}"] -= About Installing Metering - -Metering leverages a SQL database called Presto. -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. diff --git a/modules/metering-overview.adoc b/modules/metering-overview.adoc index 2349b4c9c3..e910555c5d 100644 --- a/modules/metering-overview.adoc +++ b/modules/metering-overview.adoc @@ -12,6 +12,9 @@ You can either write your own, or use predefined SQL queries to define how you w Metering focuses primarily on in-cluster metric data using Prometheus as a default data source, enabling users of metering to do reporting on pods, namespaces, and most other Kubernetes resources. +You can install metering on {product-title} 4.x clusters and above. + +[id="metering-resources_{context}"] == Metering resources Metering has many resources which can be used to manage the deployment and installation of metering, as well as the reporting functionality metering provides.