Zebrunner Versions Save

Enhancements

• [#576] implement 2.5 patch upgrade script
• [#575] bump up to reporting 1.30
• [#573] bump up to the latest nginx
• [#572][#569] bump up to mcloud:2.6
• [#571] bump up to jenkins:2.2

Won't Fix

• [#528] increase default proxy timeouts for nginx<->jenkins communication
• [#470] provide script to cleanup historical artifacts (video, ES indexes etc)
• [#325] Easy way to deploy pro versions as part of setup

Components Updates

• reporting 1.29 -> 1.30
• mcloud 2.5 -> 2.6
• jenkins 2.1->2.2
• pipeline-ce 2.1->2.2

Migration Steps

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

4. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

5. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (2.2)
 ... mcloud (2.6)
 ... reporting (1.30)
 ... selenoid (1.8)
 ... sonarqube (1.4)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

6. upgrade using "./zebrunner.sh upgrade" and restart

./zebrunner.sh upgrade
./zebrunner.sh restart

Enhancements

• [#561] bump up to reporting:1.29
• [#560] bump up to selenoid:1.8
• [#559] bump up to jenkins-master:2.1
• [#555] bump up to mcloud:2.5
• [#547] docs: update links and branch names
• [#454] support MacOS

Fixes

• [#563] unable to reset default admin/admin password for sonar
• [#420] OnPush-carina demo request doesn't work with Bitbucket

Won't Fix

• [#550] Error message appears during Shut down operation
• [#84] investigate possibility to setup online code editor (eclipse)

Components Updates

• reporting 1.28 -> 1.29
• mcloud 2.4.6 -> 2.5
• selenoid 1.7 -> 1.8
• jenkins 2.0->2.1
• pipeline-ce 2.0->2.1

Migration Steps

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

4. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

5. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (2.1)
 ... mcloud (2.5)
 ... reporting (1.29)
 ... selenoid (1.8)
 ... sonarqube (1.4)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

6. upgrade using "./zebrunner.sh upgrade" and restart

./zebrunner.sh upgrade
./zebrunner.sh restart

7. Clear old cache and cookies for the CE address

   #563 To complete SonarQube integration sometimes cookies clearing required after updating default password!

Enhancements

• [#551] regenerate nginx default.conf
• [#549] upgrade: automate required changes
• [#547] docs: update links and branch names
• [#536] bump up to mcloud:2.4.6
• [#529] Ability to disable authentication
• [#526] update link to child selenium grid page when available
• [#429] upgrade: add appropriate warn that previous sonar will be terminated completely
• [#333] healthcheck status for all sub-component

Fixes

• [#524] Video is not available on CE with integrated mcloud-agent devices

Known Issues

• N/A

Components Updates

• reporting 1.27 -> 1.28
• mcloud 2.4.1 -> 2.4.6
• selenoid 1.6 -> 1.7
• sonarqube 1.3 -> 1.4
• jenkins 1.8.1->2.0
• pipeline-ce 1.8->2.0

Migration Steps

Note: During upgrade we can't support migration of SonarQube module! It means all data will be destroyed and you must configure from scratch SonarQube 9.8.0!

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

4. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

5. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (2.0)
 ... mcloud (2.4.6)
 ... reporting (1.28)
 ... selenoid (1.7)
 ... sonarqube (1.4)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

6. upgrade using "./zebrunner.sh upgrade" and restart

./zebrunner.sh upgrade
./zebrunner.sh restart

7. Clear old cache and cookies for the CE address

   To complete SonarQube integration sometimes cookies clearing required after updating default password!

Enhancements

• [#535] certify and prepare CE in marketplace using ubuntu 22.04
• [#530] switch to the released mcloud v2.4.1

Fixes

• N/A

Known Issues

• N/A

Components Updates

• mcloud 2.2.1 -> 2.4.1

Migration Steps

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

4. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

5. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (1.8.1)
 ... mcloud (2.4.1)
 ... reporting (1.27)
 ... selenoid (1.6)
 ... sonarqube (1.3)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

6. re-setup using "./zebrunner.sh setup" and restart

./zebrunner.sh setup
// complete setup
./zebrunner.sh restart

Enhancements

• [#525] Incorporated the upgrade steps for Zebrunner CE 2.1
• [#491] Moved upgrade/patch steps onto each of the sub-components
• [#485] nginx conf files are now reloaded every 6 hours
• [#455] Provided extra information for the restore operation

Fixes

• [#522] Added correct links to the docs
• [#411] There was ".disabled" present in minio-storage after setting up all the components

Known Issues

• N/A

Components Updates

• mcloud 2.0 -> 2.2.1
• selenoid 1.5 -> 1.6
• jenkins 1.8->1.8.1
• pipeline-ce 1.7->1.8

Migration Steps

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

4. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

5. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (1.8.1)
 ... mcloud (2.2.1)
 ... reporting (1.27)
 ... selenoid (1.6)
 ... sonarqube (1.3)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

6. run "upgrade" task

./zebrunner.sh upgrade
// Answer "y" to start an upgrade and restart services.

Enhancements

• [#504] Removed mcloud static resource mapping from CE
• [#494] AWS Marketplace: updated the usage instructions
• [#493] Bumped up to mcloud 1.8 with Android 12 support
• [#490] Adjusted Zebrunner Pro intro image using the new trial period

Fixes

• [#501] 400 error after opening https://demo.zebrunner.farm
• [#499] Unable to source utility.sh when launch zebrunner.sh from different folder

Open

• [#495] AWS Marketplace: start zebrunner CE automatically right after ec2 launch

Known Issues

• N/A

Components Updates

• reporting 1.26 -> 1.27
• mcloud 1.7 -> 2.0
• selenoid 1.4 -> 1.5
• jenkins 1.7->1.8
• pipeline-ce 1.6->1.7

Migration Steps

Note: It is possible to migrate from 1.0+ versions automatically!

Current steps describe migration from 1.9 release.

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

3. Apply permissions hotfix removing mcloud/configuration/stf-proxy/ssl folder which is generated under root in 1.9:

   ls -la mcloud/configuration/stf-proxy/ssl
   sudo rm -rf mcloud/configuration/stf-proxy/ssl
   

4. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

5. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (1.8)
 ... mcloud (2.0)
 ... reporting (1.27)
 ... selenoid (1.5)
 ... sonarqube (1.3)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

6. run "upgrade" task

./zebrunner.sh upgrade
// Answer "y" to start an upgrade and restart services.

7. Specify ZEBRUNNER_VERSION=1.7 updating manually jenkins/variables.env file and restart jenkins
8. Re-register every organization using Management_Jobs/registerOrganization using up-to-date reporting url and token
9. Re-register every repository using updated OrgName/RegisterRepository job
10. [Optional] Upgrade carina-core upto 7.3.15

Enhancements

• Made all sub-components individually configured to support multi-hosts and clusterized deployments
• Improved setup and startup process including non default port and SSL configuration ([#483][#480][#478][#477][#476][#475])

  Make sure to replace self-signed localhost key and certificate in ./nginx/ssl folder with production ready versions!

• Upgraded all sub-components to the latest versions including reporting, mcloud, jenkins and selenoid
• Removed basic auth protection for embedded mcloud and selenoid because 99% deployments are inside private VPC ([#482][#481])
• Documentation review and updates ([#479][#474])

Fixes

• N/A

Known Issues

• N/A

Components Updates

• reporting 1.24 -> 1.26
• jenkins-master 1.5 -> 1.7
• jenkins-slave 1.2 -> 1.3
• mcloud 1.6 -> 1.7
• selenoid 1.3 -> 1.4
• pipeline-ce 1.5.3->1.6

Migration Steps

Note: It is possible to migrate from 1.0+ versions automatically!

Current steps describe migration from 1.8 release.

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

3. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

4. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (1.7)
 ... mcloud (1.7)
 ... reporting (1.26 or 1.26.2)
 ... selenoid (1.4)
 ... sonarqube (1.3)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

5. run "upgrade" task

./zebrunner.sh upgrade
// Answer "y" to start an upgrade and restart services.

7. Login to jenkins and upgrade SSH Server plugin to 3.1.0
   • Manage Jenkins -> Manage Plugins -> Updates
   • Pick SSH Server to be upgraded to 3.1.0+

   Without manual upgrade of this plugin Jenkins stack on dependencies error on plugins!

8. Restart Jenkins
9. Make sure to upgrade carina-core upto 7.2.12!
10. [Optional] If you use your AWS S3 bucket as a storage, please, upload manually new minio test_run_results.ftl template into the s3://your-bucket/templates/

cd zebrunner
aws s3 cp reporting/minio-storage/configuration/minio/data/templates/test_run_results.ftl s3://your-bucket/templates/

Enhancements

• [#274][#451] Important! Support of launchers, github integrations via UI and project labels dropped in 1.8!
• Dropped support of ldap integration (SAML based authentication might be requested instead)
• [#434][#445][#456][#458][#464] Bump up to reporting 1.24
• [#445][#447][#463] Bump up to jenkins-master 1.5
• [#395] Bump up to jenkins-slave to 1.2

Fixes

• N/A

Known Issues

• #26 Can't attach files with new update

  Apply workaround manually updating selenoid/docker-compose.yml removing "$ENABLE_FILE_UPLOAD" argument.
  

  For details visit: https://github.com/zebrunner/selenoid/pull/27

Components Updates

• reporting 1.22 -> 1.24
• jenkins-master 1.4 -> 1.5
• jenkins-slave 1.1 -> 1.2
• pipeline-ce 1.4->1.5.3

Migration Steps

Note: It is possible to migrate from 1.0+ versions automatically!

Current steps describe migration from 1.7 release.

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

3. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

4. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (1.5)
 ... mcloud (1.6-7-ga4937a8)
 ... reporting (1.24)
 ... selenoid (1.3-6-ga7777bf)
 ... sonarqube (1.2-3-gedee3cf)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

5. run "upgrade" task

./zebrunner.sh upgrade
// Answer "y" to start an upgrade and restart services.

6. enable error message hash codes recalculation appending reporting/configuration/reporting-service/variables.env file with:

RECALCULATE_HASH_CODE_TASK_ENABLED=true
RECALCULATE_HASH_CODE_TASK_DB_QUERY_BATCH_SIZE=200
RECALCULATE_HASH_CODE_TASK_REINDEXING_DELAY=1s

7. restart reporting-service

docker rm -f reporting-service
./zebrunner.sh start

8. look into the reporting-service logs to see:

Trying to acquire redis lock by key recalculate-test-hashes-based-on-first-200-char ...
Lock was successfully acquired.
Start hashes recalculation
Downstream hashes recalculation started.
Downstream hashes recalculation finished.
Upstream hashes recalculation started.
Upstream hashes recalculation finished.
End hashes recalculation
Statistics: {...}

9. Disable recalculation RECALCULATE_HASH_CODE_TASK_ENABLED=false and restart reporting

docker rm -f reporting-service
./zebrunner.sh start

[Optional] If you use your AWS S3 bucket as a storage, please, upload manually new minio test_run_results.ftl template into the s3://your-bucket/templates/

cd zebrunner
aws s3 cp reporting/minio-storage/configuration/minio/data/templates/test_run_results.ftl s3://your-bucket/templates/

Enhancements

• [#430] Bump up to the new MCloud 1.6
• [#439] Removed jenkinsEnableVideo suite parameter from the user guide

Fixes

• [#441] During a shutdown, minio-storage_miniodata-volume was removed twice

Known Issues

• N/A

Components Updates

• mcloud 1.5 -> 1.6

Migration Steps

Note: It is possible to migrate from 1.0+ versions automatically!

Current steps describe migration from 1.6 release.

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

3. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

4. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (1.5)
 ... mcloud (1.6)
 ... reporting (1.22)
 ... selenoid (1.3^2)
 ... sonarqube (1.2-2-gcd35598)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

5. run "upgrade" task

./zebrunner.sh upgrade
// Answer "y" to start an upgrade and restart services.

Enhancements

• [#428] Documented how to increase screenshot filesize for reporting
• [#424] Upgraded selenoid to 1.3

Fixes

• [#427] Web demo test contained an error message in log

Known Issues

• N/A

Components Updates

• reporting 1.20 -> 1.22
• mcloud 1.4 -> 1.5 (mcloud-grid 1.1 -> 1.2)

Migration Steps

Note: It is possible to migrate from 1.0+ versions automatically!

Current steps describe migration from 1.5 release.

1. it is recommended to make a "golden" backup running backup task and making a copy of zebrunner folder

./zebrunner.sh backup
cp -r ../zebrunner ../zebrunner.bak

2. start services and make sure everything is up&running!

./zebrunner.sh start

3. pull recursively latest changes and verify that sub-modules are valid

git pull --recurse-submodules

4. Important! Verify that submodules have below versions:

git submodule status
 ... jenkins (1.5)
 ... mcloud (1.5)
 ... reporting (1.22)
 ... selenoid (1.3^2)
 ... sonarqube (1.2-2-gcd35598)

There is no sense to continue if any sub-module has older version! Ask for the assistance in telegram

5. run "upgrade" task

./zebrunner.sh upgrade
// Answer "y" to start an upgrade and restart services.