Skip to content

Commit 3847ae3

Browse files
authored
Readme updates (#53)
* Rename files to be consistent * Corrects README links
1 parent 36431cd commit 3847ae3

File tree

7 files changed

+12
-12
lines changed

7 files changed

+12
-12
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The NGINX K8s Loadbalancer, or _NKL_, is a Kubernetes controller that provides T
2424
- [ ] A Kubernetes cluster running on-premise.
2525
- [ ] One or more NGINX Plus hosts running outside your Kubernetes cluster (NGINX Plus hosts must have the ability to route traffic to the cluster).
2626

27-
There is a more detailed [Installation Guide](docs/InstallationGuide.md) available in the `docs/` directory.
27+
There is a more detailed [Installation Reference](docs/README.md) available in the `docs/` directory.
2828

2929
### Why NKL?
3030

@@ -80,7 +80,7 @@ You will need to update this ConfigMap to reflect the NGINX Plus hosts you wish
8080

8181
If you were to deploy the ConfigMap and start NKL without updating the `nginx-hosts` value, don't fear; the ConfigMap resource is monitored for changes and NKL will update the NGINX Plus hosts accordingly when the resource is changed, no restart required.
8282

83-
There is an extensive [Installation Guide](docs/InstallationGuide.md) available in the `docs/` directory.
83+
There is an extensive [Installation Reference](docs/README.md) available in the `docs/` directory.
8484
Please refer to that for detailed instructions on how to deploy NKL and run a demo application.
8585

8686
#### Versioning
@@ -91,7 +91,7 @@ Once in place, semantic versioning will be used for published images.
9191
#### Deployment Steps
9292

9393
To get NKL up and running in ten steps or fewer, follow these instructions (NOTE, all the aforementioned prerequisites must be met for this to work).
94-
There is a much more detailed [Installation Guide](docs/InstallationGuide.md) available in the `docs/` directory.
94+
There is a much more detailed [Installation Reference](docs/README.md) available in the `docs/` directory.
9595

9696
1. Clone this repo (optional, you can simply copy the `deployments/` directory)
9797

@@ -117,7 +117,7 @@ There is a much more detailed [Installation Guide](docs/InstallationGuide.md) av
117117

118118
```kubectl -n nkl get pods | grep nkl-deployment | cut -f1 -d" " | xargs kubectl logs -n nkl --follow $1```
119119

120-
At this point NKL should be up and running. Now would be a great time to go over to the [Installation Guide](docs/InstallationGuide.md)
120+
At this point NKL should be up and running. Now would be a great time to go over to the [Installation Reference](docs/README.md)
121121
and follow the instructions to deploy a demo application.
122122

123123
### Monitoring

deployments/rbac/apply.sh

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
echo "Applying all RBAC resources..."
44

5-
kubectl apply -f ServiceAccount.yaml
6-
kubectl apply -f ClusterRole.yaml
7-
kubectl apply -f ClusterRoleBinding.yaml
8-
kubectl apply -f Secret.yaml
5+
kubectl apply -f serviceaccount.yaml
6+
kubectl apply -f clusterrole.yaml
7+
kubectl apply -f clusterrolebinding.yaml
8+
kubectl apply -f secret.yaml
File renamed without changes.
File renamed without changes.

deployments/rbac/unapply.sh

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
echo "Unapplying all RBAC resources..."
44

5-
kubectl delete -f ServiceAccount.yaml
6-
kubectl delete -f ClusterRole.yaml
7-
kubectl delete -f ClusterRoleBinding.yaml
8-
kubectl delete -f Secret.yaml
5+
kubectl delete -f serviceaccount.yaml
6+
kubectl delete -f clusterrole.yaml
7+
kubectl delete -f clusterrolebinding.yaml
8+
kubectl delete -f secret.yaml

0 commit comments

Comments
 (0)