Skip to content
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

Add helm hooks to run ngrok diagnose to check the network for connectivity #445

Open
alex-bezek opened this issue Oct 10, 2024 · 2 comments
Labels
enhancement New feature or request needs-triage Issues that need triage

Comments

@alex-bezek
Copy link
Collaborator

Description

ngrok can sometimes be blocked by corporate firewalls https://ngrok.com/docs/guides/other-guides/running-behind-firewalls/
We can have people test their connection when we see they have specific errors in their logs, but it would be nice if the helm chart could test this for you when installing it.

You can run the diagnose command in the ngrok agent container easily like this

apiVersion: batch/v1
kind: Job
metadata:
  name: ngrok-diagnose
spec:
  template:
    spec:
      containers:
        - name: ngrok-diagnose
          image: ngrok/ngrok:latest
          command: ["/bin/sh", "-c"]
          args: ["ngrok diagnose"]
      restartPolicy: Never

We should include this as a helm pre-install and pre-upgrade hooks as well as a helm test that could then be ran ad-hoc via helm test ngrok-operator

Use Case

Inform users quickly of a specific network issue rather than them installing it and having to debug the logs to find network errors

Related issues

No response

@alex-bezek alex-bezek added enhancement New feature or request needs-triage Issues that need triage labels Oct 10, 2024
@jonstacks
Copy link
Collaborator

This feels like a great first step. Yes, and....we should get something added long term which has ngrok network checks as a first class citizen and does them periodically as DNS and network segments can have intermittent issues.

@alex-bezek
Copy link
Collaborator Author

This feels like a great first step. Yes, and....we should get something added long term which has ngrok network checks as a first class citizen and does them periodically as DNS and network segments can have intermittent issues.

Yeah, are you thinking something like ngrok-go has functions available for these checks that we can then wire up to the operator's readiness probe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs-triage Issues that need triage
Projects
None yet
Development

No branches or pull requests

2 participants