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

🐛 Use postgresql modules for migration #364

Merged
merged 2 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ RUN echo -e "[almalinux8-appstream]" \
"\nbaseurl = https://repo.almalinux.org/almalinux/8/AppStream/\$basearch/os/" \
"\nenabled = 1" \
"\ngpgcheck = 0" > /etc/yum.repos.d/almalinux.repo
RUN dnf -y module enable postgresql:15 && dnf -y install postgresql && dnf clean all
RUN dnf -y module enable postgresql:15 && dnf -y install postgresql python38-psycopg2 && dnf clean all
USER 1001

COPY requirements.yml ${HOME}/requirements.yml
Expand Down
56 changes: 44 additions & 12 deletions roles/tackle/tasks/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -241,18 +241,50 @@
dbm_user: "{{ pgsql_secret.resources[0].data['database-user'] | b64decode }}"
dbm_pass: "{{ pgsql_secret.resources[0].data['database-password'] | b64decode }}"

- name: "Generate DB URLs"
set_fact:
dbm_src: postgresql://{{ dbm_user }}:{{ dbm_pass }}@{{ keycloak_database_service_k8s_resource_name }}/{{ keycloak_database_db_name }}
dbm_dst: postgresql://{{ dbm_user }}:{{ dbm_pass }}@{{ keycloak_database_service_k8s_resource_name }}-migration/{{ keycloak_database_db_name }}

- name: "Perform the DB upgrade"
shell: |
set -euo pipefail
until pg_isready -U {{ dbm_user }} -h {{ keycloak_database_service_k8s_resource_name }} -d {{ keycloak_database_db_name }}; do sleep 10; done
until pg_isready -U {{ dbm_user }} -h {{ keycloak_database_service_k8s_resource_name }}-migration -d {{ keycloak_database_db_name }}; do sleep 10; done
pg_dump {{ dbm_src }} | psql {{ dbm_dst }}
changed_when: false
- name: Ping source database
postgresql_ping:
db: "{{ keycloak_database_db_name }}"
login_host: "{{ keycloak_database_service_k8s_resource_name }}"
login_user: "{{ dbm_user }}"
login_password: "{{ dbm_pass }}"
register: src_ping
retries: 12
until: src_ping.is_available and src_ping.server_version.major == 12
delay: 10

- name: Ping destination database
postgresql_ping:
db: "{{ keycloak_database_db_name }}"
login_host: "{{ keycloak_database_service_k8s_resource_name }}-migration"
login_user: "{{ dbm_user }}"
login_password: "{{ dbm_pass }}"
register: dst_ping
retries: 12
until: dst_ping.is_available and dst_ping.server_version.major == 15
delay: 10

- name: Dump database
postgresql_db:
state: dump
name: "{{ keycloak_database_db_name }}"
target: /tmp/keycloak.sql
login_host: "{{ keycloak_database_service_k8s_resource_name }}"
login_user: "{{ dbm_user }}"
login_password: "{{ dbm_pass }}"

- name: Restore database
postgresql_db:
state: restore
name: "{{ keycloak_database_db_name }}"
target: /tmp/keycloak.sql
login_host: "{{ keycloak_database_service_k8s_resource_name }}-migration"
login_user: "{{ dbm_user }}"
login_password: "{{ dbm_pass }}"

- name: Clean up database dump file
file:
state: absent
path: /tmp/keycloak.sql

Choose a reason for hiding this comment

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

Suggested change
path: /tmp/keycloak.sql
path: /tmp/keycloak.sql

I don't see it used anywhere else besides here ('Dump database', 'Restore database', & 'Clean up database dump file'), so I've no concern leaving it as it is, but did have the thought as I was reviewing, "should this be hard-coded?", and wanted to raise it.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not concerned about it being hardcoded, except that it's predictable if someone was looking for it to try and do something malicious. I think it's easy to generate a name, so I'll probably do that. As an aside I just updated the PR with the change that I think will actually resolve the random lost DB, and added a comment with explanation.

Copy link
Member Author

@jmontleon jmontleon Jul 22, 2024

Choose a reason for hiding this comment

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

At least I hope it fixes. One success does not make a pattern. Especially since it took all day testing to get a failure. But it at least looks promising.


- name: "Remove the temporary migration service"
k8s:
Expand Down
6 changes: 3 additions & 3 deletions roles/tackle/templates/deployment-keycloak-postgresql.yml.j2
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ metadata:
name: {{ keycloak_database_deployment_name }}-{{ keycloak_database_db_version }}
namespace: {{ app_namespace }}
labels:
app.kubernetes.io/name: {{ keycloak_database_service_name }}
app.kubernetes.io/name: {{ keycloak_database_service_name }}-{{ keycloak_database_db_version }}
app.kubernetes.io/component: {{ keycloak_database_component_name }}
app.kubernetes.io/part-of: {{ app_name }}
version: "{{ keycloak_database_db_version }}"
spec:
replicas: {{ keycloak_database_deployment_replicas }}
selector:
matchLabels:
app.kubernetes.io/name: {{ keycloak_database_service_name }}
app.kubernetes.io/name: {{ keycloak_database_service_name }}-{{ keycloak_database_db_version }}
app.kubernetes.io/component: {{ keycloak_database_component_name }}
app.kubernetes.io/part-of: {{ app_name }}
version: "{{ keycloak_database_db_version }}"
Expand All @@ -24,7 +24,7 @@ spec:
template:
metadata:
labels:
app.kubernetes.io/name: {{ keycloak_database_service_name }}
app.kubernetes.io/name: {{ keycloak_database_service_name }}-{{ keycloak_database_db_version }}
app.kubernetes.io/component: {{ keycloak_database_component_name }}
app.kubernetes.io/part-of: {{ app_name }}
app: {{ app_name }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ spec:
targetPort: 5432
protocol: TCP
selector:
app.kubernetes.io/name: {{ keycloak_database_service_name }}
app.kubernetes.io/name: {{ keycloak_database_service_name }}-{{ keycloak_database_db_version }}
app.kubernetes.io/component: {{ keycloak_database_component_name }}
app.kubernetes.io/part-of: {{ app_name }}
version: "{{ keycloak_database_db_version }}"
2 changes: 1 addition & 1 deletion roles/tackle/templates/service-keycloak-postgresql.yml.j2
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ spec:
targetPort: 5432
protocol: TCP
selector:
app.kubernetes.io/name: {{ keycloak_database_service_name }}
app.kubernetes.io/name: {{ keycloak_database_service_name }}-{{ keycloak_database_db_version }}
app.kubernetes.io/component: {{ keycloak_database_component_name }}
app.kubernetes.io/part-of: {{ app_name }}
version: "{{ keycloak_database_db_version }}"
Loading