Skip to content

Commit 7f5f66c

Browse files
authored
Merge pull request #20 from deepu105/doc-improvements
Update docs for clarity and consistency
2 parents acad5c3 + 57b692c commit 7f5f66c

File tree

8 files changed

+29
-18
lines changed

8 files changed

+29
-18
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,6 @@ typings/
7474

7575
# next.js build output
7676
.next
77+
78+
# Hugo build lock
79+
.hugo_build.lock

content/howto/bootstrapping.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,10 +160,12 @@ users:
160160

161161
### Running Krustlet
162162

163+
> If you came here from a how-to guide for a specific platform, you can skip this section and return to that guide to continue.
164+
163165
Once you have the bootstrap config in place, you can run Krustlet:
164166

165167
```console
166-
$ KUBECONFIG=~/.krustlet/config/kubeconfig krustlet-wasi --port 3000 --bootstrap-file /path/to/your/bootstrap.conf
168+
$ KUBECONFIG=~/.krustlet/config/kubeconfig krustlet-wasi --port 3000 --bootstrap-file=/path/to/your/bootstrap.conf
167169
```
168170

169171
Krustlet will begin the bootstrapping process, and then **await manual

content/howto/krustlet-on-kind.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,11 @@ Once you have done that, run the following commands to run Krustlet's WASI
7777
provider:
7878

7979
```console
80-
# Since you are running locally, this step is important. Otherwise krustlet will pick up on your
81-
# local config and not be able to update the node status properly
82-
$ export KUBECONFIG=~/.krustlet/config/kubeconfig
83-
$ krustlet-wasi --node-ip 172.17.0.1 --bootstrap-file=~/.krustlet/config/bootstrap.conf
80+
$ KUBECONFIG=~/.krustlet/config/kubeconfig \
81+
krustlet-wasi \
82+
--node-ip 172.17.0.1 \
83+
--node-name=krustlet \
84+
--bootstrap-file=${HOME}/.krustlet/config/bootstrap.conf
8485
```
8586

8687
### Step 3a: Approving the serving CSR

content/howto/krustlet-on-microk8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ guide]({{< relref "../intro/install.md" >}}).
5656
Let's use the built in `krustlet-wasi` provider
5757

5858
```console
59-
$ ./KUBECONFIG=${PWD}/krustlet-config \
59+
$ KUBECONFIG=~/.krustlet/config/kubeconfig \
6060
krustlet-wasi \
6161
--node-ip=127.0.0.1 \
6262
--node-name=krustlet \

content/howto/krustlet-on-minikube.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,11 @@ Once you have done that, run the following commands to run Krustlet's WASI
4848
provider:
4949

5050
```console
51-
# Since you are running locally, this step is important. Otherwise krustlet will pick up on your
52-
# local config and not be able to update the node status properly
53-
$ export KUBECONFIG=~/.krustlet/config/kubeconfig
54-
$ krustlet-wasi --node-ip 10.0.2.2 --bootstrap-file=~/.krustlet/config/bootstrap.conf
51+
$ KUBECONFIG=~/.krustlet/config/kubeconfig \
52+
krustlet-wasi \
53+
--node-ip 10.0.2.2 \
54+
--node-name=krustlet \
55+
--bootstrap-file=${HOME}/.krustlet/config/bootstrap.conf
5556
```
5657

5758
### Step 3a: Approving the serving CSR

content/howto/krustlet-on-wsl2.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,11 @@ Once you have done that, run the following commands to run Krustlet's WASI
9595
provider:
9696

9797
```console
98-
# Since you are running locally, this step is important. Otherwise krustlet will pick up on your
99-
# local config and not be able to update the node status properly
100-
$ export KUBECONFIG=~/.krustlet/config/kubeconfig
101-
$ krustlet-wasi --node-ip $mainIP --node-name krustlet --bootstrap-file=~/.krustlet/config/bootstrap.conf
98+
$ KUBECONFIG=~/.krustlet/config/kubeconfig \
99+
krustlet-wasi \
100+
--node-ip $mainIP \
101+
--node-name=krustlet \
102+
--bootstrap-file=${HOME}/.krustlet/config/bootstrap.conf
102103
```
103104

104105
### Step 3a: Approving the serving CSR

content/howto/krustlet-with-inlets.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,11 @@ You'll need the certificates generated from the bootstrap process for our next
8282
steps, so go ahead and start krustlet:
8383

8484
```console
85-
# Since you are running locally, this step is important. Otherwise krustlet will pick up on your
86-
# local config and not be able to update the node status properly
87-
export KUBECONFIG=~/.krustlet/config/kubeconfig
88-
krustlet-wasi --node-ip $NODE_IP --bootstrap-file=~/.krustlet/config/bootstrap.conf
85+
$ KUBECONFIG=~/.krustlet/config/kubeconfig \
86+
krustlet-wasi \
87+
--node-ip $NODE_IP \
88+
--node-name=krustlet \
89+
--bootstrap-file=${HOME}/.krustlet/config/bootstrap.conf
8990
```
9091

9192
Then open another terminal for the next steps.

content/intro/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ For production use:
2525

2626
- [Azure]({{< relref "../howto/krustlet-on-azure.md" >}})
2727
- [Amazon Elastic Kubernetes Service (EKS)]({{< relref "../howto/krustlet-on-eks.md" >}})
28+
- [Google Kubernetes Engine (GKE)]({{< relref "../howto/krustlet-on-gke.md" >}})
29+
- [Managed Kubernetes on DigitalOcean]({{< relref "../howto/krustlet-on-do.md" >}})
2830

2931
For development and evaluation purposes, it may make sense to use a VM-based
3032
Kubernetes cluster for quick and easy setup and teardown such as

0 commit comments

Comments
 (0)