Update deploy-intro.html #48170
Update deploy-intro.html #48170
Conversation
k8s-ci-robot
added
the
cncf-cla: no
|
Welcome @kevinjamescasey! |
k8s-ci-robot
added
size/XS
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -121,6 +121,7 @@ <h3>kubectl basics</h3> | |||
| <a id="deploy-an-app"></a> | |||
| <h3>Deploy an app</h3> | |||
| <p>Let’s deploy our first app on Kubernetes with the <code>kubectl create deployment</code> command. We need to provide the deployment name and app image location (include the full repository url for images hosted outside Docker Hub).</p> | |||
| <div class="alert alert-info note callout" role="alert"><strong>Note:</strong> This only works on certain CPU architectures and may not work on your machine.</div> | |||
There was a problem hiding this comment.
Thanks
Can we use a note shortcode here? See https://kubernetes.io/docs/contribute/style/hugo-shortcodes/
There was a problem hiding this comment.
Yeah. Those docs don't explicitly mention a note shortcode, but I do see {{< note >}} used in some places. So I guess that is a shortcode.
I now see a note at the top of the page, so maybe this note is not needed.
The note at the top is easy to disregard. It is not until after the kubectl create deployment and kubectl get deployments that you find out that the image will not work.
Perhaps that is the best place to mention something like "If you see 0/1 ready then you will need to use a different image that was works on your machine, a machine with an AMD64 CPU, or a driver that can emulate AMD64"
Most of the tutorial still works if you use the registry.k8s.io/e2e-test-images/agnhost:2.39 image from the Hello Minikube page. That image is built for multiple architectures. It is a shame to tell someone at the start of the tutorial that "it might not work on your machine". I think they would prefer to focus on getting through most of the tutorial content rather than being distracted by this issue. The only part I've found that doesn't work with that image is the cat server.js command in Viewing Pods and Nodes.
The note at the top doesn't really explain what to do to make it work. I'm assuming that installing Docker Desktop is required. Since I can legally get Docker Desktop for free, I'll try it. I don't know if there is some other way to get the appropriate driver. I don't really even know what "driver" means in this context.
There was a problem hiding this comment.
After much investigating I figured out how to run the tutorial's image successfully on an Apple chip. I update the note at the top of the page to make it clear what to do.
It can still be easily be overlooked, because it requires the reader to recognize the chip architecture name/code mentioned and know that it doesn't match their machine.
There was a problem hiding this comment.
Hi @kevinjamescasey I'm an independent developer unaffiliated with this project and I just ran into this same issue (I'm on Apple silicon).
I tried running the command you noted (minikube start driver=docker) but no luck. I'm guessing I need to have Docker Desktop installed in order to utilize that flag.
I think that, even if we can't get that specific image working for the tutorial, including the note that you're adding is a step in the right direction 😄
| @@ -30,7 +30,9 @@ <h3>Kubernetes Deployments</h3> | |||
| {{< note >}} | |||
| <p>This tutorial uses a container that requires the AMD64 architecture. If you are using | |||
| minikube on a computer with a different CPU architecture, you could try using minikube with | |||
| a driver that can emulate AMD64. For example, the Docker Desktop driver can do this.</p> | |||
| a driver that can emulate AMD64. For example, the Docker Desktop driver can do this. You can | |||
| make sure Docker Deskstop is running when you issue your first `minikube start` command. If | |||
k8s-ci-robot
added
cncf-cla: no
Yes, I believe your guess is correct. I don't remember the details, but I have this note from a post on my own website.
If Docker Desktop is the default and someone running on Apple silicon happens to already have it installed and running, then the tutorial should work for them.
I hope the extra clarifications can get merged in and help some people, but I think switching the tutorial to use a multi-architecture image (like the one in the Hello Minikube tutorial) that just works for almost everyone would be better overall. That way people wouldn't have to get distracted by esoteric caveats. They can just focus on learning the tutorial's intended lesson. |
|
@kevinjamescasey you must provide a valid copyright licence before we can accept this change - see https://api.easycla.lfx.linuxfoundation.org/v2/repository-provider/github/sign/18706487/51478266/48170/#/?version=2 |
kevinjamescasey
force-pushed
the
patch-1
branch
from
d5fd85b to
3d5a5dc
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Add note to alert people that the command might not work on their machine depending on the CPU architecture
Explain how to ensure `docker` driver is used for non-AMD64 users.
kevinjamescasey
force-pushed
the
patch-1
branch
from
3d5a5dc to
03fa185
Compare
k8s-ci-robot
added
cncf-cla: yes
k8s-ci-robot
added
the
needs-rebase
|
PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Description
Add note to alert people that the command might not work on their machine depending on the CPU architecture, because it is difficult for someone trying to learn from the tutorial to have to troubleshoot the problem. At least this will give them a clue.
Issue
#45420