diff --git a/Makefile b/Makefile index 503ddb96..678b930e 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ # Image URL to use all building/pushing image targets -IMG ?= ngrok-ingress-controller +IMG ?= kubernetes-ingress-controller # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. ENVTEST_K8S_VERSION = 1.23 diff --git a/PROJECT b/PROJECT index d4ca0c77..4d3f59f7 100644 --- a/PROJECT +++ b/PROJECT @@ -1,7 +1,7 @@ domain: k8s.ngrok.com layout: - go.kubebuilder.io/v3 -projectName: ngrok-ingress-controller +projectName: kubernetes-ingress-controller repo: github.com/ngrok/kubernetes-ingress-controller resources: - api: diff --git a/README.md b/README.md index 0d5929f2..ae172e95 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@

- - CI Status + + CI Status

- + License @@ -62,8 +62,8 @@ export NGROK_AUTHTOKEN= Install via Helm: ```bash -helm repo add ngrok https://ngrok.github.io/ngrok-ingress-controller -helm install ngrok-ingress-controller ngrok/ngrok-ingress-controller \ +helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller +helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \ --namespace ngrok-ingress-controller \ --create-namespace \ --set credentials.apiKey=$(NGROK_API_KEY) \ @@ -121,14 +121,14 @@ data: Then when installing the controller via helm, you can pass the name of the secret to the controller via the `credentials.secret.name` helm value. ```bash -helm install ngrok-ingress-controller ngrok/ngrok-ingress-controller \ +helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \ --set credentials.secret.name=ngrok-ingress-controller-credentials ``` ## How to Configure the Agent > Warning: This will be deprecated soon when moving to the new lib-ngrok library -* assumes configs will be in a config map named `{{ include "ngrok-ingress-controller.fullname" . }}-agent-cm` in the same namespace +* assumes configs will be in a config map named `{{ include "kubernetes-ingress-controller.fullname" . }}-agent-cm` in the same namespace * setup automatically via helm. Values and config map name can be configured in the future via helm * subset of these that should be configurable https://ngrok.com/docs/ngrok-agent/config#config-full-example * example config map showing all optional values with their defaults. @@ -137,7 +137,7 @@ helm install ngrok-ingress-controller ngrok/ngrok-ingress-controller \ apiVersion: v1 kind: ConfigMap metadata: - name: {{ include "ngrok-ingress-controller.fullname" . }}-agent-cm + name: {{ include "kubernetes-ingress-controller.fullname" . }}-agent-cm namespace: ngrok-ingress-controller data: METADATA: "{}" diff --git a/docs/releases.md b/docs/releases.md index 7b80ad2b..9e36262a 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -19,7 +19,7 @@ docker image can be used to run the Ingress Controller in a Kubernetes cluster w ### Docker Image The Docker image contains the ngrok Ingress Controller binary and is available on -Docker Hub [here](https://hub.docker.com/r/ngrok/ngrok-ingress-controller). We currently +Docker Hub [here](https://hub.docker.com/r/ngrok/kubernetes-ingress-controller). We currently support `amd64` and `arm64` architectures, with future plans to build for other architectures. ### Helm Chart @@ -64,13 +64,13 @@ to the semantic versioning spec as described above. Releases of the controller will be tagged with a prefix of `ngrok-ingress-controller-`. For example, version `1.2.0` of the docker image will have a git tag of `ngrok-ingress-controller-1.2.0` which -contains the code used to build the docker image `ngrok/ngrok-ingress-controller:1.2.0`. +contains the code used to build the docker image `ngrok/kubernetes-ingress-controller:1.2.0`. When changes that would affect the controller's docker image are pushed to `main`, a github workflow -will trigger. The workflow will build and publish the `ngrok/ngrok-ingress-controller:latest` docker +will trigger. The workflow will build and publish the `ngrok/kubernetes-ingress-controller:latest` docker image. If the `VERSION` file at the root of the repo is changed, the workflow will also create a git tag for the controller as described above and publish a tagged docker image. For instance when the `VERSION` is changed to `1.2.0`, the workflow will create a git tag of `ngrok-ingress-controller-1.2.0` -and publish the docker image `ngrok/ngrok-ingress-controller:1.2.0`. +and publish the docker image `ngrok/kubernetes-ingress-controller:1.2.0`.