Skip to main content
Version: 1.45

Getting Started with Okteto and Ruby

Okteto runs your Ruby 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 Ruby 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​

Clone the Ruby Sample App:

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

The Dockerfile​

The Dockerfile of the Ruby Sample App defines two images, one per stage:

Dockerfile
FROM ruby:4.0.10-trixie AS dev

RUN gem install debug -v 1.11.1

ENV APP_ENV=development
WORKDIR /opt/app
COPY Gemfile Gemfile.lock ./
RUN BUNDLE_FROZEN=true bundle install
COPY . .

FROM ruby:4.0.10-slim-trixie AS prod

ENV APP_ENV=production
WORKDIR /opt/app
COPY Gemfile Gemfile.lock ./
RUN BUNDLE_FROZEN=true BUNDLE_WITHOUT=test bundle install
COPY . .
CMD ["ruby", "app.rb"]
  • dev is the development image. It contains Ruby, the gems in Gemfile.lock (among them sinatra/reloader for hot reload), the debug gem (rdbg) for debugging, and the source code. APP_ENV=development runs Sinatra in development mode, where sinatra/reloader reloads app.rb when it changes.
  • prod is the application image. It's based on the slim Ruby image and contains the source code and the gems in Gemfile.lock, without the test group. APP_ENV=production runs Sinatra in production mode, without the reloader.

Both stages follow the recommendations for development images: every version is pinned, and bundle install runs before COPY . ., so a change to the source code doesn't invalidate the layer with the gems.

The Okteto Manifest​

The okteto.yml file is the Okteto Manifest of the Ruby 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 before the hello-world image. 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 Ruby Sample App​

Run okteto deploy from the root folder of the Ruby 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/ruby-getting-started-dev:okteto' successfully pushed
✓ Image 'registry.okteto.example.com/cindy/ruby-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 'ruby-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 ruby-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 Ruby Sample App​

The test section of the Okteto Manifest defines a Test Container that runs the unit tests in test/app_test.rb, written with Minitest and Rack::Test:

okteto.yml
test:
unit:
image: ${OKTETO_BUILD_DEV_IMAGE}
caches:
- /usr/local/bundle
commands:
- bundle install
- bundle exec ruby test/app_test.rb
artifacts:
- coverage
  • image: the development image, so the tests run with the same Ruby version as the Development Container.
  • caches: the folder where Bundler installs the gems, kept between runs of the Test Container. bundle install only installs the gems that aren't in the cache yet.
  • commands: the commands that run the tests. 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 coverage folder with the report of SimpleCov.

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

Run the unit tests from the root folder of the Ruby 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 'bundle install'
Bundle complete! 7 Gemfile dependencies, 17 gems now installed.
✓ Command 'bundle install' successfully executed
i Running 'bundle exec ruby test/app_test.rb'
Run options: --seed 39873
# Running:
.
Finished in 0.009812s, 101.9161 runs/s, 203.8323 assertions/s.
1 runs, 2 assertions, 0 failures, 0 errors, 0 skips
Coverage report generated for Unit Tests to coverage/index.html
Line coverage: 8 / 8 (100.00%)
✓ Command 'bundle exec ruby test/app_test.rb' successfully executed
✓ Test container 'unit' passed

The coverage report is now in the coverage folder, in the root folder of the Ruby Sample App on your machine. Open coverage/index.html in your browser to see the lines that the tests run.

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 Ruby Sample App:

okteto.yml
dev:
hello-world:
image: ${OKTETO_BUILD_DEV_IMAGE}
command: ruby app.rb
sync:
- .:/opt/app
persistentVolume:
enabled: false
forward:
- 1234:1234

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. The development image runs Sinatra in development mode, so sinatra/reloader loads app.rb again on the first request after the file changes.
  • sync: synchronizes the root folder of the Ruby Sample App with /opt/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 gems come from the development image, so there's no volume to create and attach. When you add a gem to the Gemfile, run okteto deploy to build the development image again.
  • forward: forwards port 1234, where rdbg 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:

i Using cindy @ okteto.example.com as context
i 'ruby-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: 1234 -> 1234

[2026-11-19 04:04:25] INFO WEBrick 1.9.2
[2026-11-19 04:04:25] INFO ruby 4.0.10 (2026-11-19) [x86_64-linux]
== Sinatra (v4.2.2) has taken the stage on 8080 for development with backup from WEBrick
[2026-11-19 04:04:25] INFO Rackup::Handler::WEBrick::Server#start: pid=83 port=8080

Open app.rb in your IDE, change the response message on line 10 to Hello world from Okteto!, and save the file:

app.rb
get '/' do
message = 'Hello world from Okteto!'
message
end

Okteto synchronizes app.rb to the Development Container, and sinatra/reloader loads it again on the next request, without restarting the server. 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 Sinatra and exit okteto up.

Debugging with VS Code​

rdbg runs the application with the debugger, so start the Development Container with rdbg instead of ruby app.rb. The command after -- replaces the command of the Okteto Manifest:

okteto up -- rdbg --open --nonstop --host 0.0.0.0 --port 1234 app.rb

--open --host 0.0.0.0 --port 1234 makes rdbg listen for a debugger on port 1234 of the Development Container, and --nonstop starts the application without waiting for the debugger to attach:

DEBUGGER: Debugger can attach via TCP/IP (0.0.0.0:1234)
[2026-11-19 04:06:26] INFO WEBrick 1.9.2
[2026-11-19 04:06:26] INFO ruby 4.0.10 (2026-11-19) [x86_64-linux]
== Sinatra (v4.2.2) has taken the stage on 8080 for development with backup from WEBrick

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

.vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"name": "Connect to okteto",
"type": "rdbg",
"request": "attach",
"debugPort": "localhost:1234",
"localfsMap": "/opt/app:${workspaceFolder}"
}
]
}

localfsMap maps /opt/app, the path in the sync field of the Okteto Manifest, to the folder that you open in VS Code. If you synchronize your code to another path, change /opt/app to match it.

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

Press Ctrl+C to stop the application and rdbg and exit okteto up, and then run okteto up to go back to ruby app.rb.

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 Ruby 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.