Skip to content

Conversation

@B0r1sD
Copy link
Contributor

@B0r1sD B0r1sD commented Mar 12, 2025

First changes for the Upgrading Galaxy GTN that is currently outdated.

The main reason for this PR is the addition of a generalised draft version of the checklist we use when upgrading usegalaxy.be, so other Galaxy admins could use for inspiration when upgrading their instance. it includes a lot of points from our change management process, which I believe is a NIS2 requirement which makes it quite thorough.
The checklist is in general quite catered to how the Belgian instance is set up, so please add suggestions to make it less instance specific where possible! I'll need some help updating the rest of the tutorial.

I have not deployed this locally so it probably looks wrong.

All feedback and contributions welcome!
TODO:

  • Build GTN locally
    • See if checkboxes work
  • Update rest of the tutorial's text
  • Update tutorial screenshots
  • Discuss checklist with Galaxy (instance) admins
  • Add myself as contributor
  • ...

@pauldg and me are also looking into BioBlend if it could help with the testing of some popular tools and workflows. But this is out of scope for this pull request (testing done manually atm).

First changes for the Upgrading Galaxy GTN that is outdated. Added the first draft for a checklist Galaxy admins could use when upgrading their instance. Updating this GTN is not completed.
@github-actions github-actions bot added the admin label Mar 12, 2025
* Each version also has an official branch in the GitHub repo named `release_YY.MM`. e.g. *release_21.01*
The latest updates on the Galaxy release proces can be found here: https://docs.galaxyproject.org/en/master/project/releases.html

- Long Term Support (LTS) releases happen annually, in the first quarter.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe just pont to https://docs.galaxyproject.org/en/master/project/releases.html .. this way the info in GTN can not go outdated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah that was my initial idea, thought copying it over would ensure more people read it. It is an easy change then.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a very short summary here

@B0r1sD
Copy link
Contributor Author

B0r1sD commented Aug 14, 2025

To be completed after we've upgraded to v25.0 and put the upgrade checklist in practice on more time.

> - [ ] Bring Your Own Storage connection
>
### Production Upgrade
If the Tests on the test instance were successful, initiate poduction upgrade process.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If the Tests on the test instance were successful, initiate poduction upgrade process.
If the Tests on the test instance were successful, initiate production upgrade process.

Congratulations, you're Galaxy server should now be updated to the latest version. You can check this by going to the Admin UI page or by using the API as described above.
Congratulations, your Galaxy server should now be updated to the latest version. You can check this by going to the Admin UI page or by using the API as described above.
> <hands-on-title>Upgrade checklist</hands-on-title>
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this all section be moved before the upgrade instructions?

> - [ ] Merge notice banner at least one week in advance
> - [ ] Make a draft pull request for a news item, which includes emphasis on reporting unexpected behavior, and any new features or changes
> - [ ] See if the GDPR compliance / data policy page requires updating after the new changes
> - [ ] Roll back if significant issues arise, following the regression steps
Copy link
Member

Choose a reason for hiding this comment

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

Should this line be moved to Post-upgrade ?

> - [ ] Exporting data
> - [ ] Exporting workflow runs
> - [ ] Making a new history
> - [ ] Removing data
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> - [ ] Removing data
> - [ ] Deleting and purging datasets

> - [ ] Exporting workflow runs
> - [ ] Making a new history
> - [ ] Removing data
> - [ ] Removing histories
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> - [ ] Removing histories
> - [ ] Deleting and purging histories

> - [ ] Making a new history
> - [ ] Removing data
> - [ ] Removing histories
> - [ ] Pulsar
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> - [ ] Pulsar
> - [ ] Running a job via Pulsar (if configured)

Comment on lines +305 to +306
> - [ ] Make a pull request to add a notice banner via notices.yml in the relevant repository
> - [ ] Merge notice banner at least one week in advance
Copy link
Member

Choose a reason for hiding this comment

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

I suppose these are specific to your setup?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants