Skip to content

Commit 9a4113a

Browse files
authored
Update README.md
1 parent 7a3f715 commit 9a4113a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ possibility of running concurrent tests that use the same hostnames for containe
1919
In kubedock this is currently solved by 'locking' the namespaces so that tests cannot
2020
be run concurrently.
2121

22-
This project is a prototype showing how to fix this problem, allowing multiple
22+
This project fixes this problem, allowing multiple
2323
concurrent tests to be run in the same namespace without conflict and without the
2424
need for locking the namespace.
2525

@@ -46,7 +46,9 @@ spec:
4646

4747
The above pod has one hostname 'db' and belongs to the network named 'test1'. When running multiple
4848
pods annotated this way, one gets a view of the network. E.g. there can be a network 'test1' with hosts
49-
'db' and 'service', and another network 'test2' with hosts 'db' and 'service'. The second part in this
49+
'db' and 'service', and another network 'test2' with hosts 'db' and 'service'.
50+
51+
The second part in this
5052
setup is that DNS lookups of 'db' from 'service' in network 'test1' should resolve to the 'db' pod in
5153
network 'test1', and similarly the lookups of 'db' by 'service' in network 'test2' should resolve to
5254
the 'db' pod in network 'test2'. See for instance the examples in the test directory.
@@ -57,7 +59,7 @@ This behavior can be achieved as follows:
5759
* a mapping of hostnames to pod IP in the network and vice versa
5860
* this datastructure is resolved by a DNS server that looks at the source IP of the DNS
5961
lookup, which identifies the network. Then within the network, the IP can be looked up based on
60-
hostname (A record), of viceversa, the hostname looked up by IP (PTR record). This DNS server
62+
hostname (A record), or viceversa, the hostname looked up by IP (PTR record). This DNS server
6163
is colocated with the above watcher in the same component. When a record cannot be resolved,
6264
the DNS server delegates to the upstream DNS server which is the standard kubernetes DNS server.
6365
* on deployment of pods, a pod is mutated using the dnsPolicy and dnsConfig fields to use the
@@ -81,7 +83,7 @@ for detecting problems.
8183
The advantage of this model is that it is relatively ueasy to integrate with kubedock. All that needs
8284
to be done is instrument kubedock to add the required annotations and label (and/or modify or configure
8385
kubedock-dns) so that the mechanism can be used. This solution came out of discussions with the
84-
kubedock maintainer. The next step is to prototype the required changes in kubedock to make it work.
86+
kubedock maintainer.
8587

8688
# Installation from the helm repo
8789

@@ -108,7 +110,7 @@ helm upgrade --install kubedock-dns helm/kubedock-dns
108110

109111
# Kubedock setup
110112

111-
Next step is to make sure that kubedock is started with the `--disable-services` option.
113+
Kubedock must be started with the `--disable-services` option.
112114
By doing that it becomes possible to run multiple concurrent testcontainer jobs in the same
113115
namespace.
114116

0 commit comments

Comments
 (0)