diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 17a8a82..6b1857e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -13,7 +13,7 @@ A clear and concise description of what the bug is. Steps to reproduce the behavior: -1. Deploy nginx_k8s_edge_controller using +1. Deploy nginx_k8s_loadbalancer using 2. View output/logs/configuration on '...' 3. See error @@ -23,7 +23,7 @@ A clear and concise description of what you expected to happen. ### Your environment -- Version of the nginx_k8s_edge_controller or specific commit +- Version of the nginx_k8s_loadbalancer or specific commit - Target deployment platform diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bc9a0bd..b8a5076 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on Before creating a PR, run through this checklist and mark each as complete. -- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/CONTRIBUTING.md) document +- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/CONTRIBUTING.md) document - [ ] If applicable, I have added tests that prove my fix is effective or that my feature works - [ ] If applicable, I have checked that any relevant tests pass after adding my changes -- [ ] I have updated any relevant documentation ([`README.md`](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/CHANGELOG.md)) +- [ ] I have updated any relevant documentation ([`README.md`](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/CHANGELOG.md)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8ddd98..6446317 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing Guidelines -The following is a set of guidelines for contributing to the nginx_k8s_edge_controller. We really appreciate that you are considering contributing! +The following is a set of guidelines for contributing to the nginx_k8s_loadbalancer. We really appreciate that you are considering contributing! #### Table Of Contents @@ -10,11 +10,11 @@ The following is a set of guidelines for contributing to the nginx_k8s_edge_cont [Code Guidelines](#code-guidelines) -[Code of Conduct](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/CODE_OF_CONDUCT.md) +[Code of Conduct](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/CODE_OF_CONDUCT.md) ## Getting Started -Follow our [Installation Guide](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/README.md#Installation) to get the nginx_k8s_edge_controller up and running. +Follow our [Installation Guide](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/README.md#Installation) to get the nginx_k8s_loadbalancer up and running. @@ -31,7 +31,7 @@ To suggest a feature or enhancement, please create an issue on GitHub with the l ### Open a Pull Request * Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review. -* Fill in [our pull request template](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/.github/pull_request_template.md). +* Fill in [our pull request template](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/.github/pull_request_template.md). Note: if you'd like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature. diff --git a/DESIGN.md b/DESIGN.md index 1b16f42..7d1a09e 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -1,6 +1,6 @@ # Overview -The nginx-k8s-edge-controller runs in a Kubernetes Cluster and responds to changes in resources of interest, updating designated NGINX Plus hosts with the appropriate configuration. +The nginx-k8s-loadbalancer runs in a Kubernetes Cluster and responds to changes in resources of interest, updating designated NGINX Plus hosts with the appropriate configuration. ## Basic Architecture diff --git a/Dockerfile b/Dockerfile index 51093ff..84d829c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -12,12 +12,12 @@ RUN go mod download COPY . . -RUN go build -o nginx-k8s-edge-controller ./cmd/nginx-k8s-edge-controller/main.go +RUN go build -o nginx-k8s-loadbalancer ./cmd/nginx-k8s-loadbalancer/main.go FROM alpine:3.16 -WORKDIR /opt/nginx-k8s-edge-controller +WORKDIR /opt/nginx-k8s-loadbalancer -COPY --from=builder /app/nginx-k8s-edge-controller . +COPY --from=builder /app/nginx-k8s-loadbalancer . -ENTRYPOINT ["/opt/nginx-k8s-edge-controller/nginx-k8s-edge-controller"] +ENTRYPOINT ["/opt/nginx-k8s-loadbalancer/nginx-k8s-loadbalancer"] diff --git a/README.md b/README.md index 97edac7..fcf3f78 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# nginx-k8s-edge-controller +# nginx-k8s-loadbalancer ## Welcome to the Nginx Kubernetes Load Balancer project ! @@ -69,12 +69,12 @@ Please see the /docs folder for Installation Guide. ## Development Contributions are being accepted at this time. -Read the [`CONTRIBUTING.md`](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/CONTRIBUTING.md) file. +Read the [`CONTRIBUTING.md`](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/CONTRIBUTING.md) file.
## License -[Apache License, Version 2.0](https://github.com/nginxinc/nginx-k8s-edge-controller/blob/main/LICENSE) +[Apache License, Version 2.0](https://github.com/nginxinc/nginx-k8s-loadbalancer/blob/main/LICENSE) © [F5 Networks, Inc.](https://www.f5.com/) 2023 diff --git a/SECURITY.md b/SECURITY.md index 0132f9b..916456d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## Latest Versions -We advise users to run or update to the most recent release of the nginx_k8s_edge_controller. Older versions of the nginx_k8s_edge_controller may not have all enhancements and/or bug fixes applied to them. +We advise users to run or update to the most recent release of the nginx_k8s_loadbalancer. Older versions of the nginx_k8s_loadbalancer may not have all enhancements and/or bug fixes applied to them. ## Reporting a Vulnerability diff --git a/SUPPORT.md b/SUPPORT.md index 936b7a3..a50bbb3 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -4,7 +4,7 @@ We use GitHub for tracking bugs and feature requests related to this project. -Don't know how something in the nginx_k8s_edge_controller works? Curious if the nginx_k8s_edge_controller can achieve your desired functionality? Please open an Issue on GitHub with the label `question`. +Don't know how something in the nginx_k8s_loadbalancer works? Curious if the nginx_k8s_loadbalancer can achieve your desired functionality? Please open an Issue on GitHub with the label `question`. ## NGINX Specific Questions and/or Issues diff --git a/cmd/nginx-k8s-edge-controller/doc.go b/cmd/nginx-k8s-loadbalancer/doc.go similarity index 70% rename from cmd/nginx-k8s-edge-controller/doc.go rename to cmd/nginx-k8s-loadbalancer/doc.go index 206460f..502db3c 100644 --- a/cmd/nginx-k8s-edge-controller/doc.go +++ b/cmd/nginx-k8s-loadbalancer/doc.go @@ -3,7 +3,7 @@ // license that can be found in the LICENSE file. /* -Package main includes the entrypoint for the nginx-k8s-edge-controller. +Package main includes the entrypoint for the nginx-k8s-loadbalancer. */ package main diff --git a/cmd/nginx-k8s-edge-controller/main.go b/cmd/nginx-k8s-loadbalancer/main.go similarity index 100% rename from cmd/nginx-k8s-edge-controller/main.go rename to cmd/nginx-k8s-loadbalancer/main.go diff --git a/cmd/nginx-k8s-edge-controller/main_test.go b/cmd/nginx-k8s-loadbalancer/main_test.go similarity index 100% rename from cmd/nginx-k8s-edge-controller/main_test.go rename to cmd/nginx-k8s-loadbalancer/main_test.go diff --git a/deployment/nkl-deployment.yaml b/deployment/nkl-deployment.yaml index 8b2beff..ce80b72 100644 --- a/deployment/nkl-deployment.yaml +++ b/deployment/nkl-deployment.yaml @@ -16,8 +16,8 @@ spec: app: nkl spec: containers: - - name: nginx-k8s-edge-controller - image: ciroque/nginx-k8s-edge-controller:latest + - name: nginx-k8s-loadbalancer + image: ciroque/nginx-k8s-loadbalancer:latest imagePullPolicy: Always ports: - name: http @@ -26,13 +26,13 @@ spec: livenessProbe: httpGet: path: /livez - port: http + port: 51031 initialDelaySeconds: 5 periodSeconds: 2 readinessProbe: httpGet: path: /readyz - port: http + port: 51031 initialDelaySeconds: 5 periodSeconds: 2 - serviceAccountName: nginx-k8s-edge-controller + serviceAccountName: nginx-k8s-loadbalancer diff --git a/k8s/RBAC/ClusterRoleBinding.yaml b/k8s/RBAC/ClusterRoleBinding.yaml index 1f88a3d..3b6a3a4 100644 --- a/k8s/RBAC/ClusterRoleBinding.yaml +++ b/k8s/RBAC/ClusterRoleBinding.yaml @@ -1,11 +1,11 @@ apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: - name: "nginx-k8s-edge-controller:ingress-resource-get-watch-list" + name: "nginx-k8s-loadbalancer:ingress-resource-get-watch-list" namespace: nkl subjects: - kind: ServiceAccount - name: nginx-k8s-edge-controller + name: nginx-k8s-loadbalancer namespace: nkl roleRef: kind: ClusterRole diff --git a/k8s/RBAC/Secret.yaml b/k8s/RBAC/Secret.yaml index 7671f7d..c5c6c4f 100644 --- a/k8s/RBAC/Secret.yaml +++ b/k8s/RBAC/Secret.yaml @@ -1,8 +1,8 @@ apiVersion: v1 kind: Secret metadata: - name: nginx-k8s-edge-controller-secret + name: nginx-k8s-loadbalancer-secret namespace: nkl annotations: - kubernetes.io/service-account.name: nginx-k8s-edge-controller + kubernetes.io/service-account.name: nginx-k8s-loadbalancer type: kubernetes.io/service-account-token diff --git a/k8s/RBAC/ServiceAccount.yaml b/k8s/RBAC/ServiceAccount.yaml index b743544..bf6c95f 100644 --- a/k8s/RBAC/ServiceAccount.yaml +++ b/k8s/RBAC/ServiceAccount.yaml @@ -1,5 +1,5 @@ apiVersion: v1 kind: ServiceAccount metadata: - name: nginx-k8s-edge-controller + name: nginx-k8s-loadbalancer namespace: nkl