Skip to content
New issue

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

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

Already on GitHub? # to your account

windows section for Install clusterctl in quick start #6161

Closed
ykakarap opened this issue Feb 17, 2022 · 11 comments · Fixed by #6177
Closed

windows section for Install clusterctl in quick start #6161

ykakarap opened this issue Feb 17, 2022 · 11 comments · Fixed by #6177
Assignees
Labels
area/clusterctl Issues or PRs related to clusterctl kind/documentation Categorizes issue or PR as related to documentation.
Milestone

Comments

@ykakarap
Copy link
Contributor

Given that now we are shipping a windows amd64 version of clusterctl should we add a Windows section to the Install clusterctl section of the quickstart?

This would imply that the rest of the quick start flow also needs to be evaluated for the same.

/area clusterctl
/kind docs

@k8s-ci-robot k8s-ci-robot added the area/clusterctl Issues or PRs related to clusterctl label Feb 17, 2022
@k8s-ci-robot
Copy link
Contributor

@ykakarap: The label(s) kind/docs cannot be applied, because the repository doesn't have them.

In response to this:

Given that now we are shipping a windows amd64 version of clusterctl should we add a Windows section to the Install clusterctl section of the quickstart?

This would imply that the rest of the quick start flow also needs to be evaluated for the same.

/area clusterctl
/kind docs

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/test-infra repository.

@ykakarap
Copy link
Contributor Author

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 17, 2022
@sbueringer
Copy link
Member

I wonder how similar the quickstart is for Windows / how much we have to change / add branching for

@ykakarap
Copy link
Contributor Author

I am not sure either. Will have to run through the quickstart on a windows machine to figure out how much and what needs to change.

@VibhorChinda
Copy link
Contributor

Steps for installing clusterctl on windows :

  1. Go to the working directory where you want clusterctl downloaded.
  2. run curl -o clusterctl.exe "https://github.com/kubernetes-sigs/cluster-api/releases/download/v1.1.1/clusterctl-windows-amd64.exe"
  3. Add the path of that directory to path environment variable.
  4. run clusterctl version command to crosscheck proper working ✌️

clusterctl windows

@fabriziopandini
Copy link
Member

/milestone v1.2
That would be a nice addition

@k8s-ci-robot k8s-ci-robot added this to the v1.2 milestone Feb 18, 2022
@ykakarap
Copy link
Contributor Author

@VibhorChinda Would you want to open a PR to add this section to the quick start guide?

@VibhorChinda
Copy link
Contributor

@ykakarap I would love to.
Can you please point out the path of the file where need to add this section in the repo.

@ykakarap
Copy link
Contributor Author

ykakarap commented Feb 18, 2022

@VibhorChinda Great!

You will need to modify this file:

### Install clusterctl
The clusterctl CLI tool handles the lifecycle of a Cluster API management cluster.
{{#tabs name:"install-clusterctl" tabs:"linux,macOS,homebrew"}}
{{#tab linux}}
#### Install clusterctl binary with curl on linux
Download the latest release; on linux, type:
```
curl -L {{#releaselink gomodule:"sigs.k8s.io/cluster-api" asset:"clusterctl-linux-amd64" version:"1.1.x"}} -o clusterctl
```
Make the clusterctl binary executable.
```
chmod +x ./clusterctl
```
Move the binary in to your PATH.
```
sudo mv ./clusterctl /usr/local/bin/clusterctl
```
Test to ensure the version you installed is up-to-date:
```
clusterctl version
```
{{#/tab }}
{{#tab macOS}}
#### Install clusterctl binary with curl on macOS
Download the latest release; on macOS, type:
```
curl -L {{#releaselink gomodule:"sigs.k8s.io/cluster-api" asset:"clusterctl-darwin-amd64" version:"1.1.x"}} -o clusterctl
```
Or if your Mac has an M1 CPU ("Apple Silicon"):
```
curl -L {{#releaselink gomodule:"sigs.k8s.io/cluster-api" asset:"clusterctl-darwin-arm64" version:"1.1.x"}} -o clusterctl
```
Make the clusterctl binary executable.
```
chmod +x ./clusterctl
```
Move the binary in to your PATH.
```
sudo mv ./clusterctl /usr/local/bin/clusterctl
```
Test to ensure the version you installed is up-to-date:
```
clusterctl version
```
{{#/tab }}
{{#tab homebrew}}
#### Install clusterctl with homebrew on macOS and linux
Install the latest release using homebrew:
```bash
brew install clusterctl
```
Test to ensure the version you installed is up-to-date:
```
clusterctl version
```
{{#/tab }}
{{#/tabs }}

Lines 95-162 have the section for the individual tabs for the clusterctl install step.
You can copy the section for one of the existing tabs and modify it as needed for windows.

To render the book locally you can run make serve-book. (The markdown does not render properly in most editor's default renderer). You can use this to verify your changes.

@VibhorChinda
Copy link
Contributor

@ykakarap thanks will submit the PR soon ✌️

@sayantani11
Copy link
Contributor

/assign @VibhorChinda

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
area/clusterctl Issues or PRs related to clusterctl kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants