Skip to main content
Version: 1.45

Getting Started with Okteto and Node.js

Okteto runs your Node.js application in Kubernetes while you edit it on your machine: every time you save a file, the change runs in your cluster a few seconds later, and you can debug it with breakpoints from your IDE. The Node.js Sample App, a hello world HTTP server, is configured so that Okteto builds, deploys, and tests it directly in your Kubernetes cluster. To do the same in your own repository, we recommend using an AI agent with the Okteto agent skills.

Prerequisites​

  • The Okteto CLI, installed and configured to access your Okteto instance. See the installation guide.
  • To debug the application: VS Code. Its built-in JavaScript debugger attaches to the Node.js inspector, so you don't need an extension.

Clone the Node.js Sample App:

git clone https://github.com/okteto/node-getting-started
cd node-getting-started

The Dockerfile​

The Dockerfile of the Node.js Sample App defines two images, one per stage:

Dockerfile
FROM node:26.13.1-trixie-slim AS dev

WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN npm ci
COPY . .

FROM node:26.13.1-trixie-slim AS prod

WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN npm ci --omit=dev
COPY . .
ENV NODE_ENV=production
CMD ["node", "index.js"]
  • dev is the development image. It contains Node.js, npm, the dependencies that npm ci installs from package-lock.json, and the source code. Node.js includes the watch mode for hot reload and the inspector for debugging, so the image doesn't need other tools.
  • prod is the application image. It contains Node.js, the production dependencies, and the source code, and runs the application with node and NODE_ENV=production.

The dev stage follows the recommendations for development images: every version is pinned, and both stages install the dependencies from the same package-lock.json.

The Okteto Manifest​

The okteto.yml file is the Okteto Manifest of the Node.js Sample App.

Build​

The build section builds both images:

okteto.yml
build:
dev:
context: .
target: dev
hello-world:
context: .
target: prod
depends_on:
- dev

target selects a stage of the Dockerfile. depends_on makes Okteto build the dev image first, so hello-world reuses its cached layers. Okteto pushes both images to the Okteto Registry and stores their references in the OKTETO_BUILD_DEV_IMAGE and OKTETO_BUILD_HELLO_WORLD_IMAGE variables.

Deploy​

The deploy section installs the Helm chart in the chart folder, with the application image that Okteto built:

okteto.yml
deploy:
image: alpine/helm:4.3.2
commands:
- helm upgrade --install hello-world chart --set image=${OKTETO_BUILD_HELLO_WORLD_IMAGE}

The command runs with Remote Execution, in a container inside your cluster that uses the image set in deploy.image, so you don't need Helm on your machine.

Deploying the Node.js Sample App​

Run okteto deploy from the root folder of the Node.js Sample App:

okteto deploy

Okteto builds the dev and hello-world images, runs the deploy command, and prints the endpoint of the application:

i Using cindy @ okteto.example.com as context
✓ Image 'registry.okteto.example.com/cindy/node-getting-started-dev:okteto' successfully pushed
✓ Image 'registry.okteto.example.com/cindy/node-getting-started-hello-world:okteto' successfully pushed
i Running stage 'helm upgrade --install hello-world chart --set image=${OKTETO_BUILD_HELLO_WORLD_IMAGE}'
Executing command 'helm upgrade --install hello-world chart --set image=${OKTETO_BUILD_HELLO_WORLD_IMAGE}'...
Release "hello-world" does not exist. Installing it now.
NAME: hello-world
NAMESPACE: cindy
STATUS: deployed
REVISION: 1
i Endpoints available:
- https://hello-world-cindy.okteto.example.com
✓ Development environment 'node-getting-started' successfully deployed

Open the endpoint in your browser to see the Hello world! response. The Okteto UI shows the same endpoint:

Okteto UI showing the cindy Namespace with the node-getting-started Dev Environment deployed, its hello-world Deployment running, and its endpoint

Okteto creates an HTTPS endpoint for the Ingress in the Helm chart.

Testing the Node.js Sample App​

