OBSDOCS-1618: Document IBM Cloud Object Storage for Tempo

Signed-off-by: Ruben Vargas <[email protected]>

Author: rubenvp8510

modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc

@@ -0,0 +1,77 @@
+// Module included in the following assemblies:
+//
+//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="distr-tracing-tempo-object-storage-setup-ibm-storage_{context}"]
+= Setting up {ibm-cloud-title} Object Storage
+
+You can set up {ibm-cloud-title} Object Storage by using the {oc-first}.
+
+.Prerequisites
+
+* You have installed the latest version of {oc-first}. For more information, see "Getting started with the OpenShift CLI" in _Configure: CLI tools_.
+
+* You have installed the latest version of {ibm-cloud-title} Command Line Interface (`ibmcloud`). For more information, see "Getting started with the {ibm-cloud-title} CLI" in _{ibm-cloud-title} Docs_.
+
+* You have configured {ibm-cloud-title} Object Storage. For more information, see "Choosing a plan and creating an instance" in _{ibm-cloud-title} Docs_.
+
+** You have an {ibm-cloud-title} Platform account.
+** You have ordered an {ibm-cloud-title} Object Storage plan.
+** You have created an instance of {ibm-cloud-title} Object Storage.
+
+.Procedure
+
+. On {ibm-cloud-title}, create an object store bucket.
+
+. On {ibm-cloud-title}, create a service key for connecting to the object store bucket by running the following command:
++
+[source,terminal]
+----
+$ ibmcloud resource service-key-create <tempo_bucket> Writer \
+--instance-name <tempo_bucket> --parameters '{"HMAC":true}'
+----
+
+. On {ibm-cloud-title}, create a secret with the bucket credentials by running the following command:
++
+[source,terminal]
+----
+$ oc -n <namespace> create secret generic <ibm_cos_secret> \
+  --from-literal=bucket="<tempo_bucket>" \
+  --from-literal=endpoint="<ibm_bucket_endpoint>" \
+  --from-literal=access_key_id="<ibm_bucket_access_key>" \
+  --from-literal=access_key_secret="<ibm_bucket_secret_key>"
+----
+
+. On {product-title}, create an object storage secret with keys as follows:
++
+[source,yaml]
+----
+apiVersion: v1
+kind: Secret
+metadata:
+  name: <ibm_cos_secret>
+stringData:
+  bucket: <tempo_bucket>
+  endpoint: <ibm_bucket_endpoint>
+  access_key_id: <ibm_bucket_access_key>
+  access_key_secret: <ibm_bucket_secret_key>
+type: Opaque
+----
+
+. On {product-title}, set the storage section in the `TempoStack` custom resource as follows:
++
+[source,yaml]
+----
+apiVersion: tempo.grafana.com/v1alpha1
+kind: TempoStack
+# ...
+spec:
+# ...
+  storage:
+    secret:
+      name: <ibm_cos_secret> # <1>
+      type: s3
+# ...
+----
+<1> Name of the secret that contains the {ibm-cloud-title} Storage access and secret keys.

observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc

@@ -71,6 +71,16 @@ include::modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc[l
 * xref:../../../authentication/identity_providers/configuring-oidc-identity-provider.adoc#configuring-oidc-identity-provider[Configuring an OpenID Connect identity provider]
 * link:https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html[Identify AWS resources with Amazon Resource Names (ARNs)]
 
+include::modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI]
+* link:https://cloud.ibm.com/docs/cli?topic=cli-getting-started[Getting started with the {ibm-cloud-title} CLI] ({ibm-cloud-title} Docs)
+* link:https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-provision[Choosing a plan and creating an instance] ({ibm-cloud-title} Docs)
+* link:https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage&q=credential&tags=cloud-object-storage&offset=10#getting-started[Getting started with {ibm-cloud-title} Object Storage: Before you begin] ({ibm-cloud-title} Docs)
+
 [role="_additional-resources"]
 [id="additional-resources_dist-tracing-tempo-installing"]
 == Additional resources