-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Output a URL with instructions after running linkerd upgrade
#2627
Conversation
Integration test results for 805e230: success 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Two comments below.
What do you all think about appending an anchor with the version into that url? We could link directly to the upgrade notice for that version (if any). The downside is that if the user is upgrading from a much older version they'll require to check not only the current upgrade notice but also previous ones. |
@alpeb sounds great to me. I've got an outstanding issue to start versioning the docs, so we could use the anchor to redirect to the correct version. |
@grampelberg @alpeb I like the ⚓️ idea. I separated them out into success and failure, would that work with the doc architecture? Re: specific version numbers, when running |
Integration test results for 7f22e2f: success 🎉 |
It looks like I can decide which version number to upgrade/downgrade to with
@olix0r Does this look right to you? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Big overall improvement! One minor nit:
$ bin/go-run cli upgrade | kubectl apply -f -
namespace/linkerd unchanged
configmap/linkerd-config configured
serviceaccount/linkerd-identity unchanged
clusterrole.rbac.authorization.k8s.io/linkerd-linkerd-identity unchanged
√ You're on your way to upgrading Linkerd!
Visit this URL for further instructions: https://linkerd.io/upgrade/#nextsteps
clusterrolebinding.rbac.authorization.k8s.io/linkerd-linkerd-identity unchanged
service/linkerd-identity configured
secret/linkerd-identity-issuer configured
deployment.extensions/linkerd-identity configured
serviceaccount/linkerd-controller unchanged
clusterrole.rbac.authorization.k8s.io/linkerd-linkerd-controller unchanged
clusterrolebinding.rbac.authorization.k8s.io/linkerd-linkerd-controller unchanged
service/linkerd-controller-api configured
service/linkerd-destination configured
deployment.extensions/linkerd-controller configured
customresourcedefinition.apiextensions.k8s.io/serviceprofiles.linkerd.io configured
serviceaccount/linkerd-web unchanged
service/linkerd-web configured
deployment.extensions/linkerd-web configured
serviceaccount/linkerd-prometheus unchanged
clusterrole.rbac.authorization.k8s.io/linkerd-linkerd-prometheus unchanged
clusterrolebinding.rbac.authorization.k8s.io/linkerd-linkerd-prometheus unchanged
service/linkerd-prometheus configured
deployment.extensions/linkerd-prometheus configured
configmap/linkerd-prometheus-config configured
serviceaccount/linkerd-grafana unchanged
service/linkerd-grafana configured
deployment.extensions/linkerd-grafana configured
configmap/linkerd-grafana-config configured
The instructions get lost in the wall of text (and loose the colors because of pipes). How about a couple newlines afterwards? Maybe a separator?
@grampelberg Interesting find. It also looks like |
Integration test results for cc41777: success 🎉 |
Ok, now we're rendering values to a buffer, which prints when the render is complete. That way the (Unfortunately the colors won't print when piping to Outstanding question @grampelberg @ihcsim are the URLs ok? Right now they are: |
URLs work for me! |
Those URLs 404 for me. Should they be https://linkerd.io/2/tasks/upgrade/#upgrade-the-data-plane for success and https://linkerd.io/2/tasks/upgrade/#step-by-step-instructions for failure? |
The URLs LGTM. @grampelberg Are we setting URL redirects for these URLs? |
Re: redirects -- hugo strips anchors when redirecting, so it won't work for https://linkerd.io/upgrade/#nextsteps to redirect to a #nextsteps anchor on a different page. We'd need to link to that page directly for the anchor to work. By way of example, see how https://linkerd.io/2/ha/#setup redirects to https://linkerd.io/2/features/ha/, which drops the #setup anchor. |
@klingerf Re: redirects, I had assumed that we could set up Implemented as static HTML: I've found this approach useful for |
@siggy Ah, that's a good approach. I wasn't aware that we were doing non-hugo redirects. Carry on. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
⭐️ Nice work! I like this approach a lot, and had just a few tiny style nits.
URLs look good to me. @scottcarol do you mind adding those when this PR merges? |
@grampelberg To clarify, you're saying the URLs look good as written: success: and that I should add the URL forwarding to Can do! There have been a lot of different URLs mentioned in this PR so I want to be sure I've got it right. |
@scottcarol yup, and yes please! |
Integration test results for 5fc8238: success 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 💯
…rd#2627) Adds a URL to the `linkerd upgrade` output which contains full upgrade instructions. The message and the URL anchors are different in the case of success or failure. Fixes linkerd#2575. Signed-off-by: [email protected] <[email protected]>
Fixes #2575. When a user successfully runs
linkerd upgrade
in the CLI, they will see a message after theyaml
output pointing to a URL with full upgrade instructions.