aboutsummaryrefslogtreecommitdiff
path: root/src/kubectl-helm-minikube
diff options
context:
space:
mode:
authorgithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>2022-08-18 19:31:22 +0300
committerGitHub <noreply@github.com>2022-08-18 19:31:22 +0300
commit3ac132483a31b769e43c9e985dd3ad16b3cc3202 (patch)
tree1cc6fda9f0ec3778c9f177e0bd20d49eba36a229 /src/kubectl-helm-minikube
parent9c60d26d96906fcce6dc0e29ae4f18f949d5303f (diff)
Automated documentation update (#106)
Co-authored-by: github-actions <github-actions@github.com>
Diffstat (limited to 'src/kubectl-helm-minikube')
-rw-r--r--src/kubectl-helm-minikube/README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/kubectl-helm-minikube/README.md b/src/kubectl-helm-minikube/README.md
index 53edeff..0f60075 100644
--- a/src/kubectl-helm-minikube/README.md
+++ b/src/kubectl-helm-minikube/README.md
@@ -21,6 +21,20 @@ Installs latest version of kubectl, Helm, and optionally minikube. Auto-detects
| helm | Select or enter a Helm version to install | string | latest |
| minikube | Select or enter a Minikube version to install | string | latest |
+## Ingress and port forwarding
+
+When configuring [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for your Kubernetes cluster, note that by default Kubernetes will bind to a specific interface's IP rather than localhost or all interfaces. This is why you need to use the Kubernetes Node's IP when connecting - even if there's only one Node as in the case of Minikube. Port forwarding in Remote - Containers will allow you to specify `<ip>:<port>` in either the `forwardPorts` property or through the port forwarding UI in VS Code.
+
+However, GitHub Codespaces does not yet support this capability, so you'll need to use `kubectl` to forward the port to localhost. This adds minimal overhead since everything is on the same machine. E.g.:
+
+```bash
+minikube start
+minikube addons enable ingress
+# Run this to forward to localhost in the background
+nohup kubectl port-forward --pod-running-timeout=24h -n ingress-nginx service/ingress-nginx-controller :80 &
+```
+
+
---
-_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/kubectl-helm-minikube/devcontainer-feature.json)._
+_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/kubectl-helm-minikube/devcontainer-feature.json). Add additional notes to a `NOTES.md`._