Skip to content

Commit a5cb478

Browse files
committed
docs: minor doc updates
1 parent f680268 commit a5cb478

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

docs/connecting-local-nodes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
[Telepresence](https://github.com/telepresenceio/telepresence) can be used to make a connection from the cluster to your local machine. Telepresence is designed to intercept cluster commmunication and forward it to your local machine so we will have to install a dummy pod and service to receive the traffic that will get forwarded.
66

7+
> [!NOTE]
8+
> This guide uses `kubectl` which is available from the [Kubernetes website](https://kubernetes.io/docs/tasks/tools/).
9+
710
### Run Warnet network
811

912
```shell

docs/install.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Installing Warnet
22

3-
Warnet requires Kubernetes (k8s) and helm in order to run the network. Kubernetes can be run remotely or locally (with minikube or Docker Desktop). `kubectl` and `helm` must be run locally to administer the network.
3+
Warnet requires Kubernetes (k8s) and Helm in order to run the network. Kubernetes can be run remotely or locally (with minikube or Docker Desktop). `helm` must be run locally to administer the network.
44

55
## Dependencies
66

77
### Remote (cloud) cluster
88

9-
The only two dependencies of Warnet are `helm` and `kubectl` configured to talk to your cloud cluster.
9+
The only dependency of Warnet is `helm`.
1010

1111
### Running Warnet Locally
1212

@@ -30,15 +30,14 @@ minikube start
3030

3131
Minikube has a [guide](https://kubernetes.io/docs/tutorials/hello-minikube/) on getting started which could be useful to validate that your minikube is running correctly.
3232

33-
### Testing kubectl and helm
33+
### Testing helm
3434

35-
The following commands should run on both local and remote clusters. Do not proceed unless kubectl and helm are working.
35+
The following commands should run on both local and remote clusters. Do not proceed unless helm is working.
3636

3737
```shell
3838
helm repo add examples https://helm.github.io/examples
3939
helm install hello examples/hello-world
4040
helm list
41-
kubectl get pods
4241
helm uninstall hello
4342
```
4443

0 commit comments

Comments
 (0)