-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updating NOTES.txt file in helm chart #397
Open
salilsub
wants to merge
1
commit into
main
Choose a base branch
from
update_helm_notesdottxt
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,28 @@ | ||
NOTES: | ||
================================================================================ | ||
The ngrok Ingress controller has been deployed as a Deployment type to your | ||
cluster. | ||
|
||
If you haven't yet, create some Ingress resources in your cluster and they will | ||
be automatically configured on the internet using ngrok. | ||
|
||
|
||
{{- $found := false }} | ||
{{- range $svcIndex, $service := (lookup "v1" "Service" "" "").items }} | ||
{{- if not $found }} | ||
{{- range $portMapIdx, $portMap := $service.spec.ports }} | ||
{{- if eq $portMap.port 80 443 }} | ||
{{- if ne $service.metadata.name "kubernetes" }} | ||
{{- $found = true -}} | ||
{{- $randomStr := randAlphaNum 8 | lower }} | ||
|
||
One example, taken from your cluster, is the Service: | ||
{{ $service.metadata.name | quote }} | ||
|
||
You can make this accessible via ngrok with the following manifest: | ||
-------------------------------------------------------------------------------- | ||
apiVersion: networking.k8s.io/v1 | ||
kind: Ingress | ||
metadata: | ||
name: {{ $service.metadata.name }} | ||
namespace: {{ $service.metadata.namespace }} | ||
spec: | ||
ingressClassName: ngrok | ||
rules: | ||
- host: {{ $service.metadata.name -}}-{{- $randomStr -}}.ngrok.app | ||
http: | ||
paths: | ||
- path: / | ||
pathType: Prefix | ||
backend: | ||
service: | ||
name: {{ $service.metadata.name }} | ||
port: | ||
number: {{ $portMap.port }} | ||
-------------------------------------------------------------------------------- | ||
Applying this manifest will make the service {{ $service.metadata.name | quote }} | ||
available on the public internet at "https://{{ $service.metadata.name -}}-{{- $randomStr -}}.ngrok.app/". | ||
{{- end }} | ||
{{- end }} | ||
{{- end }} | ||
{{- end}} | ||
{{- end }} | ||
|
||
Once done, view your edges in the Dashboard https://dashboard.ngrok.com/cloud-edge/edges | ||
Find the tunnels running in your cluster here https://dashboard.ngrok.com/tunnels/agents | ||
|
||
If you have any questions or feedback, please join us in https://ngrok.com/slack and let us know! | ||
Thank you for installing the ngrok Kubernetes Operator v{{ .Chart.AppVersion }}! | ||
|
||
--- | ||
|
||
The following components are enabled: | ||
|
||
|
||
The following the components have been installed on your cluster | ||
* Ingress Controller | ||
{{ if .Values.UseExperimentalGatewayApi }} | ||
* Gateway API | ||
{{ end }} | ||
|
||
--- | ||
|
||
================================================================================ | ||
|
||
To get started with the Ingress Controller visit: | ||
https://ngrok.com/s/k8s-ingress-controller | ||
|
||
To get started with the Gateway API visit: | ||
https://ngrok.com/s/k8s-gateway-api | ||
|
||
View your edges in the Dashboard https://dashboard.ngrok.com/cloud-edge/edges | ||
Find the tunnels running in your cluster here https://dashboard.ngrok.com/tunnels/agents |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depending on if this merges before or after the rename, we'll want to update this to match