Skip to content

Commit 100bc38

Browse files
committed
Update miscellany
1 parent 583f700 commit 100bc38

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ If you are running Kubernetes on-premise and will need to manage your own load b
6363

6464
NLK itself does not perform load balancing. Rather, NLK allows you to manage Service resources within your cluster to update your load balancers, with tooling you are most likely already using.
6565

66-
<img src="docs/media/nkl-blog-diagram-v1.png" width="768" />
66+
<img src="docs/media/nlk-blog-diagram-v1.png" width="768" />
6767

6868
## Getting Started
6969

@@ -81,7 +81,7 @@ As with everything Kubernetes, NLK requires RBAC permissions to function properl
8181
For convenience, two scripts are included, `apply.sh`, and `unapply.sh`. These scripts will apply or remove the RBAC resources, respectively.
8282

8383
The permissions required by NLK are modest. NLK requires the ability to read Resources via shared informers; the resources are Services, Nodes, and ConfigMaps.
84-
The Services and ConfigMap are restricted to a specific namespace (default: "nkl"). The Nodes resource is cluster-wide.
84+
The Services and ConfigMap are restricted to a specific namespace (default: "nlk"). The Nodes resource is cluster-wide.
8585

8686
#### Configuration
8787

@@ -127,7 +127,7 @@ There is a much more detailed [Installation Reference](docs/README.md) available
127127

128128
6. Check the logs
129129

130-
```kubectl -n nkl get pods | grep deployment | cut -f1 -d" " | xargs kubectl logs -n nkl --follow $1```
130+
```kubectl -n nlk get pods | grep deployment | cut -f1 -d" " | xargs kubectl logs -n nlk --follow $1```
131131

132132
At this point NLK should be up and running. Now would be a great time to go over to the [Installation Reference](docs/README.md)
133133
and follow the instructions to deploy a demo application.

docs/DESIGN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ adding each `core.ServerUpdateEvent` to the "nlk-synchronizer" queue.
4444
### Translator
4545

4646
The Translator is responsible for converting the `core.Event` event into an `nginxClient.UpstreamServer` event.
47-
This involves filtering out the `core.Event` instances that are not of interest to the controller by accepting only Port names starting with the NklPrefix value (currently _nlk-_).
48-
The event is then fanned-out based on the defined Ports, one event per defined Port. Each port is then augmented with the Ingress name (the name configured in the Port definition with the NklPrefix value removed),
47+
This involves filtering out the `core.Event` instances that are not of interest to the controller by accepting only Port names starting with the NlkPrefix value (currently _nlk-_).
48+
The event is then fanned-out based on the defined Ports, one event per defined Port. Each port is then augmented with the Ingress name (the name configured in the Port definition with the NlkPrefix value removed),
4949
and the list of the Node's IP addresses.
5050

5151
The Translator passes the list of events to the Synchronizer by calling the `AddEvents` method.

nlk-logo.svg

Lines changed: 2 additions & 2 deletions
Loading

0 commit comments

Comments
 (0)