Build a cloud development environment with Telepresence & NodeJS
There are two main challenges associated with building productive development experiments on Kubernetes:
- Kubernetes applications are designed to be native to the cloud, but most legacy development workflows are built for local development.
- Kubernetes applications are built on a microservices architecture. The development environment becomes more complex as new microservices add additional dependencies to your application. These services quickly become too resource-intensive (https://www.getambassador.io/resources/eliminate-local-resource-constraints/) and exceed the limits of your local machine.
In this tutorial, we’ll set up a development environment for Kubernetes and make a change to a NodeJS microservice. To develop locally, we’d have to wait for a container build, push to a registry and deploy to see the effect of our code change. Instead, we’ll use Telepresence to see the results of our change instantly.
Step 1: Deploy a Sample Microservices Application
For this example, we’ll make code changes to a NodeJS service running between a resource-intensive Java service and a large datastore. We’ll start by deploying a sample microservice application consisting of 3 services:
VeryLargeJavaService: A memory-intensive service written in Java that generates the front-end graphics and web pages for our application
DataProcessingService: A NodeJS service that manages requests for information between the two services.
VeryLargeDataStore: A large datastore service that contains the sample data for our Edgey Corp store.
Note: We’ve called these VeryLarge services to emphasize the fact that your local environment may not have enough CPU and RAM, or you may just not want to pay for all that extra overhead for every developer.
In this architecture diagram, you’ll notice that requests from users are routed through an ingress controller to our services. For simplicity’s sake, we’ll skip the step of deploying an ingress controller in this tutorial. If you’re ready to use Telepresence in your own setup and need a simple way to set up an ingress controller, we recommend checking out the Ambassador Edge Stack which can be easily configured with the K8s Initializer.
1. Deploy the sample application to your Kubernetes cluster
Step 2: Set up your local development environment
We’ll need a local development environment so that we can edit the
DataProcessingService service. As you can see in the architecture diagram above, the
DataProcessingService is dependent on both the
VeryLargeJavaService and the
VeryLargeDataStore, so in order to make a change to this service, we’ll have to interact with these other services as well. Let’s get started!
1. Clone the repository for this application from GitHub.
2. Change directories into the DataProcessingService
3. Install dependencies and start the service locally.
4. You should now see your service running!
5. 5. Test the application. In another terminal, we’ll send a request to the service, which should return
Step 3: Rapid development with Telepresence
Instead of waiting for a container image to build, pushed to a repository, and deployed to a Kubernetes cluster, we are going to use Telepresence, an open source Cloud Native Computing Foundation project. Telepresence creates a bidirectional network connection between your local development and the Kubernetes cluster to enable fast, efficient Kubernetes development.
1. Download Telepresence (~60MB):
2. Make the binary executable
3. Test Telepresence by connecting to the remote Kubernetes cluster
4. Send a request to the Kubernetes API server:
Great! You’ve successfully configured Telepresence. Right now, Telepresence is intercepting the request you’re making to the Kubernetes API server, and routing over its direct connection to the cluster instead of over the Internet.
Step 4: Intercept your NodeJS service
An intercept is a routing rule for Telepresence. We can create an intercept to route traffic intended for the
DataProcessingService in the cluster and instead, route all of the traffic to the local version of the
DataProcessingService running on port 3000.
1. Create the intercept
2. Access the application directly with Telepresence. Visit
http://verylargejavaservice:8080. Again, Telepresence is intercepting requests from your browser and routing them directly to the Kubernetes cluster.
3. Now, we’ll make a code change. Open
edgey-corp-nodejs/DataProcessingService/app.js and change
orange. Save the file.
4. Reload the page in your browser, and see how the color has changed from blue to orange.
That’s it! With Telepresence we saw how quickly we can go from editing a local service to seeing how these changes will look when deployed with the larger application. When you compare it to our original process of building and deploying a container after every change, it’s very easy to see how much time you can save especially as we make more complex changes or run even larger services.
Learn More about Telepresence
Typically, developers at organizations adopting Kubernetes face challenges slow feedback loops from inefficient local development environments. Today, we’ve learned how to use Telepresence to set up fast, efficient development environments for Kubernetes and get back to the instant feedback loops you had with your legacy applications.
If you want to learn more about Telepresence, check out the following resources:
- Read the docs
- Watch the demo video
- Read more about Intercepts
- Learn about Preview URLs for easy collaboration with teammates
- Join our Slack channel to connect with the Telepresence community
In our next tutorial, we’ll use Telepresence to set up a local Kubernetes development environment and then use VSCode to set breakpoints and debug a broken service. To be notified when more tutorials are available, make sure to check out our website or follow us on Twitter.