Skip to content

Commit 769efe7

Browse files
Making Gateway API as supported in readme and removing useExperimentalGatewayApi deprecated variable (#778)
1 parent e1eb91a commit 769efe7

File tree

7 files changed

+5
-28
lines changed

7 files changed

+5
-28
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ make undeploy # Remove from cluster
8787
## Configuration
8888

8989
- **Credentials**: `helm install` requires `credentials.apiKey` and `credentials.authtoken`
90-
- **Feature Flags**: `useExperimentalGatewayApi=true` enables Gateway API support
90+
- **Feature Flags**: `gateway.enabled=true` enables Gateway API support
9191

9292
## Rules
9393

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<img src="https://img.shields.io/badge/Status-Beta-orange.svg" alt="Status"/>
2121
</a>
2222
<a href="#gateway-api-status">
23-
<img src="https://img.shields.io/badge/Gateway_API-preview-rgba(159%2C122%2C234)" alt="Gateway API Preivew"/>
23+
<img src="https://img.shields.io/badge/Gateway_API-supported-rgba(159%2C122%2C234)" alt="Gateway API Supported"/>
2424
</a>
2525
<a href="https://ngrok.com/slack">
2626
<img src="https://img.shields.io/badge/Join%20Our%20Community-Slack-blue" alt="Slack"/>

helm/ngrok-operator/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,6 @@ To run multiple ngrok-operator instances in the same cluster (e.g., in different
178178

179179
| Name | Description | Value |
180180
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------- |
181-
| `useExperimentalGatewayApi` | DEPRECATED: Use gateway.enabled instead | |
182181
| `gateway.enabled` | When true, Gateway API support will be enabled if the CRDs are detected. When false, Gateway API support will never be enabled | `true` |
183182
| `gateway.disableReferenceGrants` | When true, disables required ReferenceGrants for cross-namespace references. Does nothing when gateway.enabled is false | `false` |
184183

helm/ngrok-operator/templates/_helpers.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Ngrok Operator manager cli feature flags
7272
{{- if .Values.ingress.enabled -}}
7373
- --enable-feature-ingress={{ .Values.ingress.enabled }}
7474
{{- end }}
75-
{{- if .Values.useExperimentalGatewayApi | default .Values.gateway.enabled }}
75+
{{- if .Values.gateway.enabled }}
7676
- --enable-feature-gateway=true
7777
{{- else }}
7878
- --enable-feature-gateway=false

helm/ngrok-operator/tests/controller-deployment_test.yaml

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -51,36 +51,15 @@ tests:
5151
- contains:
5252
path: spec.template.spec.containers[0].args
5353
content: --disable-reference-grants=true
54-
- it: Uses the new gateway.enabled value when the old one is disabled
54+
- it: Disables the gateway feature when gateway.enabled is false
5555
set:
56-
useExperimentalGatewayApi: false
57-
gateway.enabled: true
58-
template: controller-deployment.yaml
59-
documentIndex: 0 # Document 0 is the deployment since its the first template
60-
asserts:
61-
- contains:
62-
path: spec.template.spec.containers[0].args
63-
content: --enable-feature-gateway=true
64-
- it: Disables the gateway feature when both are false
65-
set:
66-
useExperimentalGatewayApi: false
6756
gateway.enabled: false
6857
template: controller-deployment.yaml
6958
documentIndex: 0 # Document 0 is the deployment since its the first template
7059
asserts:
7160
- contains:
7261
path: spec.template.spec.containers[0].args
7362
content: --enable-feature-gateway=false
74-
- it: Enables the gateway feature when the old value is true (backwards compatibility)
75-
set:
76-
useExperimentalGatewayApi: true
77-
gateway.enabled: false
78-
template: controller-deployment.yaml
79-
documentIndex: 0 # Document 0 is the deployment since its the first template
80-
asserts:
81-
- contains:
82-
path: spec.template.spec.containers[0].args
83-
content: --enable-feature-gateway=true
8463
- it: Should use the specified cluster domain name
8564
set:
8665
clusterDomain: svc.example.com

helm/ngrok-operator/values.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,6 @@ agent:
335335
##
336336
## @section Kubernetes Gateway feature configuration
337337
##
338-
## @extra useExperimentalGatewayApi DEPRECATED: Use gateway.enabled instead
339338
## @param gateway.enabled When true, Gateway API support will be enabled if the CRDs are detected. When false, Gateway API support will never be enabled
340339
## @param gateway.disableReferenceGrants When true, disables required ReferenceGrants for cross-namespace references. Does nothing when gateway.enabled is false
341340
##

tools/make/deploy.mk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ deploy_gateway: _deploy-check-env-vars docker-build manifests _helm_setup kind-l
4242
--set-string log.level="8" \
4343
--set log.stacktraceLevel=panic \
4444
--set metaData.env=local,metaData.from=makefile \
45-
--set useExperimentalGatewayApi=true \
45+
--set gateway.enabled=true \
4646
--set drainPolicy="Delete" \
4747
$(HELM_DESCRIPTION_FLAG)
4848

0 commit comments

Comments
 (0)