Skip to content

Commit fbc58de

Browse files
authored
Minor documentation refactoring (#2365)
1 parent dc0496c commit fbc58de

File tree

2 files changed

+8
-46
lines changed

2 files changed

+8
-46
lines changed

docs/book/src/topics/capibmadm/index.md

Lines changed: 7 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,17 @@ Kubernetes Cluster API Provider IBM Cloud Management Utility
44

55
## Install capibmadm
66

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

10-
Download for AMD64:
1110
```bash
12-
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-linux-amd64 -o capibmadm
11+
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
1312
```
14-
15-
Download for ARM64:
16-
```bash
17-
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-linux-arm64 -o capibmadm
18-
```
19-
20-
Download for PPC64LE:
21-
```bash
22-
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-linux-ppc64le -o capibmadm
23-
```
24-
25-
Make the capibmadm binary executable.
26-
```bash
27-
chmod +x ./capibmadm
28-
```
29-
Move the binary in to your PATH.
30-
```bash
31-
sudo mv ./capibmadm /usr/local/bin/capibmadm
32-
```
33-
Test to ensure the version you installed is up-to-date:
34-
```bash
35-
capibmadm version -o short
36-
```
37-
38-
#### Install capibmadm binary with curl on macOS
39-
If you are unsure you can determine your computers architecture by running `uname -a`
40-
41-
Download for AMD64:
42-
```bash
43-
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-darwin-amd64 -o capibmadm
44-
```
45-
46-
Download for M1 CPU ("Apple Silicon") / ARM64:
47-
```bash
48-
curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.7.0/capibmadm-darwin-arm64 -o capibmadm
49-
```
50-
51-
Make the capibmadm binary executable.
13+
Add the execute bit to the binary.
5214
```bash
5315
chmod +x ./capibmadm
5416
```
55-
Move the binary in to your PATH.
17+
Move the binary to $PATH.
5618
```bash
5719
sudo mv ./capibmadm /usr/local/bin/capibmadm
5820
```
@@ -66,13 +28,13 @@ Go to the working directory where you want capibmadm downloaded.
6628

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

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

docs/book/src/topics/vpc/uploading-an-image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Service VPC Infrastructure Services in Resource_group <your_resource_group_or_ac
4444
target: service Cloud object storage in resource_group <your_resource_group_or_account>
4545
```
4646

47-
3) Go to https://cloud.ibm.com/vpc-ext/provision/customImage
47+
3) Go to [https://cloud.ibm.com/vpc-ext/provision/customImage](https://cloud.ibm.com/vpc-ext/provision/customImage)
4848
* Fill in imagename, resource group or account
4949
* Choice box: Cloud Object Storage
5050
* Set Filter: <your_cos_plain_name> <eu-de_or_other> <your_vm_bucket>

0 commit comments

Comments
 (0)