patch: Add deprecation notice for balenalib base images#465
patch: Add deprecation notice for balenalib base images#465flowzone-app[bot] merged 1 commit intomasterfrom
Conversation
| @@ -1 +1 @@ | |||
| RUN [ ! -d /.balena/messages ] && mkdir -p /.balena/messages; echo $'Here are a few details about this Docker image (For more information please visit https://www.balena.io/docs/reference/base-images/base-images/): \nArchitecture: {{arch.sw.name}} \nOS: {{sw.os.name}} \nVariant: {{sw.stack-variant.name}} \nDefault variable(s): UDEV=off \nExtra features: \n- Easy way to install packages with `install_packages <package-name>` command \n- Keep the container idling with `balena-idle` command \n- Show base image details with `balena-info` command' > /.balena/messages/image-info | |||
| RUN [ ! -d /.balena/messages ] && mkdir -p /.balena/messages; echo $'This base image is deprecated and will no longer receive updates. Please see our blog post (https://blog.balena.io/deprecate-balenalib-images/) for migration guidance and suggested alternatives. Here are a few details about this Docker image (For more information please visit https://www.balena.io/docs/reference/base-images/base-images/): \nArchitecture: {{arch.sw.name}} \nOS: {{sw.os.name}} \nVariant: {{sw.stack-variant.name}} \nDefault variable(s): UDEV=off \nExtra features: \n- Easy way to install packages with `install_packages <package-name>` command \n- Keep the container idling with `balena-idle` command \n- Show base image details with `balena-info` command' > /.balena/messages/image-info | |||
There was a problem hiding this comment.
I was thinking about this since we last spoke, and I wonder if a fixed URL is a bad idea on the unlikely event it ever changes (these images are static obviously).
Maybe we should just point to "our blog" and "our docs" just to be future-proof and avoid tying ourselves to a URL forever?
WDYT @shaunmulligan
There was a problem hiding this comment.
In terms of specific resources, the blog would be the most persistent, highly available entity we have.
If the URL changes, then it can be remapped using our CF redirect worker
I am assuming as long as balena is alive, there will be a blog albeit sometimes the URL structure might change with changing blog frameworks.
Open to discussions. GitHub gist type options could be considered.
There was a problem hiding this comment.
yeah, I think it should be okay, but @vipulgupta2048 I guess the larger question is, how do we remind our future selves that this specific URL needs to be remapped or kept alive in the likely event that we change things in the future. It's definitely easy to know that a URL can be remapped, but how do we remember to do it :P
There was a problem hiding this comment.
Few options.
Detection: Docs would mention the blog post, and the link checker keeps a check on the availability of the URL.
Reminder: Can add that context into https://github.com/balena-io/environment-production/blob/master/cloudflare/kv/redirects.yml as a comment
These actions still miss the context or the importance of the URL being preserved. We need a flare to be sent up if the URL goes down?
Faster detection: Track the URL using nodeping on our status dashboard as we do for other URLs, if it goes down team gets notified.
There was a problem hiding this comment.
Detection: Docs would mention the blog post, and the link checker keeps a check on the availability of the URL.
Reminder: Can add that context into https://github.com/balena-io/environment-production/blob/master/cloudflare/kv/redirects.yml as a comment
IMO this is enough
There was a problem hiding this comment.
You won't be able to run checks on that PR (Flowzone not enabled for forks) so I can cherry-pick that change for you.
There was a problem hiding this comment.
I'm going to try to expedite write access to those repos for the greater team. Will keep you posted.
There was a problem hiding this comment.
Thanks, we can get this PR merged then? @klutchell
There was a problem hiding this comment.
@vipulgupta2048 I would prefer to merge this once the blog post is live.
Once the contacts are updated, there will be new base images published on June 1st whether we are ready or not.
We can disable the schedule, but it won't stop someone from manually running a base images build to unblock someone in support. I would prefer we update contracts when the link is live (it's still draft isn't it?)
vipulgupta2048
force-pushed
the
vipulgupta2048/deprecate-balenalib
branch
from
0674823 to
9c5f067
Compare
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
vipulgupta2048
force-pushed
the
vipulgupta2048/deprecate-balenalib
branch
from
9c5f067 to
46ba3d7
Compare
|
/rebase |
git-basejump
bot
force-pushed
the
vipulgupta2048/deprecate-balenalib
branch
from
46ba3d7 to
8d980c8
Compare
3 participants
Part of the base images deprecation project, we are adding a notice to balenalib base images to output a message with the deprecation message which would link to the blog post.
Signed-off-by: Vipul Gupta (@vipulgupta2048) vipulgupta2048@gmail.com