Skip to content

Commit e2680de

Browse files
committed
Adjusted documentation
1 parent 9d1850c commit e2680de

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,32 @@
77
88
This little Python script watches for Gateways and HTTP Routes part of the [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io)
99
in the Kubernetes cluster you have configured as your current context. It then works out the hostname from the HTTP route
10-
and registers it in multicast DNS towards the IP address of the Gateway. cloud-provider-mdns is intended to simplify
10+
and registers it in multicast and optionally unicast DNS towards the IP address of the Gateway. cloud-provider-mdns is intended to simplify
1111
local engineering, without the need of running a DNS server or manually hacking your hosts file. Basically run this,
1212
watch it find new registrations, then type their names into your browser.
1313

1414
## How to run this
1515

1616
> It is assumed you have something like [cloud-provider-kind](https://github.com/kubernetes-sigs/cloud-provider-kind)
1717
> that assigns IP addresses to your Gateways so they are accessible from your host.
18+
> It is not necessary to activate the virtual environment you installed the script in.
1819
1920
1. One-time: Build and install as described in the “How to build this” section below.
2021
2. Start your Kubernetes cluster and make sure your Kubernetes configuration has it set as its current context
2122
3. In a separate terminal, start cloud-provider-mdns and keep it running. Hit Ctrl-C to stop it.
2223

23-
```shell
24-
$ /path/to/virtualenv/bin/cloud-provider-mdns
25-
```
26-
27-
> It is not necessary to activate the virtual environment you installed the script in.
28-
24+
```shell
25+
$ /path/to/virtualenv/bin/cloud-provider-mdns
26+
```
27+
2928
4. Declare a HTTPRoute with a hostname that ends in '.local'
3029
5. Watch the output of cloud-provider-mdns
3130
6. Type the name into your browser
3231

32+
Registration is done in multicast DNS by default. If you wish to additionally populate a unicast nameserver then
33+
you must specify it's IP, tsig key name and secret using the CLI. A usable example unicast namesever configuration is created
34+
by [kube-eng](https://github.com/mrmatap/kube-eng).
35+
3336
## How to build this
3437
3538
Clone this repository, create a Python virtualenv (you'll need Python >= 3.12), then build and install:

0 commit comments

Comments
 (0)