init repo rename

ngrok · Jun 25, 2024 · 57770fa · 57770fa
1 parent e9da30f
commit 57770fa
Show file tree

Hide file tree

Showing 102 changed files with 535 additions and 529 deletions.
diff --git a/.github/ISSUE_TEMPLATE/controller_bug_report.yaml b/.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/kubernetes-ingress-controller/pulls) immediately instead.
+      You can open a [pull request](https://github.com/ngrok/kubernetes-operator/pulls) immediately instead.
 - type: input
   attributes:
     label: Kubernetes Version
@@ -42,7 +42,7 @@ body:
     description: We want to see relevant kubernetes logs showing error messages
 or helpful debugging information
     placeholder: >
-      Run `kubectl logs -l app.kubernetes.io/name=kubernetes-ingress-controller` and copy the output here.
+      Run `kubectl logs -l app.kubernetes.io/name=kubernetes-operator` and copy the output here.
   validations:
     required: true
 - type: textarea

diff --git a/.github/ISSUE_TEMPLATE/helm_bug_report.yaml b/.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/kubernetes-ingress-controller/pulls) immediately instead.
+      You can open a [pull request](https://github.com/ngrok/kubernetes-operator/pulls) immediately instead.
 - type: input
   attributes:
     label: Kubernetes Version

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -86,7 +86,7 @@ jobs:
         context: .
         platforms: ${{ steps.buildx-setup.outputs.platforms }}
         push: false
-        tags: ngrok/kubernetes-ingress-controller:latest
+        tags: ngrok/kubernetes-operator:latest
 
   go-mod-tidy:
     name: Go Mod Tidy Check

diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -18,7 +18,7 @@ jobs:
     permissions:
       contents: read
       pull-requests: read
-    if: github.repository == 'ngrok/kubernetes-ingress-controller'
+    if: github.repository == 'ngrok/kubernetes-operator'
     steps:
       - name: Checkout repo
         uses: actions/checkout@v3
@@ -39,7 +39,7 @@ jobs:
     needs:
       - changes
     if: |
-      github.repository == 'ngrok/kubernetes-ingress-controller' &&
+      github.repository == 'ngrok/kubernetes-operator' &&
       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/kubernetes-ingress-controller:latest
+          tags: ngrok/kubernetes-operator: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/kubernetes-ingress-controller:${{ steps.extract_tag.outputs.tag }}
+          tags: ngrok/kubernetes-operator:${{ steps.extract_tag.outputs.tag }}
       - name: Create GitHub Release
         uses: actions/github-script@v6
         if: ${{ needs.changes.outputs.tag == 'true' }}
@@ -86,8 +86,8 @@ jobs:
             const release = await github.rest.repos.createRelease({
               owner: context.repo.owner,
               repo: context.repo.repo,
-              tag_name: `kubernetes-ingress-controller-${tag}`,
-              name: `kubernetes-ingress-controller-${tag}`,
+              tag_name: `kubernetes-operator-${tag}`,
+              name: `kubernetes-operator-${tag}`,
               body: `${tag}`,
               draft: false,
               prerelease: false

diff --git a/.github/workflows/helm_release.yaml b/.github/workflows/helm_release.yaml
@@ -17,7 +17,7 @@ jobs:
     permissions:
       contents: read
       pull-requests: read
-    if: github.repository == 'ngrok/kubernetes-ingress-controller'
+    if: github.repository == 'ngrok/kubernetes-operator'
     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/kubernetes-ingress-controller') &&
+      (github.repository == 'ngrok/kubernetes-operator') &&
       (needs.changes.outputs.charts == 'true')
     steps:
       - name: Checkout repo

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ 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.13.0
+**Full Changelog**: TBD
+
+### Changed
+- Renamed docker image from `ngrok/kubernetes-ingress-controller` to `ngrok/ngrok-operator`.
+
 ## 0.12.0
 **Full Changelog**: https://github.com/ngrok/kubernetes-ingress-controller/compare/kubernetes-ingress-controller-0.11.0...kubernetes-ingress-controller-0.12.0
 

diff --git a/Makefile b/Makefile
@@ -1,10 +1,10 @@
 
 # Image URL to use all building/pushing image targets
-IMG ?= kubernetes-ingress-controller
+IMG ?= ngrok-operator
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.29.0
 
-REPO_URL = github.com/ngrok/kubernetes-ingress-controller
+REPO_URL = github.com/ngrok/ngrok-operator
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -57,7 +57,7 @@ preflight: ## Verifies required things like the go version
 
 .PHONY: manifests
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
-	$(CONTROLLER_GEN) rbac:roleName=ngrok-ingress-controller-manager-role crd webhook paths="{./api/ingress/v1alpha1/, ./api/ngrok/v1alpha1, ./internal/controller/ingress/, ./internal/controller/ngrok/, ./internal/controller/gateway/}" \
+	$(CONTROLLER_GEN) rbac:roleName=ngrok-operator-role crd webhook paths="{./api/ingress/v1alpha1/, ./api/ngrok/v1alpha1, ./internal/controller/ingress/, ./internal/controller/ngrok/, ./internal/controller/gateway/}" \
 		output:crd:artifacts:config=$(HELM_TEMPLATES_DIR)/crds \
 		output:rbac:artifacts:config=$(HELM_TEMPLATES_DIR)/rbac
 
@@ -116,8 +116,8 @@ endif
 
 .PHONY: deploy
 deploy: _deploy-check-env-vars docker-build manifests kustomize _helm_setup ## Deploy controller to the K8s cluster specified in ~/.kube/config.
-	helm upgrade ngrok-ingress-controller $(HELM_CHART_DIR) --install \
-		--namespace ngrok-ingress-controller \
+	helm upgrade ngrok-operator $(HELM_CHART_DIR) --install \
+		--namespace ngrok-operator \
 		--create-namespace \
 		--set image.repository=$(IMG) \
 		--set image.tag="latest" \
@@ -128,12 +128,12 @@ deploy: _deploy-check-env-vars docker-build manifests kustomize _helm_setup ## D
 		--set log.level=debug \
 		--set log.stacktraceLevel=panic \
 		--set metaData.env=local,metaData.from=makefile &&\
-	kubectl rollout restart deployment ngrok-ingress-controller-kubernetes-ingress-controller-manager -n ngrok-ingress-controller
+	kubectl rollout restart deployment ngrok-operator -n ngrok-operator
 
 .PHONY: deploy_gateway
 deploy_gateway: _deploy-check-env-vars docker-build manifests kustomize _helm_setup ## Deploy controller to the K8s cluster specified in ~/.kube/config.
-	helm upgrade ngrok-ingress-controller $(HELM_CHART_DIR) --install \
-		--namespace ngrok-ingress-controller \
+	helm upgrade ngrok-operator $(HELM_CHART_DIR) --install \
+		--namespace ngrok-operator \
 		--create-namespace \
 		--set image.repository=$(IMG) \
 		--set image.tag="latest" \
@@ -145,7 +145,7 @@ deploy_gateway: _deploy-check-env-vars docker-build manifests kustomize _helm_se
 		--set log.stacktraceLevel=panic \
 		--set metaData.env=local,metaData.from=makefile \
 		--set useExperimentalGatewayApi=true &&\
-	kubectl rollout restart deployment ngrok-ingress-controller-kubernetes-ingress-controller-manager -n ngrok-ingress-controller
+	kubectl rollout restart deployment ngrok-operator -n ngrok-operator
 
 .PHONY: _deploy-check-env-vars
 _deploy-check-env-vars:
@@ -158,7 +158,7 @@ endif
 
 .PHONY: undeploy
 undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
-	helm uninstall ngrok-ingress-controller
+	helm uninstall ngrok-operator
 
 ##@ Build Dependencies
 

diff --git a/PROJECT b/PROJECT
diff --git a/README.md b/README.md
@@ -8,10 +8,10 @@
 </p>
 
 <p>
-  <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 href="https://github.com/ngrok/ngrok-operator/actions?query=branch%3Amain+event%3Apush">
+      <img src="https://github.com/ngrok/ngrok-operator/actions/workflows/ci.yaml/badge.svg" alt="CI Status"/>
   </a>
-  <a href="https://github.com/ngrok/kubernetes-ingress-controller/blob/master/LICENSE">
+  <a href="https://github.com/ngrok/ngrok-operator/blob/master/LICENSE">
     <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"/>
   </a>
   <a href="#features-and-beta-status">
@@ -34,7 +34,7 @@
 Leverage [ngrok](https://ngrok.com/) for your ingress in your Kubernetes cluster.  Instantly add load balancing, authentication, and observability to your services via ngrok Cloud Edge modules using Custom Resource Definitions (CRDs) and Kubernetes-native tooling. This repo contains both our [Kubernetes Ingress Controller](https://kubernetes.io/docs/concepts/services-networking/ingress/) and the [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/)
 
 
-[Installation](#installation) | [Getting Started](https://ngrok.com/docs/using-ngrok-with/k8s/) | [Documentation](#documentation) | [Developer Guide](https://github.com/ngrok/kubernetes-ingress-controller/blob/main/docs/developer-guide/README.md) | [Known Issues](#known-issues)
+[Installation](#installation) | [Getting Started](https://ngrok.com/docs/using-ngrok-with/k8s/) | [Documentation](#documentation) | [Developer Guide](https://github.com/ngrok/ngrok-operator/blob/main/docs/developer-guide/README.md) | [Known Issues](#known-issues)
 
 ## Installation
 
@@ -45,7 +45,7 @@ Leverage [ngrok](https://ngrok.com/) for your ingress in your Kubernetes cluster
 Add the ngrok Ingress Controller Helm chart:
 
 ```sh
-helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller
+helm repo add ngrok https://ngrok.github.io/ngrok-operator
 ```
 
 Then, install the latest version (setting the appropriate values for your environment):
@@ -55,7 +55,7 @@ export NAMESPACE=[YOUR_K8S_NAMESPACE]
 export NGROK_AUTHTOKEN=[AUTHTOKEN]
 export NGROK_API_KEY=[API_KEY]
 
-helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
+helm install ngrok-operator ngrok/ngrok-operator \
   --namespace $NAMESPACE \
   --create-namespace \
   --set credentials.apiKey=$NGROK_API_KEY \
@@ -78,7 +78,7 @@ kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/downloa
 Then, during the helm install set the experimental gateway flag.
 
 ```sh
-helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
+helm install ngrok-operator ngrok/ngrok-operator \
   --namespace $NAMESPACE \
   --create-namespace \
   --set credentials.apiKey=$NGROK_API_KEY \
@@ -90,8 +90,8 @@ helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
 Apply the [sample combined manifest](manifest-bundle.yaml) from our repo:
 
 ```sh
-kubectl apply -n ngrok-ingress-controller \
-  -f https://raw.githubusercontent.com/ngrok/kubernetes-ingress-controller/main/manifest-bundle.yaml
+kubectl apply -n ngrok-operator \
+  -f https://raw.githubusercontent.com/ngrok/ngrok-operator/main/manifest-bundle.yaml
 ```
 
 For a more in-depth installation guide follow our step-by-step [Getting Started](https://ngrok.com/docs/using-ngrok-with/k8s/) guide.
@@ -106,7 +106,7 @@ The full documentation for the ngrok Ingress Controller can be found on our [k8s
 >
 > This project is currently in beta as we continue testing and receiving feedback. The functionality and CRD contracts may change. It is currently used internally at ngrok for providing ingress to some of our production workloads. 
 
-1. Current issues of concern for production workloads are being tracked [here](https://github.com/ngrok/kubernetes-ingress-controller/issues/208) and [here](https://github.com/ngrok/kubernetes-ingress-controller/issues/219).
+1. Current issues of concern for production workloads are being tracked [here](https://github.com/ngrok/ngrok-operator/issues/208) and [here](https://github.com/ngrok/ngrok-operator/issues/219).
 
 ## Support
 

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.12.0
+0.13.0
diff --git a/api/ingress/v1alpha1/ngrok_common.go b/api/ingress/v1alpha1/ngrok_common.go
@@ -11,10 +11,10 @@ import (
 // common ngrok API/Dashboard fields
 type ngrokAPICommon struct {
 	// Description is a human-readable description of the object in the ngrok API/Dashboard
-	// +kubebuilder:default:=`Created by kubernetes-ingress-controller`
+	// +kubebuilder:default:=`Created by ngrok-operator`
 	Description string `json:"description,omitempty"`
 	// Metadata is a string of arbitrary data associated with the object in the ngrok API/Dashboard
-	// +kubebuilder:default:=`{"owned-by":"kubernetes-ingress-controller"}`
+	// +kubebuilder:default:=`{"owned-by":"ngrok-operator"}`
 	Metadata string `json:"metadata,omitempty"`
 }
 

diff --git a/cmd/main.go b/cmd/main.go
@@ -46,16 +46,16 @@ import (
 
 	"github.com/ngrok/ngrok-api-go/v5"
 
-	ingressv1alpha1 "github.com/ngrok/kubernetes-ingress-controller/api/ingress/v1alpha1"
-	ngrokv1alpha1 "github.com/ngrok/kubernetes-ingress-controller/api/ngrok/v1alpha1"
-	"github.com/ngrok/kubernetes-ingress-controller/internal/annotations"
-	gatewaycontroller "github.com/ngrok/kubernetes-ingress-controller/internal/controller/gateway"
-	controllers "github.com/ngrok/kubernetes-ingress-controller/internal/controller/ingress"
-	ngrokctr "github.com/ngrok/kubernetes-ingress-controller/internal/controller/ngrok"
-	"github.com/ngrok/kubernetes-ingress-controller/internal/ngrokapi"
-	"github.com/ngrok/kubernetes-ingress-controller/internal/store"
-	"github.com/ngrok/kubernetes-ingress-controller/internal/version"
-	"github.com/ngrok/kubernetes-ingress-controller/pkg/tunneldriver"
+	ingressv1alpha1 "github.com/ngrok/ngrok-operator/api/ingress/v1alpha1"
+	ngrokv1alpha1 "github.com/ngrok/ngrok-operator/api/ngrok/v1alpha1"
+	"github.com/ngrok/ngrok-operator/internal/annotations"
+	gatewaycontroller "github.com/ngrok/ngrok-operator/internal/controller/gateway"
+	controllers "github.com/ngrok/ngrok-operator/internal/controller/ingress"
+	ngrokctr "github.com/ngrok/ngrok-operator/internal/controller/ngrok"
+	"github.com/ngrok/ngrok-operator/internal/ngrokapi"
+	"github.com/ngrok/ngrok-operator/internal/store"
+	"github.com/ngrok/ngrok-operator/internal/version"
+	"github.com/ngrok/ngrok-operator/pkg/tunneldriver"
 	//+kubebuilder:scaffold:imports
 )
 
@@ -113,14 +113,14 @@ func cmd() *cobra.Command {
 
 	c.Flags().StringVar(&opts.metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to")
 	c.Flags().StringVar(&opts.probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
-	c.Flags().StringVar(&opts.electionID, "election-id", "ngrok-ingress-controller-leader", "The name of the configmap that is used for holding the leader lock")
+	c.Flags().StringVar(&opts.electionID, "election-id", "ngrok-operator-leader", "The name of the configmap that is used for holding the leader lock")
 	c.Flags().StringVar(&opts.metaData, "metadata", "", "A comma separated list of key value pairs such as 'key1=value1,key2=value2' to be added to ngrok api resources as labels")
 	c.Flags().StringVar(&opts.region, "region", "", "The region to use for ngrok tunnels")
 	c.Flags().StringVar(&opts.serverAddr, "server-addr", "", "The address of the ngrok server to use for tunnels")
 	c.Flags().StringVar(&opts.apiURL, "api-url", "", "The base URL to use for the ngrok api")
 	c.Flags().StringVar(&opts.controllerName, "controller-name", "k8s.ngrok.com/ingress-controller", "The name of the controller to use for matching ingresses classes")
 	c.Flags().StringVar(&opts.watchNamespace, "watch-namespace", "", "Namespace to watch for Kubernetes resources. Defaults to all namespaces.")
-	c.Flags().StringVar(&opts.managerName, "manager-name", "ngrok-ingress-controller-manager", "Manager name to identify unique ngrok ingress controller instances")
+	c.Flags().StringVar(&opts.managerName, "manager-name", "ngrok-operator", "Manager name to identify unique ngrok ingress controller instances")
 	c.Flags().BoolVar(&opts.useExperimentalGatewayAPI, "use-experimental-gateway-api", false, "sets up experemental gatewayAPI")
 	c.Flags().StringVar(&opts.rootCAs, "root-cas", "trusted", "trusted (default) or host: use the trusted ngrok agent CA or the host CA")
 	opts.zapOpts = &zap.Options{}