In dieser Anleitung zeigen wir euch, wie ihr euer COYO updatet. Um ein Update fehlerfrei durchzuführen, befolgt bitte alle notwendigen Schritte.
Hinweis:
Dieser Artikel ist aufgrund seiner technischen Natur nur in Englisch verfügbar. Falls ihr Fragen haben solltet, wendet euch gerne an unseren Service Desk.
Before we start, please note the following:
Own backup plan
When you have your own backup mechanism implemented you may skip the backup steps described in this guide.
REST API
We advice you to use a GUI tool like postman to manage REST API calls / HTTP requests.
In the following we give examples with the command-line tool cURL. You don't have to but you can run these on the COYO host.
In the following we give examples with the command-line tool cURL. You don't have to but you can run these on the COYO host.
Higher System requirements in Version 18+
Due to a new second level cache please expect an additional 25% load on all backend nodes and 4-6GB of additional RAM. Due to higher complexity of the application please expect an additional 25% load on all elasticsearch nodes.
We also prepared a Video guide:
Das Video funktioniert nicht? Klicke hier!
Step-by-step Guide
The update of an existing installation is done in a few simple steps.
We provide enterprise packages here. Just download the new release with wget into your COYO home directory and follow these easy steps:
1. Announce maintenance work some hours early with a maintenance message via REST API's management endpoint. Please set duration (time till message disappears by itself) and message depending on your needs.
(Make sure to replace the COYO_* parameters with the values in your .env file)
(Make sure to replace the COYO_* parameters with the values in your .env file)
curl -u 'COYO_MANAGEMENT_USER':'COYO_MANAGEMENT_PASSWORD' \ -X POST \ https://COYO_BACKEND_URL/manage/maintenance/message/all \ -H 'Content-Type: application/json' \ -d '{ "message" : "Planned COYO update at 20:00 pm. We expect a downtime of about 30 minutes.", "duration" : 5400, "onlyAdmins" : false }'
2. Put COYO into maintenance mode via REST API's management endpoint. Please set headline and message depending on your needs.
(Make sure to replace the COYO_* parameters with the values in your .env file)
(Make sure to replace the COYO_* parameters with the values in your .env file)
curl -u 'COYO_MANAGEMENT_USER':'COYO_MANAGEMENT_PASSWORD' \ -X POST \ https://COYO_BACKEND_URL/manage/maintenance \ -H 'Content-Type: application/json' \ -d '{ "headline": "Upgrading to 13.0.2-RELEASE", "message": "Don'\''t panic!" }'
3. Create a backup and wait until it's finished. Below you find the PUT request to create a backup and the GET request to pull the status.
(Make sure to replace the COYO_* parameters with the values in your .env file)
(Make sure to replace the COYO_* parameters with the values in your .env file)
#Backup status curl -u 'COYO_MANAGEMENT_USER':'COYO_MANAGEMENT_PASSWORD' https://COYO_BACKEND_URL:8083/api/backups #Create backup curl -u 'COYO_MANAGEMENT_USER':'COYO_MANAGEMENT_PASSWORD' -X PUT https://COYO_BACKEND_URL:8083/api/backups
4. Stop COYO
./stop.sh
5. Unzip the downloaded release and replace/rename files like this:
root@coyo-host:/home/coyo unzip coyo4_<version>-RELEASE.zip Archive: coyo4_<version>-RELEASE.zip replace .env? [y]es, [n]o, [A]ll, [N]one, [r]ename: r new name: .env_<version> inflating: .env_<version> replace coyo-push.properties? [y]es, [n]o, [A]ll, [N]one, [r]ename: n replace coyo-backup.properties? [y]es, [n]o, [A]ll, [N]one, [r]ename: n replace stop.sh? [y]es, [n]o, [A]ll, [N]one, [r]ename: y replace docker-compose.yml? [y]es, [n]o, [A]ll, [N]one, [r]ename: y replace start.sh? [y]es, [n]o, [A]ll, [N]one, [r]ename: y replace start-advanced.sh? [y]es, [n]o, [A]ll, [N]one, [r]ename: y replace coyo-backend.properties? [y]es, [n]o, [A]ll, [N]one, [r]ename: n replace README.md? [y]es, [n]o, [A]ll, [N]one, [r]ename: y
Additional parameters in Version 14+
The .env file now expects two new lines that need to be added (you'll find them below) to your .env file before starting COYO again.
# Mode for single host installation COYO_SINGLE_BACKEND=true
# Score for OOM COYO_BACKEND_OOM_SCORE=0
6. Check the new .env_<version> file for updates or read our release notes carefully and apply changes to .env file
(When you missed a parameter you'll get a WARN message when running the start.sh script. You should then abort by ctrl + c)
(When you missed a parameter you'll get a WARN message when running the start.sh script. You should then abort by ctrl + c)
Attention:
Should you experience ERRORS from the docker-compose.yml file, please make sure that you are on the current supported version of docker-compose (>=v1.18.0.). For further instructions how to update to the current docker-compose version look up or Installation Guide.
7. Start COYO
./start.sh
# OR for starting with metrics stack
./start-advanced.sh
8. Tail the coyo-backend.log till the message "Application started in X seconds" appears and watch for migration errors
(Make sure to replace the COYO_* parameters with the values in your .env file)
(Make sure to replace the COYO_* parameters with the values in your .env file)
tail -f COYO_DATA_STORAGE/backend/logs/coyo-backend.log9. Visit your COYO and deactivate maintenance mode
curl -u 'COYO_MANAGEMENT_USER':'COYO_MANAGEMENT_PASSWORD' \ -X DELETE \ https://COYO_BACKEND_URL/manage/maintenance
