fix: Moved all common tilt stuff to shared library

[adskyiproger]

Note

Currently, we do not run e2e tests as a check on opencrvs-countryconfig-repo PRs. Please ensure your PR doesn't break any e2e tests.

One method for doing this is to open a PR with these changes to opencrvs-farajaland as well, and see if the PR check passes there.

Description

Issue addressed: opencrvs/opencrvs-core#10672

This PR aims to actualise Tiltfile after 6 months of development.

Related PRs:

• Core: fix: Moved all common tilt stuff to shared library opencrvs-core#10764
• Infrastructure: fix: Tiltfile refactoring to improve performance and reduce maintenance  infrastructure#125

Testing

Note

Apple Silicon users need to build ARM compatible OpenCRVS Core images, see github workflow: https://github.com/opencrvs/opencrvs-core/actions/runs/18721862548
Core image tagdevelop was built with ARM support for this particular test. Docker desktop on apple silicon is able to run amd64 images, but performance is significantly degraded.
We are not building images locally, but pulling from GitHub registry, first start may take up to 30 minutes. On my machine it took 15 minutes, internet connection speed 300Mb/s

Prerequisites

Hardware:

Software:

• minikube
  

• docker desktop
  

Note

In this test infrastructure repository is cloned by running tilt up command
Built-in docker desktop kubernetes cluster was disabled

Steps to test

[!NOTE] Before running test steps open Tiltfile and adjust OpenCRVS core image tag, usually wrong tag will lead to errors in events container:

1. Make sure minikube cluster is up:

minikube status

Example output:

minikube
type: Control Plane
host: Running
kubelet: Running
apiserver: Running
kubeconfig: Configured

Use following command to start minikube:

minikube start --cpus=8 --memory=max --ports=80:30080

2. Navigate to countryconfig repository

(.venv) NB01NSTL012:opencrvs-countryconfig vmudryi$ pwd
/Users/vmudryi/Documents/opencrvs-repo/opencrvs-countryconfig

3. Change branch to ocrvs-10672

(.venv) NB01NSTL012:opencrvs-countryconfig vmudryi$ git status
On branch ocrvs-10672
Your branch is up to date with 'origin/ocrvs-10672'.

nothing to commit, working tree clean

4. Optional: remove infrastructure repository:

(.venv) NB01NSTL012:opencrvs-countryconfig vmudryi$ ls -l ../infrastructure/
(.venv) NB01NSTL012:opencrvs-repo vmudryi$ rm -rf ../infrastructure/

5. Run tilt up

6. Check url in browser: http://localhost:10350/

7. Verify Tiltfile was loaded: 8. Check logs for any errors 9. Restart any failed jobs:

11. Verify all dependency pods are up and running:

kubectl get po -n opencrvs-deps-dev

Example output:

NB01NSTL012:opencrvs-countryconfig vmudryi$ kubectl get po -n opencrvs-deps-dev
NAME              READY   STATUS    RESTARTS   AGE
elasticsearch-0   1/1     Running   0          25m
influxdb-0        1/1     Running   0          25m
minio-0           1/1     Running   0          25m
mongodb-0         1/1     Running   0          25m
postgres-0        1/1     Running   0          25m
redis-0           1/1     Running   0          25m

12. Verify all OpenCRVS pods are up and running:

kubectl get po -n opencrvs-dev

Example output:

Note

Use watch kubectl get po -n opencrvs-dev to get real time pods status

13. Seed data

14. Go to home page: http://opencrvs.localhost (not https)

Checklist

• I have linked the correct Github issue under "Development"
• I have tested the changes locally, and written appropriate tests
• I have tested beyond the happy path (e.g. edge cases, failure paths)
• I have updated the changelog with this change (if applicable)
• I have updated the GitHub issue status accordingly

[makelicious]

Is this something we want to hardcode? It will be old in a week

[adskyiproger]

Tiltfile is a configuration file by itself, some properties like image tag can be parametrised, but some properties used for resource loading can't.

If we can't parametrise all configuration properties, we will made a confusion to people by introducing some parameters

[adskyiproger]

I've changed tag to develop, that tag should be more stable

[makelicious]

Is this local path? I assume that I would not have the file in place

[makelicious]

if not os.path.exists('../infrastructure'):
    local("git clone [email protected]:opencrvs/infrastructure.git ../infrastructure")

load('../infrastructure/tilt/opencrvs.tilt', 'setup_opencrvs')

Ah, I see. As long we have it somewhere written down that these repos need to live side by side.

Other way would be to introduce INFRA_REPOSITORY_PATH to allow ay config.

[adskyiproger]

I wish to parametrise repository path, but tiltfile has limitations:

# ✅ Correct - string literal
load('../infrastructure/tilt/opencrvs.tilt', 'setup_opencrvs')

# ❌ Wrong - variable
lib_path = '../infrastructure/tilt/opencrvs.tilt'
load(lib_path, 'setup_opencrvs')

load doesn't support variables. In next iteration I will try to publish opencrvs.tilt as external module