kind icon indicating copy to clipboard operation
kind copied to clipboard

Documentation: display installation instructions for arm64 linux machines

Open jpmcb opened this issue 1 year ago • 5 comments

What would you like to be documented:

Currently, only x86 installation instructions are present. It'd be nice if the arm install instructions were next to the x86 ones (similar to how the mac m1 vs intel instructions are next to eachother)

Something like:


On Linux:

# For x86 architecture:
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.14.0/kind-linux-amd64
# For arm architecture:
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.14.0/kind-linux-arm64
chmod +x ./kind
sudo mv ./kind /usr/local/bin/kind

Why is this needed:

When I installed kind on a new-ish arm dev machine, I used the instructions (without reading them super hard) for x86 which resulted in error when attempting to run that binary.

I'd be happy to submit a patch for this if it sounds good! 🚀

jpmcb avatar Aug 08 '22 18:08 jpmcb

I worry about making this documentation 10 pages of confusing instructions 😞

Let's at least use uname as well to make it possible to continue pasting the whole code block

BenTheElder avatar Aug 08 '22 18:08 BenTheElder

I worry about making this documentation 10 pages of confusing instructions

Yeah, seems to be the world we live in these days 😭

uname is a good idea since the names of kind's releases differ from the name returned by uname for arm:

❯ uname --machine
aarch64

jpmcb avatar Aug 08 '22 18:08 jpmcb

I was just taking a peek at this again and the kind docs actually do this already for macOS with [ $(uname -m) = x86_64] && ... etc., we should be able to adapt that.

BenTheElder avatar Aug 08 '22 18:08 BenTheElder

Sounds good! /assign

jpmcb avatar Aug 08 '22 19:08 jpmcb

As long as we are copy/paste-ing instructions instead of letting the computer do it, we used JavaScript in minikube to make the selection less cluttered...

https://minikube.sigs.k8s.io/docs/start/

afbjorklund avatar Aug 09 '22 06:08 afbjorklund

As long as we are copy/paste-ing instructions instead of letting the computer do it, we used JavaScript in minikube to make the selection less cluttered...

The macOS docs have the computer do it ...

# for Intel Macs
[ $(uname -m) = x86_64 ]&& curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.18.0/kind-darwin-amd64
# for M1 / ARM Macs
[ $(uname -m) = arm64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.18.0/kind-darwin-arm64
chmod +x ./kind
mv ./kind /some-dir-in-your-PATH/kind

BenTheElder avatar Apr 18 '23 03:04 BenTheElder

NOTE: uname -m values for arm64 are not the same on mac and Linux! https://unix.stackexchange.com/questions/683360/why-does-hostnamectl-return-arm64-but-uname-returns-aarch64-ubuntu-20-04-2-on

BenTheElder avatar Apr 18 '23 03:04 BenTheElder

This is done. EDIT: I had hoped this would make a good starter issue, but eventually it just made sense to fix this.

BenTheElder avatar May 17 '23 06:05 BenTheElder

Thanks Ben! ❤️

jpmcb avatar May 17 '23 15:05 jpmcb