Skip to content
Merged
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can use Operators to load the {Project} ({ProjectShort}) components and obje

ifeval::["{build}" == "downstream"]
[IMPORTANT]
{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} through to {NextSupportedOpenShiftVersion}.
{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} through to {NextSupportedOpenShiftVersion}.
endif::[]

.Additional resources
Expand All @@ -33,19 +33,6 @@ endif::[]
include::../modules/proc_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1]


include::../modules/proc_creating-a-namespace.adoc[leveloffset=+2]
include::../modules/proc_creating-an-operatorgroup.adoc[leveloffset=+2]
include::../modules/proc_enabling-the-operatorhub-io-community-catalog-source.adoc[leveloffset=+2]
//upstream module only
ifeval::["{build}" == "upstream"]
include::../modules/proc_enabling-infrawatch-catalog-source.adoc[leveloffset=+2]
endif::[]
include::../modules/proc_subscribing-to-the-amq-certificate-manager-operator.adoc[leveloffset=+2]
include::../modules/proc_subscribing-to-the-elastic-cloud-on-kubernetes-operator.adoc[leveloffset=+2]
include::../modules/proc_subscribing-to-the-service-telemetry-operator.adoc[leveloffset=+2]



include::../modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc[leveloffset=+1]
include::../modules/con_primary-parameters-of-the-servicetelemetry-object.adoc[leveloffset=+2]
include::../modules/proc_removing-stf-from-the-openshift-environment.adoc[leveloffset=+1]
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,196 @@
= Deploying {Project} to the {OpenShift} environment

[role="_abstract"]
To deploy {ProjectShort} to collect, store, and monitor events, complete the following procedures:
Deploy {Project} ({ProjectShort}) to collect, store, and monitor events:



.Procedure

. xref:creating-a-namespace_assembly-installing-the-core-components-of-stf[Creating a namespace].
. xref:creating-an-operatorgroup_assembly-installing-the-core-components-of-stf[Creating an OperatorGroup].
. xref:enabling-the-operatorhub-io-community-catalog-source_assembly-installing-the-core-components-of-stf[Enabling the OperatorHub.io Community Catalog Source].
. Create a namespace to contain the {ProjectShort} components, for example, `service-telemetry`:
+
[options="nowrap",role="white-space-pre"]
----
$ oc new-project service-telemetry
----
. Create an OperatorGroup in the namespace so that you can schedule the Operator pods:
+
[options="nowrap",role="white-space-pre"]
----
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
name: service-telemetry-operator-group
namespace: service-telemetry
spec:
targetNamespaces:
- service-telemetry
EOF
----
+
For more information, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/understanding/olm/olm-understanding-operatorgroups.html[OperatorGroups].



ifeval::["{build}" == "upstream"]
. xref:enabling-infrawatch-catalog-source_assembly-installing-the-core-components-of-stf[Enabling the infrawatch catalog source].

. Before you deploy {ProjectShort} on {OpenShift}, you must enable the catalog source. Install a CatalogSource that contains the Service Telemetry Operator and the Smart Gateway Operator:
+
[source,bash]
----
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
name: infrawatch-operators
namespace: openshift-marketplace
spec:
displayName: InfraWatch Operators
image: quay.io/infrawatch-operators/infrawatch-catalog:nightly
publisher: InfraWatch
sourceType: grpc
updateStrategy:
registryPoll:
interval: 30m
EOF
----

. Validate the creation of your CatalogSource:
+
[source,options="nowrap"]
----
$ oc get -nopenshift-marketplace catalogsource infrawatch-operators

NAME DISPLAY TYPE PUBLISHER AGE
infrawatch-operators InfraWatch Operators grpc InfraWatch 2m16s
----

. Validate that the Operators are available from the catalog:
+
[source,options="nowrap"]
----
$ oc get packagemanifests | grep InfraWatch

service-telemetry-operator InfraWatch Operators 7m20s
smart-gateway-operator InfraWatch Operators 7m20s
----
endif::[]
. xref:subscribing-to-the-amq-certificate-manager-operator_assembly-installing-the-core-components-of-stf[Subscribing to the AMQ Certificate Manager Operator].
. xref:subscribing-to-the-elastic-cloud-on-kubernetes-operator_assembly-installing-the-core-components-of-stf[Subscribing to the Elastic Cloud on Kubernetes Operator].
. xref:subscribing-to-the-service-telemetry-operator_assembly-installing-the-core-components-of-stf[Subscribing to the Service Telemetry Operator].
. xref:creating-a-servicetelemetry-object-in-openshift_assembly-installing-the-core-components-of-stf[Creating a ServiceTelemetry object in Red Hat OpenShift Container Platform].

