Skip to content

Add docs for storing logs in GCS #23

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for storing logs in GCS #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 23 additions & 1 deletion operator/install-result.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ openssl req -x509 \
oc create secret tls -n ${NAMESPACE} tekton-results-tls --cert=cert.pem --key=key.pem
----

4. Optional: Create a Persistent Volume Claim (PVC) if you need to store your logging data.
4. Optional: Prepare storage for storing logs

a. PVC: Create a Persistent Volume Claim (PVC) if you need to store your logging data in PVC.
+
[source,bash]
----
Expand All @@ -59,6 +61,26 @@ EOF
oc apply -n ${NAMESPACE} -f pvc.yaml
----

b. Google Cloud Storage (GCS): Set GCS properties and secret
+
[source,bash]
----
We need to create a secret with google application creds for a bucket (let's say with a name foo-bar) like below:

```
kubectl create secret generic gcs-credentials --from-file=creds.json
Copy link

@mramendi mramendi Aug 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs a definition (or a reference to) contents/format of creds.json

```
----

Now this will be used in the `TektonResult` CR described in point 5 with following properties:
+
[source,bash]
----
gcs_creds_secret_name: gcs-credentials
gcc_creds_secret_key: creds.json
Copy link

@mramendi mramendi Sep 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I presume "gcc" is a typo?

gcs_bucket_name: foo-bar
----

5. Edit the `TektonResult` CR based on your needs
+
[source,yaml]
Expand Down