diff options
Diffstat (limited to 'features/src/kubectl-helm-minikube/README.md')
| -rw-r--r-- | features/src/kubectl-helm-minikube/README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/features/src/kubectl-helm-minikube/README.md b/features/src/kubectl-helm-minikube/README.md new file mode 100644 index 0000000..81ce8c5 --- /dev/null +++ b/features/src/kubectl-helm-minikube/README.md @@ -0,0 +1,45 @@ + +# Kubectl, Helm, and Minikube (kubectl-helm-minikube) + +Installs latest version of kubectl, Helm, and optionally minikube. Auto-detects latest versions and installs needed dependencies. + +## Example Usage + +```json +"features": { + "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | Select or enter a Kubernetes version to install | string | latest | +| 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 & +``` + + +## OS Support + +This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed. + +`bash` is required to execute the `install.sh` script. + + +--- + +_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`._ |