[#2] Add documentation on support development for clients
Add documentation about how to redeploy a new image, when a client provides new mappings or changes to mappings:
- When clients push a new MR with a new mapping, we need to redeploy the changes for them.
For that we need to click the manual steps in the MR to build and push the image to the Paas registry. The image will be available with a tag corresponding to the slug of the MR branch.
If the deployment config (worker and web) is already associated with that image an automatic rollout is done.
For the first time, a manual change to point to that new image is needed: For that edit the deployment config of worker and web and select the tag of the image you just created (wait for the manual jobs in the MR to finish).
- When the deployment is finished, we need to wipe the data in the instance, in order for clients to be able to test with an empty instance.
We need to wipe DB records and ES indexes/mappings and re-init the instance.
For ES everything is documented already.
For DB we have 2 options:
- wipe everything if the client does not mind creating new API Tokens
- alternatively we can truncate tables but leave user/token data
For the second option we have documentation.
For the first option:
- Drop the tables, using:
db drop
- Recreate them using
db create
- Finally run
invenio files location default ${DEFAULT_RECORDS_FILES_LOCATION} --default
to finish the DB setup
Document the process and adapt existing documentation to reflect this process.
- Add new page: called
Deploy new Image and Mappings (and support for DEV)
- On that page add explanation above, step 1) and 2) and on step 2) link to existing page https://cern-search-admin.docs.cern.ch/operations/truncate_instance/
- Update page https://cern-search-admin.docs.cern.ch/operations/truncate_instance/ with the missing information
Additionally, copy warning section "First deployment of an instance" from https://cern-search-internal.docs.cern.ch/manual-deployment/openshift/ to helm deployment https://cern-search-internal.docs.cern.ch/deployment/helm-infra/ > New instance instructions > 4. Init Invenio configuration