Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme updates #53

Merged
merged 2 commits into from
May 2, 2023
Merged

Readme updates #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d7ab2e
Rename files to be consistent
ciroque May 2, 2023
e007c07
Corrects README links
ciroque May 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down Expand Up @@ -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
Expand All @@ -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)

Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions deployments/rbac/apply.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
0 deployments/rbac/ClusterRole.yaml → deployments/rbac/clusterrole.yaml
View file
Open in desktop
File renamed without changes.
0 deployments/rbac/ClusterRoleBinding.yaml → deployments/rbac/clusterrolebinding.yaml
View file
Open in desktop
File renamed without changes.
0 deployments/rbac/Secret.yaml → deployments/rbac/secret.yaml
View file
Open in desktop
File renamed without changes.
0 deployments/rbac/ServiceAccount.yaml → deployments/rbac/serviceaccount.yaml
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions deployments/rbac/unapply.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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