Skip to content

Commit

Permalink
Update docs and other project files
Browse files Browse the repository at this point in the history
  • Loading branch information
jonstacks committed Jan 17, 2023
1 parent f234725 commit 9283494
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion PROJECT
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
</p>

<p align="center">
<a href="https://github.com/ngrok/ngrok-ingress-controller/actions?query=branch%3Amain+event%3Apush">
<img src="https://github.com/ngrok/ngrok-ingress-controller/actions/workflows/ci.yaml/badge.svg" alt="CI Status"/>
<a href="https://github.com/ngrok/kubernetes-ingress-controller/actions?query=branch%3Amain+event%3Apush">
<img src="https://github.com/ngrok/kubernetes-ingress-controller/actions/workflows/ci.yaml/badge.svg" alt="CI Status"/>
</a>
<!-- TODO: Add badges for things like docker build status, image pulls, helm build status, latest stable release version, etc -->
</p>
<p align="center">
<a href="https://github.com/ngrok/ngrok-ingress-controller/blob/master/LICENSE">
<a href="https://github.com/ngrok/kubernetes-ingress-controller/blob/master/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"/>
</a>
<a href="#features-and-alpha-status">
Expand Down Expand Up @@ -62,8 +62,8 @@ export NGROK_AUTHTOKEN=<YOUR Secret Auth Token>
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) \
Expand Down Expand Up @@ -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.
Expand All @@ -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: "{}"
Expand Down
8 changes: 4 additions & 4 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`.

0 comments on commit 9283494

Please sign in to comment.