{{announcement.body}}
{{announcement.title}}

Minikube + Cloud Code + VSCode

DZone 's Guide to

Minikube + Cloud Code + VSCode

Using Google Cloud Code for cloud-native app development? Love coding on VSCode? Here's how to use minikube to get Kubernetes integrated with them.

· Cloud Zone ·
Free Resource

As a developer, you can deploy your Docker containers to a local Kubernetes cluster on your laptop using minikube. You can then use the Google Cloud Code extension for Visual Studio Code.

You can then make real time changes to your code and the app will deploy in the background automatically.

  1. Install kubectl – https://kubernetes.io/docs/tasks/tools/install-kubectl/
  2. Install minikube – https://kubernetes.io/docs/tasks/tools/install-minikube/
    • For Windows users, I recommend the Chocolaty approach
  3. Configure Google Cloud Code to use minikube.
  4. Deploy your application to your local minikube cluster in Visual Studio Code
  5. Ensure you add your container registry in the .vscode\launch.json file – See Appendix

Also, ensure you are running Visual Studio Code as an Administrator.

Once deployed, you can make changes to your code, and it will automatically be deployed to the cluster.

Not quite what you're looking for? Then check out our collection of our best Kubernetes articles.

Create a minikube Cluster in Windows (Hyper-V) and Deploy a Simple Web Server

Shell
 




x
6


 
1
minikube start --vm-driver=hyperv
2
kubectl create deployment hello-minikube --image=k8s.gcr.io/echoserver:1.10
3
kubectl expose deployment hello-minikube --type=NodePort --port=8080
4
kubectl get pod
5
minikube service hello-minikube --url
6
minikube dashboard
62
  



Grab the output from the minikube hello-minikube –url and browse your web app/service.

Appendix

Starting the minikube Cluster and Deploying a Default Container

starting-minikube-cluster


VS Code Deployment

  • Setup your Container Registry in the .vscode\launch.json (detailed below)
  • Click Cloud Code on the bottom tray
  • Click "Run on Kubernetes "
  • Open a separate command prompt as administrator

.vscode\launch.json:

JSON




x
27


1
{
2
    "version": "0.2.0",
3
    "configurations": [
4
        {
5
            "name": "Run on Kubernetes",
6
            "type": "cloudcode.kubernetes",
7
            "request": "launch",
8
            "skaffoldConfig": "${workspaceFolder}\\skaffold.yaml",
9
            "watch": true,
10
            "cleanUp": true,
11
            "portForward": true,
12
            "imageRegistry": "romikocontainerregistry/minikube"
13
        },
14
        {
15
            "podSelector": {
16
                "app": "node-hello-world"
17
            },
18
            "type": "cloudcode",
19
            "language": "Node",
20
            "request": "attach",
21
            "debugPort": 9229,
22
            "localRoot": "${workspaceFolder}",
23
            "remoteRoot": "/hello-world",
24
            "name": "Debug on Kubernetes"
25
        }
26
    ]
27
}



debug-on-kubernetes


Shell




xxxxxxxxxx
1


 
1
minikube dashboard



kubernetes-service


We can see our new service is being deployed by VSCode Cloud Code extension. Whenever we make changes to the code, it will automatically deploy.

Shell




x
1


1
minikube service nodejs-hello-world-external --url



The above command will give us the URL to browse the web app.

If I now change the text for "Hello, world!" it will automatically deploy. Just refresh the browser.

Here in the status bar, we can see deployments as we update code.

kubernetes-deployments
kubernetes-demo-deployment

Debugging

Once you have deployed your app to minikube, you can then kick off debugging. This is pretty awesome. Basically,  your development environment is now a full Kubernetes stack with attached debugging proving a seamless experience.

Check out https://cloud.google.com/code/docs/vscode/debug#nodejs for more information.

You will notice that in the launch.json file, we set up the debugger port, etc. Below, I am using port 9229. So all I need to do is start the app with:   

Shell




x


1
CMD [“node”, “–inspect=9229”, “app.js”]



Or, in the launch.json file, I can set set "args": ["-inspect=9229"]. This is only supported in launch request type.   

Also, ensure the Pod Selector is correct. You can use the pod name or label. You can confirm the pod name using the minikube dashboard.

http://127.0.0.1:61668/api/v1/namespaces/kubernetes-dashboard/services/http:kubernetes-dashboard:/proxy/#/pod?namespace=default
kubernetes-pod-selector
JSON




x
28


1
{
2
    "version": "0.2.0",
3
    "configurations": [
4
        {
5
            "name": "Run on Kubernetes",
6
            "type": "cloudcode.kubernetes",
7
            "request": "launch",
8
            "skaffoldConfig": "${workspaceFolder}\\skaffold.yaml",
9
            "watch": true,
10
            "cleanUp": true,
11
            "portForward": true,
12
            "imageRegistry": "dccausbcontainerregistry/minikube",
13
            "args": ["--inspect=9229"]
14
        },
15
        {
16
            "name": "Debug on Kubernetes",
17
            "podSelector": {
18
                "app": "nodejs-hello-world"
19
            },
20
            "type": "cloudcode",
21
            "language": "Node",
22
            "request": "attach",
23
            "debugPort": 9229,
24
            "localRoot": "${workspaceFolder}",
25
            "remoteRoot": "/hello-world"
26
        }
27
    ]
28
}



Now we can do the following

  1. Click Run on Kubernetes
  2. Set a Break Point
  3. Click Debug on Kubernetes
kubernetes-on-vscode

Tips

  • Run the command prompt, PowerShell and VSCode as Administrator
  • Use Choco for Windows installs
  • If you are going to reboot/sleep/shut down your machine. Please run:
Shell




xxxxxxxxxx
1


 
1
minikube stop



If you do not, you risk corrupting Hyper-V and you will get all sorts of issues.

Further Reading

Running Spring Boot Application on Kubernetes Minikube on Windows (Part 1)

Microservices With Kubernetes and Docker

Topics:
cloud ,google cloud code ,kubernetes ,minikube ,tutorial ,visual studio code

Published at DZone with permission of Romiko Derbynew , DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}