Skip to main content
Version: 1.45

Getting Started with Okteto and Go

Okteto runs your Go 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 Go 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 Go Sample App:

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

The Dockerfile​

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

Dockerfile
FROM golang:1.26.5-trixie AS dev

RUN GOBIN=/usr/local/bin go install github.com/air-verse/air@v1.67.4 && \
GOBIN=/usr/local/bin go install github.com/go-delve/delve/cmd/dlv@v1.27.1

WORKDIR /usr/src/app
COPY . .
RUN go build -o /usr/local/bin/hello-world

FROM debian:trixie-slim AS prod

COPY --from=dev /usr/local/bin/hello-world /usr/local/bin/hello-world
CMD ["/usr/local/bin/hello-world"]
  • dev is the development image. It contains the Go toolchain, Air for hot reload, Delve for debugging, and the source code. The go build step fills the Go build cache of the image, so the first build in the Development Container is incremental.
  • prod is the application image. It contains only the binary built in the dev stage.

The dev stage follows the recommendations for development images: every version is pinned, and the stage that builds the application doubles as the development image.

The Okteto Manifest​

The okteto.yml file is the Okteto Manifest of the Go 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 Go Sample App​

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

The test section of the Okteto Manifest defines a Test Container that runs the unit tests in main_test.go:

okteto.yml
test:
unit:
image: ${OKTETO_BUILD_DEV_IMAGE}
caches:
- /go/pkg/mod
- /root/.cache/go-build
commands:
- go test -v -coverprofile=coverage.out ./...
artifacts:
- coverage.out
  • image: the development image, so the tests run with the same Go toolchain as the Development Container.
  • caches: the Go module and build caches, kept between runs of the Test Container.
  • 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 profile.

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

Run the unit tests from the root folder of the Go 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 'go test -v -coverprofile=coverage.out ./...'
=== RUN TestHelloServer
--- PASS: TestHelloServer (0.00s)
PASS
coverage: 20.0% of statements
ok github.com/okteto/go-getting-started 0.004s coverage: 20.0% of statements
✓ Command 'go test -v -coverprofile=coverage.out ./...' successfully executed
✓ Test container 'unit' passed

The coverage profile is now in coverage.out, in the root folder of the Go Sample App on your machine:

go tool cover -func=coverage.out

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

okteto.yml
dev:
hello-world:
image: ${OKTETO_BUILD_DEV_IMAGE}
command: air
sync:
- .:/usr/src/app
persistentVolume:
enabled: false
securityContext:
capabilities:
add:
- SYS_PTRACE
forward:
- 2345:2345

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 Air, which rebuilds and restarts the application every time a .go file changes.
  • sync: synchronizes the root folder of the Go 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 Go build cache comes from the development image, so there's no volume to create and attach. In projects with many dependencies, enable it and add /go/pkg/mod and /root/.cache/go-build to volumes to keep the Go caches between okteto up sessions.
  • securityContext: adds the SYS_PTRACE capability that Delve needs.
  • forward: forwards port 2345, where Delve 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 Air, which builds and runs the application:

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

watching .
!exclude tmp
building...
running...
Starting hello-world server...

Open main.go in your IDE, change the response message on line 17 to Hello world from Okteto!, and save the file:

main.go
func helloServer(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Hello world from Okteto!")
}

Okteto synchronizes main.go to the Development Container, and Air rebuilds and restarts the application:

main.go has changed
building...
running...
Starting hello-world 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 Air and exit okteto up.

Debugging with VS Code​

Delve builds and runs its own copy of the application, so start the Development Container with Delve instead of Air. The command after -- replaces the command of the Okteto Manifest:

okteto up -- make debug

make debug runs dlv debug --headless --listen=:2345 --log --api-version=2. Delve builds the application and waits for a debugger on port 2345 before it starts it:

API server listening at: [::]:2345
info layer=debugger launching process with args: [./__debug_bin3004072740]

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

.vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"name": "Connect to okteto",
"type": "go",
"request": "attach",
"mode": "remote",
"remotePath": "/usr/src/app",
"port": 2345,
"host": "127.0.0.1"
}
]
}

remotePath is the path in the sync field of the Okteto Manifest. If you synchronize your code to another path, change remotePath to match it.

Open the Go Sample App in VS Code, open the Run and Debug view, and run the Connect to okteto configuration. The application starts. Add a breakpoint on line 17 of main.go and reload the endpoint in your browser. Execution stops at the breakpoint, and you can inspect the request and the variables:

VS Code editor with main.go open and a line highlighted in the helloServer function

Ctrl+C doesn't stop Delve. To end the debugging session, run okteto down in another terminal from the root folder of the Go Sample App, and then run okteto up to go back to hot reload.

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