diff --git a/README.md b/README.md index 96febe5..5bf731d 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The NGINX K8s Loadbalancer, or _NKL_, is a Kubernetes controller that provides T - [ ] A Kubernetes cluster running on-premise. - [ ] One or more NGINX Plus hosts running outside your Kubernetes cluster (NGINX Plus hosts must have the ability to route traffic to the cluster). -There is a more detailed [Installation Guide](docs/InstallationGuide.md) available in the `docs/` directory. +There is a more detailed [Installation Reference](docs/README.md) available in the `docs/` directory. ### Why NKL? @@ -80,7 +80,7 @@ You will need to update this ConfigMap to reflect the NGINX Plus hosts you wish 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. -There is an extensive [Installation Guide](docs/InstallationGuide.md) available in the `docs/` directory. +There is an extensive [Installation Reference](docs/README.md) available in the `docs/` directory. Please refer to that for detailed instructions on how to deploy NKL and run a demo application. #### Versioning @@ -91,7 +91,7 @@ Once in place, semantic versioning will be used for published images. #### Deployment Steps 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). -There is a much more detailed [Installation Guide](docs/InstallationGuide.md) available in the `docs/` directory. +There is a much more detailed [Installation Reference](docs/README.md) available in the `docs/` directory. 1. Clone this repo (optional, you can simply copy the `deployments/` directory) @@ -117,7 +117,7 @@ There is a much more detailed [Installation Guide](docs/InstallationGuide.md) av ```kubectl -n nkl get pods | grep nkl-deployment | cut -f1 -d" " | xargs kubectl logs -n nkl --follow $1``` -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) +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) and follow the instructions to deploy a demo application. ### Monitoring diff --git a/deployments/rbac/apply.sh b/deployments/rbac/apply.sh index 0c44f7d..e1689c5 100755 --- a/deployments/rbac/apply.sh +++ b/deployments/rbac/apply.sh @@ -2,7 +2,7 @@ echo "Applying all RBAC resources..." -kubectl apply -f ServiceAccount.yaml -kubectl apply -f ClusterRole.yaml -kubectl apply -f ClusterRoleBinding.yaml -kubectl apply -f Secret.yaml +kubectl apply -f serviceaccount.yaml +kubectl apply -f clusterrole.yaml +kubectl apply -f clusterrolebinding.yaml +kubectl apply -f secret.yaml diff --git a/deployments/rbac/ClusterRole.yaml b/deployments/rbac/clusterrole.yaml similarity index 100% rename from deployments/rbac/ClusterRole.yaml rename to deployments/rbac/clusterrole.yaml diff --git a/deployments/rbac/ClusterRoleBinding.yaml b/deployments/rbac/clusterrolebinding.yaml similarity index 100% rename from deployments/rbac/ClusterRoleBinding.yaml rename to deployments/rbac/clusterrolebinding.yaml diff --git a/deployments/rbac/Secret.yaml b/deployments/rbac/secret.yaml similarity index 100% rename from deployments/rbac/Secret.yaml rename to deployments/rbac/secret.yaml diff --git a/deployments/rbac/ServiceAccount.yaml b/deployments/rbac/serviceaccount.yaml similarity index 100% rename from deployments/rbac/ServiceAccount.yaml rename to deployments/rbac/serviceaccount.yaml diff --git a/deployments/rbac/unapply.sh b/deployments/rbac/unapply.sh index 27d993d..f29f90d 100755 --- a/deployments/rbac/unapply.sh +++ b/deployments/rbac/unapply.sh @@ -2,7 +2,7 @@ echo "Unapplying all RBAC resources..." -kubectl delete -f ServiceAccount.yaml -kubectl delete -f ClusterRole.yaml -kubectl delete -f ClusterRoleBinding.yaml -kubectl delete -f Secret.yaml +kubectl delete -f serviceaccount.yaml +kubectl delete -f clusterrole.yaml +kubectl delete -f clusterrolebinding.yaml +kubectl delete -f secret.yaml