. Enable the OperatorHub.io Community Catalog Source to install data storage and visualization Operators:
+
[options="nowrap",role="white-space-pre"]
----
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
name: operatorhubio-operators
namespace: openshift-marketplace
spec:
sourceType: grpc
image: quay.io/operatorhubio/catalog:latest
displayName: OperatorHub.io Operators
publisher: OperatorHub.io
EOF
----
+
[NOTE]
Red Hat supports the core Operators and workloads, including {MessageBus}, AMQ Certificate Manager, Service Telemetry Operator, and Smart Gateway Operator.

. Subscribe to the AMQ Certificate Manager Operator by using the redhat-operators CatalogSource:
+
[options="nowrap",role="white-space-pre"]
----
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: amq7-cert-manager-operator
namespace: openshift-operators
spec:
channel: 1.x
installPlanApproval: Automatic
name: amq7-cert-manager-operator
source: redhat-operators
sourceNamespace: openshift-marketplace
EOF
----
+
[NOTE]
The AMQ Certificate Manager deploys to the `openshift-operators` namespace and is then available to all namespaces across the cluster. As a result, on clusters with a large number of namespaces, it can take several minutes for the Operator to be available in the `service-telemetry` namespace. The AMQ Certificate Manager Operator is not compatible with the dependency management of Operator Lifecycle Manager when you use it with other namespace-scoped operators.

. Validate your ClusterServiceVersion:
+
[options="nowrap",role="white-space-pre"]
----
$ oc get --namespace openshift-operators csv

NAME DISPLAY VERSION REPLACES PHASE
amq7-cert-manager.v1.0.1 Red Hat Integration - AMQ Certificate Manager 1.0.1 Succeeded
Ensure that amq7-cert-manager.v1.0.1 displays a phase of Succeeded.
----

. If you plan to store events in ElasticSearch, you must enable the Elastic Cloud on Kubernetes (ECK) Operator. To enable the ECK Operator, create the following manifest in your {OpenShift} environment:
+
[options="nowrap",role="white-space-pre"]
----
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: elasticsearch-eck-operator-certified
namespace: service-telemetry
spec:
channel: stable
installPlanApproval: Automatic
name: elasticsearch-eck-operator-certified
source: certified-operators
sourceNamespace: openshift-marketplace
EOF
----

. Verify that the ClusterServiceVersion for Elastic Cloud on Kubernetes `Succeeded`:
+
[options="nowrap",role="white-space-pre"]
----
$ oc get csv

NAME DISPLAY VERSION REPLACES PHASE
...
elasticsearch-eck-operator-certified.v1.7.1 Elasticsearch (ECK) Operator 1.7.1 elasticsearch-eck-operator-certified.v1.6.0 Succeeded
...
----

. Create the Service Telemetry Operator subscription to manage the {ProjectShort} instances:
+
[options="nowrap",role="white-space-pre"]
----
$ oc create -f - <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: service-telemetry-operator
namespace: service-telemetry
spec:
channel: stable-1.3
installPlanApproval: Automatic
name: service-telemetry-operator
source: redhat-operators
sourceNamespace: openshift-marketplace
EOF
----

. Validate the Service Telemetry Operator and the dependent operators:
+
[options="nowrap",role="white-space-pre"]
----
$ oc get csv --namespace service-telemetry

amq7-cert-manager.v1.0.1 Red Hat Integration - AMQ Certificate Manager 1.0.1 Succeeded
amq7-interconnect-operator.v1.10.1 Red Hat Integration - AMQ Interconnect 1.10.1 amq7-interconnect-operator.v1.2.4 Succeeded
elasticsearch-eck-operator-certified.v1.8.0 Elasticsearch (ECK) Operator 1.8.0 elasticsearch-eck-operator-certified.v1.7.1 Succeeded
prometheusoperator.0.47.0 Prometheus Operator 0.47.0 prometheusoperator.0.37.0 Succeeded
service-telemetry-operator.v1.3.1632925572 Service Telemetry Operator 1.3.1632925572 Succeeded
smart-gateway-operator.v3.0.1632925565 Smart Gateway Operator 3.0.1632925565 Succeeded
----

This file was deleted.

Loading