Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjustments based on production testing #203

Merged
merged 3 commits into from
Jun 16, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,17 @@ You can use Operators to load the various application components and objects. Ea

.Prerequisites

* {OpenShift} ({OpenShiftShort}) version {SupportedOpenShiftVersion} or {NextSupportedOpenShiftVersion} is running.
* {OpenShift} ({OpenShiftShort}) version {SupportedOpenShiftVersion}
// TODO: add back to previous line when NextSupportedOpenShiftVersion has been tested
// or {NextSupportedOpenShiftVersion} is running.
* You have prepared your {OpenShift} ({OpenShiftShort}) environment and ensured that there is persistent storage and enough resources to run the {ProjectShort} components on top of the {OpenShiftShort} environment.


ifeval::["{build}" == "downstream"]
[IMPORTANT]
{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion} and {NextSupportedOpenShiftVersion}.

//For more information about migrating, see https://access.redhat.com/articles/5477371[Migrating Service Telemetry Framework v1.0 from OperatorSource to CatalogSource].
{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion}
// TODO: add back to previous line when OCP 4.7 has been tested and is supported
// and {NextSupportedOpenShiftVersion}.
endif::[]

.Additional resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ ifdef::context[:parent-context: {context}]

ifeval::["{build}" == "downstream"]
[IMPORTANT]
{Project} ({ProjectShort}) is compatible with {OpenShift} versions 4.5 and 4.6.
{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion}
// TODO: add back to previous line when next version is supported
// and {NextSupportedOpenShiftVersion}.

//For more information about migrating, see https://access.redhat.com/articles/5477371[Migrating Service Telemetry Framework v1.0 from OperatorSource to CatalogSource].
endif::[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ If you plan to collect and store events, collectd or Ceilometer delivers event d
Server-side {ProjectShort} monitoring infrastructure consists of the following layers:

* {Project} {ProductVersion} ({ProjectShort})
* {OpenShift} {SupportedOpenShiftVersion} ({OpenShiftShort}) or {NextSupportedOpenShiftVersion}
* {OpenShift} {SupportedOpenShiftVersion} ({OpenShiftShort})
// TODO: add back to previous line when next version is supported
// or {NextSupportedOpenShiftVersion}
* Infrastructure platform

[[osp-stf-server-side-monitoring]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ Create an OperatorGroup in the namespace so that you can schedule the Operator p

.Procedure

* Enter the following command:
* Create the STF OperatorGroup:
+
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Before you deploy {ProjectShort} on {OpenShift}, you must enable the catalog sou
+
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,18 @@
[role="_abstract"]
Before you install ElasticSearch, you must have access to the resources on the OperatorHub.io Community Catalog Source.

ifeval::["{build}" == "downstream"]
[NOTE]
All operators installed from this Catalog source are not supported by Red Hat.
All operators installed from this CatalogSource are not supported by Red Hat.
endif::[]

.Procedure

* Enter the following command:
* Enable the OperatorHub.io CatalogSource:
+
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The AMQ Certificate Manager is installed globally for all namespaces, so the `na
+
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
Expand All @@ -57,7 +57,7 @@ EOF
+
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ Before you install the Service Telemetry Operator and if you plan to store event

.Procedure

. To enable the Elastic Cloud on Kubernetes Operator, apply the following manifest to your {OpenShiftShort} environment:
. To enable the Elastic Cloud on Kubernetes Operator, create the following manifest in your {OpenShiftShort} environment:
+
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
Expand All @@ -47,12 +47,13 @@ spec:
EOF
----

. Verify that the `ClusterServiceVersion` for ElasticSearch Cloud on Kubernetes `succeeded`:
. Verify that the `ClusterServiceVersion` for ElasticSearch Cloud on Kubernetes `Succeeded`:
+
[source,options="nowrap",subs="+quotes"]
----
$ oc get csv

NAME DISPLAY VERSION REPLACES PHASE
elastic-cloud-eck.v1.2.1 Elastic Cloud on Kubernetes 1.2.1 Succeeded
NAME DISPLAY VERSION REPLACES PHASE
...
elastic-cloud-eck.v1.6.0 Elasticsearch (ECK) Operator 1.6.0 elastic-cloud-eck.v1.5.0 Succeeded
----
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ You must subscribe to the Service Telemetry Operator, which manages the {Project

.Procedure

. To create the Service Telemetry Operator subscription, enter the `oc apply -f` command:
. To create the Service Telemetry Operator subscription, enter the `oc create -f` command:
+
ifeval::["{build}" == "upstream"]
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: service-telemetry-operator
namespace: service-telemetry
spec:
channel: stable-1.2
channel: stable-1.3
installPlanApproval: Automatic
name: service-telemetry-operator
source: infrawatch-operators
Expand All @@ -51,14 +51,14 @@ endif::[]
ifeval::["{build}" == "downstream"]
[source,bash]
----
$ oc apply -f - <<EOF
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: service-telemetry-operator
namespace: service-telemetry
spec:
channel: stable-1.2
channel: stable-1.3
installPlanApproval: Automatic
name: service-telemetry-operator
source: redhat-operators
Expand Down