The test section of the Okteto Manifest defines a Test Container that runs the unit tests in index.test.js with the Node.js test runner:

okteto.yml
test:
unit:
image: ${OKTETO_BUILD_DEV_IMAGE}
caches:
- /root/.npm
commands:
- npm ci
- node --test --test-reporter=spec --test-reporter-destination=stdout --test-reporter=junit --test-reporter-destination=junit.xml
artifacts:
- junit.xml
  • image: the development image, so the tests run with the same Node.js version as the Development Container.
  • caches: the npm cache, kept between runs of the Test Container.
  • commands: the commands that run the tests. npm ci installs the dependencies next to the files that the Okteto CLI sends, and node --test prints the results and writes a JUnit report to junit.xml. The Test Container fails if any of them exits with a non-zero code.
  • artifacts: the files that Okteto copies to your machine when the tests finish, in this case the JUnit report.

Test Containers run with Remote Execution, in a container inside your cluster.

Run the unit tests from the root folder of the Node.js Sample App:

okteto test
i Using cindy @ okteto.example.com as context
i Images were already built. To rebuild your images run 'okteto build'
i Executing test container 'unit'
i Running 'npm ci'
added 65 packages, and audited 66 packages in 567ms
✓ Command 'npm ci' successfully executed
i Running 'node --test --test-reporter=spec --test-reporter-destination=stdout --test-reporter=junit --test-reporter-destination=junit.xml'
✔ GET / responds with Hello world! (48.884243ms)
ℹ tests 1
ℹ pass 1
ℹ fail 0
✓ Command 'node --test --test-reporter=spec --test-reporter-destination=stdout --test-reporter=junit --test-reporter-destination=junit.xml' successfully executed
✓ Test container 'unit' passed

The JUnit report is now in junit.xml, in the root folder of the Node.js Sample App on your machine. CI systems and IDEs read test results in the JUnit format.

Running okteto deploy and okteto test after each change is usually fast enough, especially when an AI agent writes and tests the code autonomously. With the Okteto agent skills, the agent runs this loop in its own Namespace and reports back the tests it ran, the endpoints of the application, and a link to that Namespace.

Developing in a Development Container​

If you use AI agents, the Development Container is optional: agents work well with the okteto deploy and okteto test cycle, and don't need one. A Development Container gives you the experience of developing on your machine, with hot reload and a debugger on every change. When you run okteto up, Okteto replaces the hello-world Deployment with the Development Container, keeps your local files synchronized with it, and runs the hot-reload and debugging tools of the development image in your cluster.

While okteto up is running, an AI agent with the Okteto agent skills skips the build and deploy cycle: your changes already reach the Development Container through File Sync, so the agent waits for you to tell it what to run next.

Configuration​

The dev section of the okteto.yml file defines the Development Container of the Node.js Sample App:

okteto.yml
dev:
hello-world:
image: ${OKTETO_BUILD_DEV_IMAGE}
command: node --watch --inspect index.js
sync:
- .:/usr/src/app
persistentVolume:
enabled: false
forward:
- 9229:9229

The hello-world key matches the name of the Deployment in the Helm chart. These are the fields of the Development Container:

  • image: the development image built in the build section.
  • command: starts the application in watch mode (--watch), which restarts it whenever one of its files changes, and with the inspector (--inspect) listening for debuggers on port 9229.
  • sync: synchronizes the root folder of the Node.js Sample App with /usr/src/app, the working directory of the development image.
  • persistentVolume: disables the persistent volume of the Development Container. Okteto synchronizes the files again on every okteto up, and the dependencies in node_modules come from the development image, so there's no volume to create and attach. In projects with many dependencies, enable it and add /root/.npm to volumes to keep the npm cache between okteto up sessions.
  • forward: forwards port 9229, where the inspector listens, to your machine.

Hot reload​

Run okteto up to replace the hello-world Deployment with the Development Container:

okteto up

Okteto synchronizes your files and starts the application in watch mode, with the inspector:

