Merge pull request #108 from jonstacks/repo-rename-work

Rename Repo and assets

.github/ISSUE_TEMPLATE/controller_bug_report.yaml

@@ -9,7 +9,7 @@ body:
       Thanks for taking the time to fill out this bug report!
 
       Note, you do not need to create an issue if you have a change ready to submit.
-      You can open a [pull request](https://github.com/ngrok/ngrok-ingress-controller/pulls) immediately instead.
+      You can open a [pull request](https://github.com/ngrok/kubernetes-ingress-controller/pulls) immediately instead.
 - type: textarea
   attributes:
     label: What happened

.github/ISSUE_TEMPLATE/helm_bug_report.yaml

@@ -9,7 +9,7 @@ body:
       Thanks for taking the time to fill out this bug report!
 
       Note, you do not need to create an issue if you have a change ready to submit.
-      You can open a [pull request](https://github.com/ngrok/ngrok-ingress-controller/pulls) immediately instead.
+      You can open a [pull request](https://github.com/ngrok/kubernetes-ingress-controller/pulls) immediately instead.
 - type: input
   attributes:
     label: Kubernetes Version

.github/workflows/ci.yaml

@@ -85,7 +85,7 @@ jobs:
         context: .
         platforms: ${{ steps.buildx-setup.outputs.platforms }}
         push: false
-        tags: ngrok/ngrok-ingress-controller:latest
+        tags: ngrok/kubernetes-ingress-controller:latest
 
   build:
     runs-on: ubuntu-latest

.github/workflows/docker.yaml

@@ -18,7 +18,7 @@ jobs:
     permissions:
       contents: read
       pull-requests: read
-    if: github.repository == 'ngrok/ngrok-ingress-controller'
+    if: github.repository == 'ngrok/kubernetes-ingress-controller'
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
@@ -39,7 +39,7 @@ jobs:
     needs:
       - changes
     if: |
-      github.repository == 'ngrok/ngrok-ingress-controller' &&
+      github.repository == 'ngrok/kubernetes-ingress-controller' &&
       github.event_name == 'push' &&
       github.ref == 'refs/heads/main'
     steps:
@@ -67,15 +67,15 @@ jobs:
           context: .
           platforms: ${{ steps.buildx-setup.outputs.platforms }}
           push: true
-          tags: ngrok/ngrok-ingress-controller:latest
+          tags: ngrok/kubernetes-ingress-controller:latest
       - name: Build and push tag'd docker image
         uses: docker/build-push-action@v3
         if: ${{ needs.changes.outputs.tag == 'true' }}
         with:
           context: .
           platforms: ${{ steps.buildx-setup.outputs.platforms }}
           push: true
-          tags: ngrok/ngrok-ingress-controller:${{ steps.extract_tag.outputs.tag }}
+          tags: ngrok/kubernetes-ingress-controller:${{ steps.extract_tag.outputs.tag }}
       - name: Create GitHub Release
         uses: actions/github-script@v6
         if: ${{ needs.changes.outputs.tag == 'true' }}

.github/workflows/helm_release.yaml

@@ -17,7 +17,7 @@ jobs:
     permissions:
       contents: read
       pull-requests: read
-    if: github.repository == 'ngrok/ngrok-ingress-controller'
+    if: github.repository == 'ngrok/kubernetes-ingress-controller'
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
@@ -37,7 +37,7 @@ jobs:
       contents: write # need to write releases
     needs: [changes]
     if: |
-      (github.repository == 'ngrok/ngrok-ingress-controller') &&
+      (github.repository == 'ngrok/kubernetes-ingress-controller') &&
       (needs.changes.outputs.charts == 'true')
     steps:
       - name: Checkout repo

CHANGELOG.md

@@ -6,7 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+
+## 0.3.0
 ### Changed
+- Renamed docker image from `ngrok/ngrok-ingress-controller` to `ngrok/kubernetes-ingress-controller`.
+- Added new controllers for `domains`, `tcpedges`, and `httpsedges`.
 - Updated go dependencies
 - Moved `main.go` to root of project to match what `kubebuilder` expects.
 - Updated `Makefile` to match what `kubebuilder` currently outputs.

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
 

PROJECT

@@ -1,8 +1,8 @@
 domain: k8s.ngrok.com
 layout:
 - go.kubebuilder.io/v3
-projectName: ngrok-ingress-controller
-repo: github.com/ngrok/ngrok-ingress-controller
+projectName: kubernetes-ingress-controller
+repo: github.com/ngrok/kubernetes-ingress-controller
 resources:
 - api:
     crdVersion: v1
@@ -11,7 +11,7 @@ resources:
   domain: k8s.ngrok.com
   group: ingress
   kind: Domain
-  path: github.com/ngrok/ngrok-ingress-controller/api/v1alpha1
+  path: github.com/ngrok/kubernetes-ingress-controller/api/v1alpha1
   version: v1alpha1
 - api:
     crdVersion: v1
@@ -20,7 +20,7 @@ resources:
   domain: k8s.ngrok.com
   group: ingress
   kind: Tunnel
-  path: github.com/ngrok/ngrok-ingress-controller/api/v1alpha1
+  path: github.com/ngrok/kubernetes-ingress-controller/api/v1alpha1
   version: v1alpha1
 - api:
     crdVersion: v1
@@ -29,7 +29,7 @@ resources:
   domain: k8s.ngrok.com
   group: ingress
   kind: TCPEdge
-  path: github.com/ngrok/ngrok-ingress-controller/api/v1alpha1
+  path: github.com/ngrok/kubernetes-ingress-controller/api/v1alpha1
   version: v1alpha1
 - api:
     crdVersion: v1
@@ -38,6 +38,6 @@ resources:
   domain: k8s.ngrok.com
   group: ingress
   kind: HTTPSEdge
-  path: github.com/ngrok/ngrok-ingress-controller/api/v1alpha1
+  path: github.com/ngrok/kubernetes-ingress-controller/api/v1alpha1
   version: v1alpha1
 version: "3"

README.md

@@ -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">
@@ -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) \
@@ -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: "{}"

VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

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`.

go.mod

@@ -1,4 +1,4 @@
-module github.com/ngrok/ngrok-ingress-controller
+module github.com/ngrok/kubernetes-ingress-controller
 
 go 1.19
 
@@ -8,6 +8,7 @@ require (
 	github.com/ngrok/ngrok-api-go/v5 v5.0.0
 	github.com/spf13/cobra v1.6.1
 	github.com/stretchr/testify v1.8.1
+	go.uber.org/zap v1.24.0
 	golang.ngrok.com/ngrok v0.0.0-20230105184634-66ddd48add80
 	golang.org/x/sync v0.1.0
 	k8s.io/api v0.26.0
@@ -77,7 +78,6 @@ require (
 	go.starlark.net v0.0.0-20230103143115-09991d3a103e // indirect
 	go.uber.org/atomic v1.10.0 // indirect
 	go.uber.org/multierr v1.9.0 // indirect
-	go.uber.org/zap v1.24.0 // indirect
 	golang.org/x/crypto v0.4.0 // indirect
 	golang.org/x/mod v0.7.0 // indirect
 	golang.org/x/net v0.5.0 // indirect

helm/ingress-controller/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.5.0
+### Changed
+- Renamed chart from `ngrok-ingress-controller` to `kubernetes-ingress-controller`.
+- Added CRDs for `domains`, `tcpedges`, and `httpsedges`.
+
 ## 0.4.0
 ### Added
 - `serverAddr` flag to override the ngrok tunnel server address

helm/ingress-controller/Chart.yaml

@@ -1,8 +1,8 @@
 apiVersion: v2
-name: ngrok-ingress-controller
+name: kubernetes-ingress-controller
 description: A Kubernetes ingress controller built using ngrok.
-version: 0.4.0
-appVersion: 0.2.0
+version: 0.5.0
+appVersion: 0.3.0
 keywords:
   - ngrok
   - networking
@@ -11,5 +11,5 @@ keywords:
   - api gateway
 home: https://ngrok.com
 sources:
-  - https://github.com/ngrok/ngrok-ingress-controller
+  - https://github.com/ngrok/kubernetes-ingress-controller
 icon: https://blog.ngrok.com/_next/image?url=%2Fassets%2Fblog%2Fplaceholder.png&w=1920&q=75