Skip to content

Commit 25c3429

Browse files
authored
docs: fix yq/yj dependency typo
1 parent b856207 commit 25c3429

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Options:
6161
## Prerequisites on host machine
6262

6363
- `jq`
64-
- `yq`
64+
- `yj` (checked in to root of this repo, [direct download](https://github.com/controlplaneio/netassert/raw/master/yj))
6565
- `parallel`
6666
- `timeout`
6767

@@ -149,20 +149,20 @@ kubectl exec -it test-frontend-$YOUR_POD_ID -- wget -qO- --timeout=2 http://test
149149

150150
netassert takes a single YAML file as input. This file lists the hosts to test from, and describes the hosts and ports that it should be able to reach.
151151

152-
It can test from any reachable host, and from Kubernetes pods.
152+
It can test from any reachable host, and from inside Kubernetes pods.
153153

154154
A simple example:
155155

156156
```yaml
157-
host: # used for ssh-accessible hosts
158-
localhost: # host to run test from, can be anything accessible via SSH
157+
host: # child keys must be ssh-accessible hosts
158+
localhost: # host to run test from, must be accessible via SSH
159159
8.8.8.8: UDP:53 # host and ports to test for access
160160
```
161161
162162
A full example:
163163
164164
```yaml
165-
host: # used for ssh-accessible hosts
165+
host: # child keys must be ssh-accessible hosts
166166
localhost: # host to run test from, can be a remote host
167167
8.8.8.8: UDP:53 # host and ports to test from localhost
168168
google.co.uk: 443 # if no protocol is specified then TCP is implied
@@ -183,7 +183,7 @@ host: # used for ssh-accessible hosts
183183
google.com: 443 # this tests google.com:443 is accesible from control-plane.io
184184

185185

186-
k8s: # used for Kubernetes pods
186+
k8s: # child keys must be Kubernetes entities
187187
deployment: # only deployments currently supported
188188
test-frontend: # pod name, defaults to `default` namespace
189189
test-microservice: 80 # `test-microservice` is the DNS name of the target service

0 commit comments

Comments
 (0)