From 4fc9d65654f18b5a53c283c2b941cdb201317a3b Mon Sep 17 00:00:00 2001 From: robszumski Date: Wed, 15 Apr 2020 11:48:45 -0400 Subject: [PATCH 01/11] Add simple Marketplace doc --- applications/using-marketplace.adoc | 34 +++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 applications/using-marketplace.adoc diff --git a/applications/using-marketplace.adoc b/applications/using-marketplace.adoc new file mode 100644 index 000000000000..1045140c8c8c --- /dev/null +++ b/applications/using-marketplace.adoc @@ -0,0 +1,34 @@ +[id="using-marketplace"] += Using Red Hat Marketplace +include::modules/common-attributes.adoc[] + +toc::[] + +{product-title} cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started +[Red Hat Marketplace] to manage software on {product-title}, provide developers with self-service access to deploy application instances, and correlate application usage against a quota. + +== Connecting {product-title} clusters to the Marketplace + +You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Additional users can be added through the Marketplace for the Procurement department to access this data. + +A Marketplace Operator is installed to install the image registry secret, manage the on-cluster catalog and report application usage during the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process]. + +== Installing applications + +Cluster administrators can browse and link:https://marketplace.redhat.com/en-us/documentation/operators[install Marketplace applications] from within OperatorHub in {product-title} or at the link:https://marketplace.redhat.com[Marketplace web application]. + +After applications are installed, access them in the web console under *Installed Operators*. + +== Deploying an instance of an application + +Applications that you install from the Marketplace can be used in the Administrator and Developer perspectives of the web console. + +=== Using the Developer perspective + +Developers using the {product-title} cluster don’t have to concern themselves with Operator installation or usage tracking of applications. Newly installed capabilities are immediately available for use within the Developer perspective’s catalog. + +For example, once a database Operator is installed, a developer can create an instance from the catalog within their Project. Usage of the database is collected and reported in aggregate to the cluster administrator. + +=== Using the Administrator perspective + +{product-title} users can launch applications instances by browsing available CRDs within the *Installed Operators* list. \ No newline at end of file From ce57da02d486b7910fda67f2339abd8e69edfc18 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Mon, 27 Apr 2020 09:45:32 -0400 Subject: [PATCH 02/11] Restructure proposed Marketplace docs --- _topic_map.yml | 3 +++ applications/red-hat-marketplace.adoc | 10 +++++++ .../red-hat-marketplace-features.adoc | 27 +++++++++++-------- 3 files changed, 29 insertions(+), 11 deletions(-) create mode 100644 applications/red-hat-marketplace.adoc rename applications/using-marketplace.adoc => modules/red-hat-marketplace-features.adoc (72%) diff --git a/_topic_map.yml b/_topic_map.yml index 6116b2dbf179..15fafc495acd 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -866,6 +866,9 @@ Topics: - Name: Pruning objects to reclaim resources File: pruning-objects Distros: openshift-origin,openshift-enterprise,openshift-webscale +- Name: The Red Hat Marketplace + File: red-hat-marketplace + Distros: openshift-origin,openshift-enterprise,openshift-webscale --- Name: Machine management Dir: machine_management diff --git a/applications/red-hat-marketplace.adoc b/applications/red-hat-marketplace.adoc new file mode 100644 index 000000000000..bc773338efae --- /dev/null +++ b/applications/red-hat-marketplace.adoc @@ -0,0 +1,10 @@ +[id="red-hat-marketplace"] += The Red Hat Marketplace +include::modules/common-attributes.adoc[] +:context: red-hat-marketplace + +toc::[] + +{product-title} cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started[Red Hat Marketplace] to manage software on {product-title}, provide developers with self-service access to deploy application instances, and correlate application usage against a quota. + +include::modules/red-hat-marketplace-features.adoc[leveloffset=+1] \ No newline at end of file diff --git a/applications/using-marketplace.adoc b/modules/red-hat-marketplace-features.adoc similarity index 72% rename from applications/using-marketplace.adoc rename to modules/red-hat-marketplace-features.adoc index 1045140c8c8c..9a4d19cf5dae 100644 --- a/applications/using-marketplace.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -1,34 +1,39 @@ -[id="using-marketplace"] -= Using Red Hat Marketplace -include::modules/common-attributes.adoc[] +// Module included in the following assemblies: +// +// * applications/red-hat-marketplace.adoc -toc::[] +[id="red-hat-marketplace-features_{context}"] += Red Hat Marketplace features -{product-title} cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started -[Red Hat Marketplace] to manage software on {product-title}, provide developers with self-service access to deploy application instances, and correlate application usage against a quota. +Test -== Connecting {product-title} clusters to the Marketplace +[id="marketplace-clusters_{context}"] +== Connect {product-title} clusters to the Marketplace You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Additional users can be added through the Marketplace for the Procurement department to access this data. A Marketplace Operator is installed to install the image registry secret, manage the on-cluster catalog and report application usage during the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process]. -== Installing applications +[id="marketplace-install-applications_{context}"] +== Install applications Cluster administrators can browse and link:https://marketplace.redhat.com/en-us/documentation/operators[install Marketplace applications] from within OperatorHub in {product-title} or at the link:https://marketplace.redhat.com[Marketplace web application]. After applications are installed, access them in the web console under *Installed Operators*. -== Deploying an instance of an application +[id="marketplace-deploy_{context}"] +== Deploy an instance of an application Applications that you install from the Marketplace can be used in the Administrator and Developer perspectives of the web console. -=== Using the Developer perspective +[discrete] +=== The Developer perspective Developers using the {product-title} cluster don’t have to concern themselves with Operator installation or usage tracking of applications. Newly installed capabilities are immediately available for use within the Developer perspective’s catalog. For example, once a database Operator is installed, a developer can create an instance from the catalog within their Project. Usage of the database is collected and reported in aggregate to the cluster administrator. -=== Using the Administrator perspective +[discrete] +=== The Administrator perspective {product-title} users can launch applications instances by browsing available CRDs within the *Installed Operators* list. \ No newline at end of file From df2a4a5e0e6876b60442642fffe825487876faec Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Mon, 27 Apr 2020 09:49:44 -0400 Subject: [PATCH 03/11] fixup! Restructure proposed Marketplace docs --- applications/red-hat-marketplace.adoc | 2 +- modules/red-hat-marketplace-features.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/applications/red-hat-marketplace.adoc b/applications/red-hat-marketplace.adoc index bc773338efae..82efbee666e2 100644 --- a/applications/red-hat-marketplace.adoc +++ b/applications/red-hat-marketplace.adoc @@ -5,6 +5,6 @@ include::modules/common-attributes.adoc[] toc::[] -{product-title} cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started[Red Hat Marketplace] to manage software on {product-title}, provide developers with self-service access to deploy application instances, and correlate application usage against a quota. +The link:https://marketplace.redhat.com[Red Hat® Marketplace] is an open cloud marketplace that makes it easy to discover and access certified software for container-based environments in public clouds and on-prem. include::modules/red-hat-marketplace-features.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc index 9a4d19cf5dae..4c6bac4889a4 100644 --- a/modules/red-hat-marketplace-features.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -5,7 +5,7 @@ [id="red-hat-marketplace-features_{context}"] = Red Hat Marketplace features -Test +{product-title} cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started[Red Hat Marketplace] to manage software on {product-title}, provide developers with self-service access to deploy application instances, and correlate application usage against a quota. [id="marketplace-clusters_{context}"] == Connect {product-title} clusters to the Marketplace From 40b6bdbff4052f7b7cd221784830d5058cfef849 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Mon, 27 Apr 2020 11:24:05 -0400 Subject: [PATCH 04/11] Some light editing --- modules/red-hat-marketplace-features.adoc | 27 ++++++++++++++--------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc index 4c6bac4889a4..3206afe46c38 100644 --- a/modules/red-hat-marketplace-features.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -5,35 +5,42 @@ [id="red-hat-marketplace-features_{context}"] = Red Hat Marketplace features -{product-title} cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started[Red Hat Marketplace] to manage software on {product-title}, provide developers with self-service access to deploy application instances, and correlate application usage against a quota. +Cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started[Red Hat Marketplace] to manage software on {product-title}, give developers self-service access to deploy application instances, and correlate application usage against a quota. [id="marketplace-clusters_{context}"] == Connect {product-title} clusters to the Marketplace -You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Additional users can be added through the Marketplace for the Procurement department to access this data. +You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Additional users can be added +// (NOTE: added to what?) +through the Marketplace for the Procurement department to access this data. -A Marketplace Operator is installed to install the image registry secret, manage the on-cluster catalog and report application usage during the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process]. +During the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process], a +a Marketplace Operator is installed that updates the image registry secret, manages the catalog, and reports application usage. [id="marketplace-install-applications_{context}"] == Install applications -Cluster administrators can browse and link:https://marketplace.redhat.com/en-us/documentation/operators[install Marketplace applications] from within OperatorHub in {product-title} or at the link:https://marketplace.redhat.com[Marketplace web application]. +Cluster administrators can link:https://marketplace.redhat.com/en-us/documentation/operators[install Marketplace applications] from within OperatorHub in {product-title}, or at the link:https://marketplace.redhat.com[Marketplace web application]. -After applications are installed, access them in the web console under *Installed Operators*. +Access installed applications from the web console under *Installed Operators*. [id="marketplace-deploy_{context}"] -== Deploy an instance of an application +== Deploy applications from different perspectives -Applications that you install from the Marketplace can be used in the Administrator and Developer perspectives of the web console. +Deploy Marketplace applications from the web console's Administrator and Developer perspectives. [discrete] === The Developer perspective -Developers using the {product-title} cluster don’t have to concern themselves with Operator installation or usage tracking of applications. Newly installed capabilities are immediately available for use within the Developer perspective’s catalog. +Access newly installed capabilities from the Developer perspective’s catalog. -For example, once a database Operator is installed, a developer can create an instance from the catalog within their Project. Usage of the database is collected and reported in aggregate to the cluster administrator. +For example, after a database Operator is installed, a developer can create an instance from the catalog within their Project. Database usage is aggregated and reported to the cluster administrator. + +This perspective does not include Operator installation and application usage tracking. [discrete] === The Administrator perspective -{product-title} users can launch applications instances by browsing available CRDs within the *Installed Operators* list. \ No newline at end of file +The Administrator perspective includes information about Operator installation and application usage. + +{product-title} administrators can launch application instances by browsing custom resource definitions (CRDs) within the *Installed Operators* list. \ No newline at end of file From cb5558292ec5b1e020190bd86ad4bfdcd5090bba Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Fri, 1 May 2020 10:46:44 -0400 Subject: [PATCH 05/11] Attempt at removing 'Procurement' line. --- modules/red-hat-marketplace-features.adoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc index 3206afe46c38..0559051d1efa 100644 --- a/modules/red-hat-marketplace-features.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -10,9 +10,7 @@ Cluster administrators can use link:https://marketplace.redhat.com/en-us/documen [id="marketplace-clusters_{context}"] == Connect {product-title} clusters to the Marketplace -You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Additional users can be added -// (NOTE: added to what?) -through the Marketplace for the Procurement department to access this data. +You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Users that you add by using the Marketplace have their product usage tracked and billed. During the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process], a a Marketplace Operator is installed that updates the image registry secret, manages the catalog, and reports application usage. From a440620eebfe0f977f7d84b6cfd5022f84787e05 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Fri, 1 May 2020 12:03:38 -0400 Subject: [PATCH 06/11] fixup! Attempt at removing 'Procurement' line. --- modules/red-hat-marketplace-features.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc index 0559051d1efa..fb6f33287c18 100644 --- a/modules/red-hat-marketplace-features.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -10,7 +10,7 @@ Cluster administrators can use link:https://marketplace.redhat.com/en-us/documen [id="marketplace-clusters_{context}"] == Connect {product-title} clusters to the Marketplace -You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Users that you add by using the Marketplace have their product usage tracked and billed. +You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Users that you add by using the Marketplace have their product usage tracked and billed to your organization. During the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process], a a Marketplace Operator is installed that updates the image registry secret, manages the catalog, and reports application usage. From 97e8052f804f0d6216752c6e7b8c043f781130a1 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Fri, 1 May 2020 12:20:08 -0400 Subject: [PATCH 07/11] Typo fix --- modules/red-hat-marketplace-features.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc index fb6f33287c18..523815c8f9ee 100644 --- a/modules/red-hat-marketplace-features.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -12,7 +12,7 @@ Cluster administrators can use link:https://marketplace.redhat.com/en-us/documen You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Users that you add by using the Marketplace have their product usage tracked and billed to your organization. -During the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process], a +During the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process], a Marketplace Operator is installed that updates the image registry secret, manages the catalog, and reports application usage. [id="marketplace-install-applications_{context}"] From 17046bda1be2f98dd92dfc49d12b908466e5112a Mon Sep 17 00:00:00 2001 From: robszumski Date: Wed, 15 Apr 2020 11:48:45 -0400 Subject: [PATCH 08/11] Add simple Marketplace doc --- _topic_map.yml | 3 ++ applications/red-hat-marketplace.adoc | 10 ++++++ modules/red-hat-marketplace-features.adoc | 44 +++++++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 applications/red-hat-marketplace.adoc create mode 100644 modules/red-hat-marketplace-features.adoc diff --git a/_topic_map.yml b/_topic_map.yml index 6116b2dbf179..15fafc495acd 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -866,6 +866,9 @@ Topics: - Name: Pruning objects to reclaim resources File: pruning-objects Distros: openshift-origin,openshift-enterprise,openshift-webscale +- Name: The Red Hat Marketplace + File: red-hat-marketplace + Distros: openshift-origin,openshift-enterprise,openshift-webscale --- Name: Machine management Dir: machine_management diff --git a/applications/red-hat-marketplace.adoc b/applications/red-hat-marketplace.adoc new file mode 100644 index 000000000000..82efbee666e2 --- /dev/null +++ b/applications/red-hat-marketplace.adoc @@ -0,0 +1,10 @@ +[id="red-hat-marketplace"] += The Red Hat Marketplace +include::modules/common-attributes.adoc[] +:context: red-hat-marketplace + +toc::[] + +The link:https://marketplace.redhat.com[Red Hat® Marketplace] is an open cloud marketplace that makes it easy to discover and access certified software for container-based environments in public clouds and on-prem. + +include::modules/red-hat-marketplace-features.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc new file mode 100644 index 000000000000..523815c8f9ee --- /dev/null +++ b/modules/red-hat-marketplace-features.adoc @@ -0,0 +1,44 @@ +// Module included in the following assemblies: +// +// * applications/red-hat-marketplace.adoc + +[id="red-hat-marketplace-features_{context}"] += Red Hat Marketplace features + +Cluster administrators can use link:https://marketplace.redhat.com/en-us/documentation/getting-started[Red Hat Marketplace] to manage software on {product-title}, give developers self-service access to deploy application instances, and correlate application usage against a quota. + +[id="marketplace-clusters_{context}"] +== Connect {product-title} clusters to the Marketplace + +You can install a common set of applications on {product-title} clusters that you connect to the Marketplace. You can also use the Marketplace to track cluster usage against your subscriptions or quota. Users that you add by using the Marketplace have their product usage tracked and billed to your organization. + +During the link:https://marketplace.redhat.com/en-us/documentation/clusters[cluster connection process], +a Marketplace Operator is installed that updates the image registry secret, manages the catalog, and reports application usage. + +[id="marketplace-install-applications_{context}"] +== Install applications + +Cluster administrators can link:https://marketplace.redhat.com/en-us/documentation/operators[install Marketplace applications] from within OperatorHub in {product-title}, or at the link:https://marketplace.redhat.com[Marketplace web application]. + +Access installed applications from the web console under *Installed Operators*. + +[id="marketplace-deploy_{context}"] +== Deploy applications from different perspectives + +Deploy Marketplace applications from the web console's Administrator and Developer perspectives. + +[discrete] +=== The Developer perspective + +Access newly installed capabilities from the Developer perspective’s catalog. + +For example, after a database Operator is installed, a developer can create an instance from the catalog within their Project. Database usage is aggregated and reported to the cluster administrator. + +This perspective does not include Operator installation and application usage tracking. + +[discrete] +=== The Administrator perspective + +The Administrator perspective includes information about Operator installation and application usage. + +{product-title} administrators can launch application instances by browsing custom resource definitions (CRDs) within the *Installed Operators* list. \ No newline at end of file From b874b78e36ccf804a246a644e4f87a4aea21e610 Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 4 May 2020 10:23:13 -0400 Subject: [PATCH 09/11] Expanding "on-prem" --- applications/red-hat-marketplace.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/applications/red-hat-marketplace.adoc b/applications/red-hat-marketplace.adoc index 82efbee666e2..4cf98a5223a4 100644 --- a/applications/red-hat-marketplace.adoc +++ b/applications/red-hat-marketplace.adoc @@ -5,6 +5,6 @@ include::modules/common-attributes.adoc[] toc::[] -The link:https://marketplace.redhat.com[Red Hat® Marketplace] is an open cloud marketplace that makes it easy to discover and access certified software for container-based environments in public clouds and on-prem. +The link:https://marketplace.redhat.com[Red Hat® Marketplace] is an open cloud marketplace that makes it easy to discover and access certified software for container-based environments that run on public clouds and on-premesis. -include::modules/red-hat-marketplace-features.adoc[leveloffset=+1] \ No newline at end of file +include::modules/red-hat-marketplace-features.adoc[leveloffset=+1] From 0393827c3b3b45110eeb2b1684fa74583b6e6f71 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Wed, 6 May 2020 11:08:18 -0400 Subject: [PATCH 10/11] fixup! Edits from peer review --- modules/red-hat-marketplace-features.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc index 7fd016fdd118..8c18dae6bd90 100644 --- a/modules/red-hat-marketplace-features.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -30,7 +30,7 @@ You can deploy Marketplace applications from the web console's Administrator and [discrete] === The Developer perspective -You can access newly installed capabilities from the Developer perspective’s catalog. +Developers can access newly installed capabilities from the Developer perspective’s catalog. For example, after a database Operator is installed, a developer can create an instance from the catalog within their project. Database usage is aggregated and reported to the cluster administrator. From e9bb7280e6fee17349a5fb938c58cd8978d0e949 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Wed, 6 May 2020 11:17:29 -0400 Subject: [PATCH 11/11] fixup! Edits from peer review --- modules/red-hat-marketplace-features.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/red-hat-marketplace-features.adoc b/modules/red-hat-marketplace-features.adoc index 8c18dae6bd90..77cf12ef82ea 100644 --- a/modules/red-hat-marketplace-features.adoc +++ b/modules/red-hat-marketplace-features.adoc @@ -30,7 +30,7 @@ You can deploy Marketplace applications from the web console's Administrator and [discrete] === The Developer perspective -Developers can access newly installed capabilities from the Developer perspective’s catalog. +Developers can access newly installed capabilities by using the Developer perspective. For example, after a database Operator is installed, a developer can create an instance from the catalog within their project. Database usage is aggregated and reported to the cluster administrator. @@ -39,6 +39,6 @@ This perspective does not include Operator installation and application usage tr [discrete] === The Administrator perspective -The Administrator perspective includes information about Operator installation and application usage. +Cluster administrators can access Operator installation and application usage information from the Administrator perspective. -Cluster administrators can launch application instances by browsing custom resource definitions (CRDs) within the *Installed Operators* list. \ No newline at end of file +They can also launch application instances by browsing custom resource definitions (CRDs) in the *Installed Operators* list. \ No newline at end of file