Skip to content

Commit ab9f840

Browse files
authored
tutorials/iperf3: Fix CRDs URLs (#477)
Small fix for the URLs to work with an environment variable. Signed-off-by: Kfir Toledo <kfir.toledo@ibm.com>
1 parent dbc45c4 commit ab9f840

File tree

1 file changed

+61
-12
lines changed
  • website/content/en/docs/tutorials

1 file changed

+61
-12
lines changed

website/content/en/docs/tutorials/iperf.md

Lines changed: 61 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ To setup two kind clusters:
5656
kind uses the prefix "kind", so the name of created clusters will be **kind-client** and **kind-server**.
5757
{{< /notice >}}
5858

59-
1. Setup `KUBECONFIG` on each terminal to access the cluster:
59+
4. Setup `KUBECONFIG` on each terminal to access the cluster:
6060

6161
Client cluster:
6262

@@ -86,14 +86,14 @@ using `kubectl config use-context kind-client` and `kubectl config use-context k
8686
Client cluster:
8787

8888
```sh
89-
export IPERF3_FILES=https://github.com/clusterlink-net/clusterlink/raw/main/demos/iperf3/testdata/manifests
89+
export IPERF3_FILES=https://raw.githubusercontent.com/clusterlink-net/clusterlink/main/demos/iperf3/testdata/manifests
9090
kubectl apply -f $IPERF3_FILES/iperf3-client/iperf3-client.yaml
9191
```
9292

9393
Server cluster:
9494

9595
```sh
96-
export IPERF3_FILES=https://github.com/clusterlink-net/clusterlink/raw/main/demos/iperf3/testdata/manifests
96+
export IPERF3_FILES=https://raw.githubusercontent.com/clusterlink-net/clusterlink/main/demos/iperf3/testdata/manifests
9797
kubectl apply -f $IPERF3_FILES/iperf3-server/iperf3.yaml
9898
```
9999

@@ -116,7 +116,7 @@ using `kubectl config use-context kind-client` and `kubectl config use-context k
116116

117117
For more details about fabric and peer concepts see [core concepts](https://clusterlink.net/docs/concepts).
118118

119-
1. Deploy ClusterLink on each cluster:
119+
2. Deploy ClusterLink on each cluster:
120120

121121
Client cluster:
122122

@@ -136,7 +136,7 @@ By default `deploy peer` creates an ingress of type LoadBalancer,
136136
which is more suitable for Kubernetes clusters running in the cloud.
137137
{{< /notice >}}
138138

139-
1. Verify that ClusterLink controlplane and dataplane are running:
139+
3. Verify that ClusterLink controlplane and dataplane are running:
140140

141141
Client cluster:
142142

@@ -152,6 +152,16 @@ which is more suitable for Kubernetes clusters running in the cloud.
152152
kubectl rollout status deployment cl-dataplane -n clusterlink-system
153153
```
154154

155+
{{% expand summary="Output" %}}
156+
It may take a few seconds for the deployments to be successfully created.
157+
158+
```sh
159+
deployment "cl-controlplane" successfully rolled out
160+
deployment "cl-dataplane" successfully rolled out
161+
```
162+
163+
{{% /expand %}}
164+
155165
## Enable cross-cluster access
156166

157167
In this step, we enable connectivity access between the iPerf3 client and server.
@@ -162,37 +172,50 @@ In this step, we enable connectivity access between the iPerf3 client and server
162172

163173
```sh
164174
export SERVER_IP=`docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' server-control-plane`
165-
envsubst < $IPERF3_FILES/clusterlink/peer-server.yaml | kubectl apply -f -
175+
curl -s $IPERF3_FILES/clusterlink/peer-server.yaml | envsubst | kubectl apply -f -
166176
```
167177

168178
Server cluster:
169179

170180
```sh
171181
export CLIENT_IP=`docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' client-control-plane`
172-
envsubst < $IPERF3_FILES/clusterlink/peer-client.yaml | kubectl apply -f -
182+
curl -s $IPERF3_FILES/clusterlink/peer-client.yaml | envsubst | kubectl apply -f -
173183
```
174184

185+
{{% expand summary="Install **envsubst** for **macOS users**" %}}
186+
In case `envsubst` does not exist, you can install it with:
187+
188+
```sh
189+
brew install gettext
190+
brew link --force gettext
191+
```
192+
193+
{{% /expand %}}
194+
195+
<br>
196+
175197
{{< notice note >}}
176-
The `PEER_X_IP` refers to the node IP of the peer kind cluster, which assigns the peer YAML file
198+
199+
The `CLIENT_IP` and `SERVER_IP` refers to the node IP of the peer kind cluster, which assigns the peer YAML file.
177200
{{< /notice >}}
178201

179-
1. In the server cluster, export the iperf3-server service:
202+
2. In the server cluster, export the iperf3-server service:
180203

181204
Server cluster:
182205

183206
```sh
184207
kubectl apply -f $IPERF3_FILES/clusterlink/export-iperf3.yaml
185208
```
186209

187-
1. In the client cluster, import the iperf3-server service from the server cluster:
210+
3. In the client cluster, import the iperf3-server service from the server cluster:
188211

189212
Client cluster:
190213

191214
```sh
192215
kubectl apply -f $IPERF3_FILES/clusterlink/import-iperf3.yaml
193216
```
194217

195-
1. Create access policies on both clusters to allow connectivity:
218+
4. Create access policies on both clusters to allow connectivity:
196219

197220
Client cluster:
198221

@@ -206,7 +229,7 @@ The `PEER_X_IP` refers to the node IP of the peer kind cluster, which assigns th
206229
kubectl apply -f $IPERF3_FILES/clusterlink/allow-policy.yaml
207230
```
208231

209-
For more details about policies see [ClusterLink policies](https://clusterlink.net/docs/concepts/policies)
232+
For more details about policies see [ClusterLink policies](https://clusterlink.net/docs/concepts/policies).
210233

211234
## Test service connectivity
212235

@@ -219,6 +242,32 @@ export IPERF3CLIENT=`kubectl get pods -l app=iperf3-client -o custom-columns=:me
219242
kubectl exec -i $IPERF3CLIENT -- iperf3 -c iperf3-server --port 5000
220243
```
221244

245+
{{% expand summary="Output" %}}
246+
247+
```
248+
Connecting to host iperf3-server, port 5000
249+
[ 5] local 10.244.0.5 port 51666 connected to 10.96.46.198 port 5000
250+
[ ID] Interval Transfer Bitrate Retr Cwnd
251+
[ 5] 0.00-1.00 sec 639 MBytes 5.36 Gbits/sec 0 938 KBytes
252+
[ 5] 1.00-2.00 sec 627 MBytes 5.26 Gbits/sec 0 938 KBytes
253+
[ 5] 2.00-3.00 sec 628 MBytes 5.26 Gbits/sec 0 938 KBytes
254+
[ 5] 3.00-4.00 sec 635 MBytes 5.33 Gbits/sec 0 938 KBytes
255+
[ 5] 4.00-5.00 sec 630 MBytes 5.29 Gbits/sec 0 938 KBytes
256+
[ 5] 5.00-6.00 sec 636 MBytes 5.33 Gbits/sec 0 938 KBytes
257+
[ 5] 6.00-7.00 sec 639 MBytes 5.36 Gbits/sec 0 938 KBytes
258+
[ 5] 7.00-8.00 sec 634 MBytes 5.32 Gbits/sec 0 938 KBytes
259+
[ 5] 8.00-9.00 sec 641 MBytes 5.39 Gbits/sec 0 938 KBytes
260+
[ 5] 9.00-10.00 sec 633 MBytes 5.30 Gbits/sec 0 938 KBytes
261+
- - - - - - - - - - - - - - - - - - - - - - - - -
262+
[ ID] Interval Transfer Bitrate Retr
263+
[ 5] 0.00-10.00 sec 6.19 GBytes 5.32 Gbits/sec 0 sender
264+
[ 5] 0.00-10.00 sec 6.18 GBytes 5.31 Gbits/sec receiver
265+
266+
iperf Done.
267+
```
268+
269+
{{% /expand %}}
270+
222271
## Cleanup
223272

224273
1. Delete all kind clusters:

0 commit comments

Comments
 (0)