Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docker: add migration page #513

Merged
merged 1 commit into from
Mar 17, 2023

Conversation

ntarocco
Copy link
Contributor

New section under "upgrade guide":

Screenshot 2023-03-16 at 11 21 39

@ntarocco ntarocco requested a review from fenekku March 16, 2023 10:23
Copy link
Member

@slint slint left a comment

Choose a reason for hiding this comment

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

Thanks, looks great and very clear!

On a separate note, since we're hosting the images are there any ratelimits on our side at the CERN registry? Should we also recommend that people should look into having registry proxy/caches?

@ntarocco
Copy link
Contributor Author

On a separate note, since we're hosting the images are there any ratelimits on our side at the CERN registry? Should we also recommend that people should look into having registry proxy/caches?

There are limitations at the moment. At the same time, I agree with you, I would not advertise this, and I would suggest having a proxy. I will add a line ;) Thanks!

@ntarocco
Copy link
Contributor Author

ntarocco commented Mar 16, 2023

I will make some changes to avoid switching to AlmaLinux, but use the CERN registry instead also for old images.

Copy link
Collaborator

@fenekku fenekku left a comment

Choose a reason for hiding this comment

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

Thanks this is really helpful.

The change to almalinux actually incurs a change in the minimum version of docker that InvenioRDM supports. We discovered this the hard way: inveniosoftware/docker-invenio#75 . The system requirements should be updated to something like:

- [Docker](https://docs.docker.com) 20.10.10+ 

(some kind of InvenioRDM version indicator would help in the future)
(docker uses sort-of calver now)

Overall, these docs are also the kind of thing that is worth proselytizing on discord / blog post, so that more community members are aware of them before things suddenly stop working.

@ntarocco
Copy link
Contributor Author

There are some news: https://www.docker.com/blog/we-apologize-we-did-a-terrible-job-announcing-the-end-of-docker-free-teams/
I will make changes to this PR in the coming days.

@ntarocco
Copy link
Contributor Author

I have updated the doc page, mainly rephrasing the text from will fail to might fail, give the latest announcement of Docker.

@fenekku

Thanks this is really helpful.

The change to almalinux actually incurs a change in the minimum version of docker that InvenioRDM supports. We discovered this the hard way: inveniosoftware/docker-invenio#75 . The system requirements should be updated to something like:

- [Docker](https://docs.docker.com) 20.10.10+ 

Thanks for this, added.

(some kind of InvenioRDM version indicator would help in the future) (docker uses sort-of calver now)

Just for me to be sure that I have correctly understood, do you propose changing the future version numbers of InvenioRDM (v9, v10, ...) to use a CalVer?

Overall, these docs are also the kind of thing that is worth proselytizing on discord / blog post, so that more community members are aware of them before things suddenly stop working.

This makes sense indeed: the current plan is to add it to the doc, announce it at the telecon + chat.
You could make this suggestion in the next telecon and see if others would be in favour of blog posts for such cases (it will require more effort :().

@zzacharo zzacharo merged commit 8e94c28 into inveniosoftware:master Mar 17, 2023
@fenekku
Copy link
Collaborator

fenekku commented Mar 17, 2023

For this

(some kind of InvenioRDM version indicator would help in the future)

I meant:

As InvenioRDM accumulates versions with different features, it can become hard for documentation readers to understand which version of InvenioRDM is relevant to the documentation they are reading e.g., v11 of InvenioRDM requires Docker 20.10.10+ but v9 didn't. The problem of how to convey that is something to look into again in the future. We already have the ticket: #44 but as explained there the attempt has fell through.

Another way than what was attempted in the ticket would be to textually write it in (a-la python docs) by adding in situ New in version vX.Y., or Changed in version vX.Y: phlogiston now boombazzles or so on...

Nothing specific to do for now, but raise importance of that ticket.

For this

(docker uses sort-of calver now)

It was just to highlight how we can look at docker's version number to know how old the version of it is (soft of since 20.10.10 came out in 2021-10. Although when I think about it, it actually makes sense since it was a patched release). This is something to keep in mind since Docker doesn't do LTS in practice (their time frames are way too short). Nothing to do there either - just informative.

@ntarocco ntarocco deleted the docker-migration branch March 20, 2023 08:33
@ntarocco
Copy link
Contributor Author

Another way than what was attempted in the ticket would be to textually write it in (a-la python docs) by adding in situ New in version vX.Y., or Changed in version vX.Y: phlogiston now boombazzles or so on...

We are already doing this, see for example here. It would be nice indeed to have the doc versioned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants