Skip to content

Commit 3a5c997

Browse files
authored
Minor updates (#57)
1 parent 6af8a31 commit 3a5c997

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ _**NKL is a Kubernetes controller that monitors Services and Nodes in your clust
4444
That's all well and good, but what does it mean? Kubernetes clusters require some tooling to handling routing traffic from the outside world (e.g.: the Internet, corporate network, etc.) to the cluster.
4545
This is typically done with a load balancer. The load balancer is responsible for routing traffic to the appropriate worker node which then forwards the traffic to the appropriate Service / Pod.
4646

47-
If you are using a hosted web solution -- Digital Ocean, AWS, Azure, etc. -- you can use the cloud provider's load balancer service. Those services will create a load balancer for you.
47+
If you are using a hosted Kubernetes solution -- Digital Ocean, AWS, Azure, etc. -- you can use the cloud provider's load balancer service. Those services will create a load balancer for you.
4848
You can use the cloud provider's API to manage the load balancer, or you can use the cloud provider's web console.
4949

5050
If you are running Kubernetes on-premise and will need to manage your own load balancer, NKL can help.
@@ -64,7 +64,7 @@ you need to have at least one NGINX Plus host running outside your cluster (Plea
6464

6565
#### RBAC
6666

67-
As with everything Kubernetes, NKL requires RBAC permissions to function properly. The necessary resources are defined in the various YAML files in `deployement/rbac/`.
67+
As with everything Kubernetes, NKL requires RBAC permissions to function properly. The necessary resources are defined in the various YAML files in `deployment/rbac/`.
6868

6969
For convenience, two scripts are included, `apply.sh`, and `unapply.sh`. These scripts will apply or remove the RBAC resources, respectively.
7070

@@ -73,7 +73,7 @@ The Services and ConfigMap are restricted to a specific namespace (default: "nkl
7373

7474
#### Configuration
7575

76-
NKL is configured via a ConfigMap, the default settings are found in `deployment/configmap.yaml`. Presently there is a single configuration value exposed in the ConfigMap, `nginx-hosts`.
76+
NKL is configured via a ConfigMap, the default settings are found in `deployment/nkl-configmap.yaml`. Presently there is a single configuration value exposed in the ConfigMap, `nginx-hosts`.
7777
This contains a comma-separated list of NGINX Plus hosts that NKL will maintain.
7878

7979
You will need to update this ConfigMap to reflect the NGINX Plus hosts you wish to manage.
@@ -97,21 +97,21 @@ There is a much more detailed [Installation Reference](docs/README.md) available
9797

9898
```git clone git@github.com:nginxinc/nginx-k8s-loadbalancer.git```
9999

100-
2. Apply the RBAC resources
100+
2. Apply the Namespace
101101

102-
```./deployments/rbac/apply.sh```
102+
```kubectl apply -f deployments/nkl-namespace.yaml```
103103

104-
3. Apply the Namespace
104+
3. Apply the RBAC resources
105105

106-
```kubectl apply -f deployments/namespace.yaml```
106+
```./deployments/rbac/apply.sh```
107107

108108
4. Update / Apply the ConfigMap (For best results update the `nginx-hosts` values first)
109109

110-
```kubectl apply -f deployments/configmap.yaml```
110+
```kubectl apply -f deployments/nkl-configmap.yaml```
111111

112112
5. Apply the Deployment
113113

114-
```kubectl apply -f deployments/deployment.yaml```
114+
```kubectl apply -f deployments/nkl-deployment.yaml```
115115

116116
6. Check the logs
117117

0 commit comments

Comments
 (0)