Steps to support Crunchy PostgreSQL with Tekton Hub

# Steps to support Crunchy PostgreSQL with Tekton Hub ### Case 1: For Fresh Install of Tekton Hub using Crunchy Postgres * Install Crunchy Postgres Operator from Operator Hub * Create a postgres instance which will create a postgres database * Follow and make the below necessary configurations in your database to connect to Tekton Hub * Exec into the Crunchy Postgres pod and find the `pg_hba.conf` using the following commands and check if the database has the access to accept all the incoming connections ```bash== ╰─ kubectl exec -it -n openshift-operators hippo-instance1-m7hh-0 -- /bin/sh Defaulting container name to database. Use 'kubectl describe pod/hippo-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod. sh-4.4$ psql -U postgres psql (14.4) Type "help" for help. postgres=# SHOW hba_file; hba_file -------------------------- /pgdata/pg14/pg_hba.conf (1 row) postgres=# ``` * Exit from the database * To check if the database has access to connect, find the `pg_hba.conf` file and then see if it has this line `host all all 0.0.0.0/0 md5`, as this will give access for all incoming connections * Below are the steps of how to find the file and check if it has access for configuring all incoming connections ```bash== ╰─ kubectl exec -it -n openshift-operators hippo-instance1-m7hh-0 -- /bin/sh Defaulting container name to database. Use 'kubectl describe pod/hippo-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod. sh-4.4$ psql -U postgres psql (14.4) Type "help" for help. postgres=# SHOW hba_file; hba_file -------------------------- /pgdata/pg14/pg_hba.conf (1 row) postgres=# —----------------Exit from the database —--------------------------- sh-4.4$ vi /pgdata/pg14/pg_hba.conf =========== It opens the vim editor and has some data ========== # Do not edit this file manually! # It will be overwritten by Patroni! local all "postgres" peer hostssl replication "_crunchyrepl" all cert hostssl "postgres" "_crunchyrepl" all cert host all "_crunchyrepl" all reject hostssl all all all md5 host all all 0.0.0.0/0 md5 —------------> Add this line ============= Save the file and reload the database as follows ============= sh-4.4$ psql -U postgres psql (14.4) Type "help" for help. postgres=# SHOW hba_file; hba_file -------------------------- /pgdata/pg14/pg_hba.conf (1 row) postgres=# SELECT pg_reload_conf(); pg_reload_conf ---------------- t (1 row) ``` * Get the database secret of the your postgres instance and get all the values and create the below secret in targeNamespace (here the database name is `hippo`). Currently, the name of the secret should be `tekton-hub-db` and the keys of the secret should be as follows ```yaml= apiVersion: v1 kind: Secret metadata: name: tekton-hub-db labels: app: tekton-hub-db type: Opaque stringData: POSTGRES_HOST: <The name of the host of the database> POSTGRES_DB: <Name of the database> POSTGRES_USER: <The name of user account> POSTGRES_PASSWORD: <The password of user account> POSTGRES_PORT: <The port that the database is listening on> ``` **NOTE** :- The values of the secret of Crunchy Postgres will be encoded, so we'll have to decode it and then add it in the secret * Following is the example of host value which is decoded ```bash! ╰─ echo 'aGlwcG8tcHJpbWFyeS5vcGVuc2hpZnQtb3BlcmF0b3JzLnN2YyA=' | base64 --decode hippo-primary.openshift-operators.svc ``` - Example of `tekton-hub-db` secret to be created in targetNamespace ```yaml== apiVersion: v1 kind: Secret metadata: name: tekton-hub-db labels: app: tekton-hub-db type: Opaque stringData: POSTGRES_HOST: hippo-primary.openshift-operators.svc POSTGRES_DB: hippo POSTGRES_USER: hippo POSTGRES_PASSWORD: woXOisU5>ocJiTF7y{{;1[Q( POSTGRES_PORT: '5432' ``` <br /> * Install the Hub CR by adding database secret name in the Hub CR spec * This is how the Hub CR looks <br /> ```yaml= apiVersion: operator.tekton.dev/v1alpha1 kind: TektonHub metadata: name: hub spec: db: # 👈 external database to be used secret: tekton-hub-db # 👈 Name of db secret should be `tekton-hub-db` api: hubConfigUrl: https://raw.githubusercontent.com/tektoncd/hub/main/config.yaml catalogRefreshInterval: 30m ``` You can install Tekton Hub by running the command ```bash== kubectl apply -f <name>.yaml ``` Check the status of installation using following command ```bash= $ kubectl get tektonhub.operator.tekton.dev NAME VERSION READY REASON APIURL UIURL hub v1.8.0 True https://api.route.url https://ui.route.url ``` --- ### Case 2: If Tekton Hub is already installed and user needs to migrate the data - If you have already installed Tekton Hub and now if you want to use your own database (e.g. Crunchy Postgres) **NOTE:- Migration of data to external database is *OPTIONAL*** #### Steps to migrate the data from internal database to external database(e.g. Crunchy Postgres) * Dump the exisitng data from the internal database into a file in a pod ```bash== pg_dump -Ft -h localhost -U postgres hub -f /tmp/hub.dump ``` * Copy the file into your local system using `kubectl` command * Format to copy the file into your local system is :- ```bash! kubectl cp -n <namespace> <podName>:<path-to-hub.dump> <path-to-local-system> ``` * For example:- ```bash kubectl cp -n openshift-pipelines tekton-hub-db-7d6d888c67-p7mdr:/tmp/hub.dump /home/Puneet/Downloads/hub.dump ``` * Copy the dumped file from your local system into the database pod which user wants to connect * Format to copy the file into a pod from your local system is :- ```bash kubectl cp -n <namespace> <path-to-local-system> <podName>:<path-to-hub.dump> ``` * For example:- ```bash kubectl cp -n openshift-operators /home/Puneet/Downloads/hub.dump hippo-instance1-spnz-0:/tmp/hub.dump ``` * Restore the data in your target database(e.g. Crunchy Postgres Database) using the following command ```bash pg_restore -d <database-name> -h localhost -U postgres <path-where-file-is-copied> ``` For example:- ```bas pg_restore -d hippo -h localhost -U postgres /tmp/hub.dump ``` --- * Follow and make the below necessary configurations in your database to connect to Tekton Hub * Exec into the Crunchy Postgres pod and find the `pg_hba.conf` using the following commands and check if the database has the access to accept all incoming connections ```bash== ╰─ kubectl exec -it -n openshift-operators hippo-instance1-m7hh-0 -- /bin/sh Defaulting container name to database. Use 'kubectl describe pod/hippo-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod. sh-4.4$ psql -U postgres psql (14.4) Type "help" for help. postgres=# SHOW hba_file; hba_file -------------------------- /pgdata/pg14/pg_hba.conf (1 row) postgres=# ``` * Exit from the database * Check if the database has access to connect, if it doesn’t have all the access, then open the file and add one line at the end ```bash== ╰─ kubectl exec -it -n openshift-operators hippo-instance1-m7hh-0 -- /bin/sh Defaulting container name to database. Use 'kubectl describe pod/hippo-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod. sh-4.4$ psql -U postgres psql (14.4) Type "help" for help. postgres=# SHOW hba_file; hba_file -------------------------- /pgdata/pg14/pg_hba.conf (1 row) postgres=# —----------------Exit from the database —--------------------------- sh-4.4$ vi /pgdata/pg14/pg_hba.conf =========== It opens the vim editor and has some data ========== # Do not edit this file manually! # It will be overwritten by Patroni! local all "postgres" peer hostssl replication "_crunchyrepl" all cert hostssl "postgres" "_crunchyrepl" all cert host all "_crunchyrepl" all reject hostssl all all all md5 host all all 0.0.0.0/0 md5 —------------> Add this line ============= Save the file and reload the database as follows ============= sh-4.4$ psql -U postgres psql (14.4) Type "help" for help. postgres=# SHOW hba_file; hba_file -------------------------- /pgdata/pg14/pg_hba.conf (1 row) postgres=# SELECT pg_reload_conf(); pg_reload_conf ---------------- t (1 row) ``` * Get the database secret of the your postgres instance and get all the values and create the above secret in targeNamespace (here the database name is `hippo`) * Currently, the name of the secret should be `tekton-hub-db` and the keys of the secret should be as follows ```yaml= apiVersion: v1 kind: Secret metadata: name: tekton-hub-db labels: app: tekton-hub-db type: Opaque stringData: POSTGRES_HOST: <The name of the host of the database> POSTGRES_DB: <Name of the database> POSTGRES_USER: <The name of user account> POSTGRES_PASSWORD: <The password of user account> POSTGRES_PORT: <The port that the database is listening on> ``` **NOTE** :- The values of the secret of Crunchy Postgres will be encoded, so we'll have to decode it and then add it in the secret * Following is the example of host value which is decoded ```bash! ╰─ echo 'aGlwcG8tcHJpbWFyeS5vcGVuc2hpZnQtb3BlcmF0b3JzLnN2YyA=' | base64 --decode hippo-primary.openshift-operators.svc ``` - Example of `tekton-hub-db` secret to be created in targetNamespace ```yaml== apiVersion: v1 kind: Secret metadata: name: tekton-hub-db labels: app: tekton-hub-db type: Opaque stringData: POSTGRES_HOST: hippo-primary.openshift-operators.svc POSTGRES_DB: hippo POSTGRES_USER: hippo POSTGRES_PASSWORD: woXOisU5>ocJiTF7y{{;1[Q( POSTGRES_PORT: '5432' ``` <br /> * Replace the Hub CR by adding database secret name in the Hub CR spec * This is how the Hub CR looks <br /> ```yaml= apiVersion: operator.tekton.dev/v1alpha1 kind: TektonHub metadata: name: hub spec: db: # 👈 external database to be used secret: tekton-hub-db # 👈 Name of db secret should be `tekton-hub-db` api: hubConfigUrl: https://raw.githubusercontent.com/tektoncd/hub/main/config.yaml catalogRefreshInterval: 30m ``` You can replace Tekton Hub by running the command ```bash== kubectl replace -f <name>.yaml ``` Check the status of installation using following command ```bash= $ kubectl get tektonhub.operator.tekton.dev NAME VERSION READY REASON APIURL UIURL hub v1.8.0 True https://api.route.url https://ui.route.url ```

Syntax	Example	Reference
# Header	Header	基本排版
- Unordered List	Unordered List
1. Ordered List	Ordered List
- [ ] Todo List	Todo List
> Blockquote	Blockquote
Bold font	Bold font
Italics font	Italics font
~~Strikethrough~~	~~Strikethrough~~
19^th^	19^th
H~2~O	H₂O
++Inserted text++	Inserted text
==Marked text==	Marked text
[link text](https:// "title")	Link
![image alt](https:// "title")	Image
`Code`	`Code`	在筆記中貼入程式碼
```javascript var i = 0; ```	`var i = 0;`
:smile:		Emoji list
{%youtube youtube_id %}	Externals
$L^aT_eX$	L^aT_eX
:::info This is a alert area. :::	This is a alert area.