docs: Add integrations/Packs doc for ngrok Kubernetes Ingress Controller #1612
Conversation
❌ Deploy Preview for docs-spectrocloud failed.Built without sensitive environment variables
|
There was a problem hiding this comment.
@joelhans Awesome start to this reference. I added some suggestions and guidance for how we can improve this content. If we make the suggested changes, then this will help address a lot of the common questions users will have.
| tags: ["packs", "ngrok", "network", "kubernetes"] | ||
| --- | ||
|
|
||
| The ngrok [Ingress Controller for Kubernetes](https://github.com/ngrok/kubernetes-ingress-controller) is the official |
There was a problem hiding this comment.
@joelhans the word "official" raises a minor concern. Can we change this sentence so it's more apparent that it's ngrok's official ingress controller? Right now, it could potentially be perceived that this is our official ingress controller or the Kubernetes ecosystem's official controller.
There was a problem hiding this comment.
I changed this initial sentence to remove "official" entirely—your concern is completely understandable!
|
|
||
| Apply the `2048.yaml` manifest to your cluster in Palette. | ||
|
|
||
| ```bash | ||
| kubectl apply -f 2048.yaml | ||
| ``` | ||
|
|
||
| Access your 2048 demo app by navigating to the your `NGROK_DOMAIN`, e.g. `https://one-two-three.ngrok-free.app`. ngrok's | ||
| edge and your Ingress Controller will route traffic to your app from any device or external network. |
There was a problem hiding this comment.
| Apply the `2048.yaml` manifest to your cluster in Palette. | |
| ```bash | |
| kubectl apply -f 2048.yaml | |
| ``` | |
| Access your 2048 demo app by navigating to the your `NGROK_DOMAIN`, e.g. `https://one-two-three.ngrok-free.app`. ngrok's | |
| edge and your Ingress Controller will route traffic to your app from any device or external network. |
We don't need these steps, because this is not intended to be a tutorial. You can link to your actual tutorial if the user wants to learn more through a hands-on example. The important thing here is for the user to understand that they need to add the pack to the cluster profile, configure the pack YAML, and then for their application, they need to create a ingress service definition.
The question I would ask as a newer users is. How do I create the ingress service for my application, assuming the pack is in the cluster profile. That's the piece we are missing. And for that, the answer is to create a manifest layer.
Like this:
CleanShot.2023-09-27.at.07.47.31.mp4
This is really want the usage section should be about.
|
Hi @karl-cardenas-coding! Thanks for the comprehensive feedback, which I've addressed in the latest commits and a few comments above. Your video in particular was quite helpful, as I hadn't even realized you could create manifest layers for defining ingress or apps—I was doing so with I'll keep an eye out for any follow-on feedback! |
There was a problem hiding this comment.
@joelhans Awesome changes Joel. I provided some minor suggestion for minor clean-up. Once these are fixed, let me know so I can generate a preview and get it merged :)
|
@karl-cardenas-coding Added the rest of your suggestions and pushed them here—should be ready for your preview! Thanks again for the feedback. |
Describe the Change
This PR adds a new document for the ngrok Kubernetes Ingress Controller, which is available as a Pack for Palette. For context, I'm working with the ngrok team on improving the documentation where this Controller integrates with another product/platform, to improve the developer experience for anyone who wants to deploy it via Palette.
The Prerequisites and Usage includes some unique settings I found were necessary during my test deployments, and the Usage section showcases a basic deployment that works with the Pack's configuration, which you can still check out at https://handy-firm-aphid.ngrok-free.app/.
Review Changes
💻 Add Preview URL
🎫 Jira Ticket