Skip to content

Minor documentation refactoring #2365

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 21, 2025
Merged

Minor documentation refactoring #2365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 7 additions & 45 deletions docs/book/src/topics/capibmadm/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,55 +4,17 @@ Kubernetes Cluster API Provider IBM Cloud Management Utility

## Install capibmadm

#### Install capibmadm binary with curl on Linux
If you are unsure you can determine your computers architecture by running `uname -a`
#### Install capibmadm binary with curl on Linux / MacOS
Run the following command to download the capibmadm binary:

Download for AMD64:
```bash
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-linux-amd64 -o capibmadm
curl -L "https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.11.0/capibmadm-$(echo "$(uname -s)" | tr A-Z a-z)-$(uname -m)" -o capibmadm
```

Download for ARM64:
```bash
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-linux-arm64 -o capibmadm
```

Download for PPC64LE:
```bash
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-linux-ppc64le -o capibmadm
```

Make the capibmadm binary executable.
```bash
chmod +x ./capibmadm
```
Move the binary in to your PATH.
```bash
sudo mv ./capibmadm /usr/local/bin/capibmadm
```
Test to ensure the version you installed is up-to-date:
```bash
capibmadm version -o short
```

#### Install capibmadm binary with curl on macOS
If you are unsure you can determine your computers architecture by running `uname -a`

Download for AMD64:
```bash
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-darwin-amd64 -o capibmadm
```

Download for M1 CPU ("Apple Silicon") / ARM64:
```bash
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-darwin-arm64 -o capibmadm
```

Make the capibmadm binary executable.
Add the execute bit to the binary.
```bash
chmod +x ./capibmadm
```
Move the binary in to your PATH.
Move the binary to $PATH.
```bash
sudo mv ./capibmadm /usr/local/bin/capibmadm
```
Expand All @@ -66,13 +28,13 @@ Go to the working directory where you want capibmadm downloaded.

Download the latest release on AMD64; on Windows, type:
```powershell
curl.exe -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-windows-amd64.exe -o capibmadm.exe
curl.exe -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.11.0/capibmadm-windows-amd64.exe -o capibmadm.exe
```
Append or prepend the path of that directory to the `PATH` environment variable.

Download the latest release on ARM64; on Windows, type:
```powershell
curl.exe -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-windows-arm64.exe -o capibmadm.exe
curl.exe -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.11.0/capibmadm-windows-arm64.exe -o capibmadm.exe
```
Append or prepend the path of that directory to the `PATH` environment variable.

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/topics/vpc/uploading-an-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Service VPC Infrastructure Services in Resource_group <your_resource_group_or_ac
target: service Cloud object storage in resource_group <your_resource_group_or_account>
```

3) Go to https://cloud.ibm.com/vpc-ext/provision/customImage
3) Go to [https://cloud.ibm.com/vpc-ext/provision/customImage](https://cloud.ibm.com/vpc-ext/provision/customImage)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously:
image

Through the PR:
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ref: #2223 (comment)

* Fill in imagename, resource group or account
* Choice box: Cloud Object Storage
* Set Filter: <your_cos_plain_name> <eu-de_or_other> <your_vm_bucket>
Expand Down