i Using cindy @ okteto.example.com as context
i 'node-getting-started' was already deployed. To redeploy run 'okteto deploy' or 'okteto up --deploy'
✓ Images successfully pulled
✓ Files synchronized
Context: okteto.example.com
Namespace: cindy
Name: hello-world
Forward: 9229 -> 9229

Debugger listening on ws://127.0.0.1:9229/392fafa3-55b2-4d6c-a4da-7ff871cd3486
For help, see: https://nodejs.org/learn/getting-started/debugging
Started hello-world server on 3000

Open index.js in your IDE, change the response message on line 7 to Hello world from Okteto!, and save the file:

index.js
app.get('/', function (req, res) {
res.send('Hello world from Okteto!');
});

Okteto synchronizes index.js to the Development Container, and Node.js clears the terminal and restarts the application and the inspector:

Change detected in '/usr/src/app/index.js'
Restarting 'index.js'
Debugger listening on ws://127.0.0.1:9229/844ccc13-d7b5-4400-9174-001bd1473c80
For help, see: https://nodejs.org/learn/getting-started/debugging
Started hello-world server on 3000

Reload the endpoint in your browser to see the new message. The change runs in your cluster without building an image or redeploying the application.

Press Ctrl+C to stop the application and exit okteto up.

Debugging with VS Code​

The command of the Development Container starts the inspector together with the watch mode, so you debug the same okteto up session that reloads your changes. Every time the application restarts, the inspector starts again on port 9229.

The .vscode/launch.json file of the Node.js Sample App attaches VS Code to the inspector through the port that okteto up forwards to your machine:

.vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"name": "Connect to okteto",
"type": "node",
"request": "attach",
"address": "127.0.0.1",
"port": 9229,
"localRoot": "${workspaceFolder}",
"remoteRoot": "/usr/src/app",
"restart": true,
"skipFiles": [
"<node_internals>/**"
]
}
]
}

remoteRoot is the path in the sync field of the Okteto Manifest. If you synchronize your code to another path, change remoteRoot to match it. restart attaches VS Code again every time the watch mode restarts the application.

Open the Node.js Sample App in VS Code, open the Run and Debug view, and run the Connect to okteto configuration. Add a breakpoint on line 7 of index.js and reload the endpoint in your browser. Execution stops at the breakpoint, and you can inspect the request and the variables.

To end the debugging session, stop the Connect to okteto configuration in VS Code. The application keeps running with hot reload until you press Ctrl+C to exit okteto up.

Cleaning up​

okteto down stops the Development Container and brings back the hello-world Deployment with the application image:

okteto down

When you're done, okteto destroy uninstalls the Helm release of the Node.js Sample App from your Namespace:

okteto destroy

FAQ​

How do I make builds, deploys, and okteto up faster?​

Upload only the files that each command needs: the context upload is key to performance. Every okteto build, okteto deploy, okteto test, and okteto up uploads files from your machine, and three ignore files decide what gets uploaded: .dockerignore for the image builds, .oktetoignore for okteto deploy, okteto test, and okteto destroy, and .stignore for File Sync. An AI agent with the Okteto agent skills configures them for your application and measures how much faster your builds, deploys, and okteto up get. Optimize your Development Environments covers these and other optimizations.

How do I deploy an application with several services and a database?​

Follow Deploy Your Application to Okteto if you deploy with a Helm chart, or Develop a Docker Compose application with Okteto if you use Docker Compose. If your services live in several repositories, see Deploy a multi-repo application with dependencies.

Do I need to deploy the whole application in every Namespace?​

No. Divert lets you deploy only the services you change and reuse the services of a shared environment.

How do I start each environment with realistic data?​

Create its database from a Volume Snapshot instead of running a seed script on every deploy. Data from Volume Snapshots shows how.

How do I create resources outside Kubernetes, such as a cloud database?​

Create them in the deploy and destroy commands with your infrastructure as code tool, so every environment gets its own cloud resources. Create cloud infrastructure with Terraform shows how, with an Amazon S3 bucket for each environment.

Where can I find every field of the Okteto Manifest?​

The Okteto Manifest reference lists every field of build, deploy, destroy, test, and dev.