Services

Overview

A service is one program of an environment, run from a container image. The environment always takes the whole list of services: the platform starts new services, restarts changed ones, and stops the ones left out.

A removed service keeps its folders on the disk, so adding it again with the same mounts finds its data.

To do these tasks with an AI agent, see Agentic workflows.

Tasks

Add a service

Reason for the task

Run another program in an environment.

Job set-up

• Access: you. A team environment needs team membership.
• References: PATCH /v1/environments/{id}.

Procedure

1. Add the service. With the SDK, read the current list and send it back with the new service.

   PythonCopy

   from kloudlite import Kodekl = Kloudlite()env = kl.environments.get(environment="acme-dev")services = env["services"] + [{"name": "cache", "image": "redis:7", "ports": [6379]}]kl.environments.set_services(environment="acme-dev", services=services)

   TypeScriptCopy

   import { Kode, type Service } from "./index.ts";const kl = new Kloudlite();const env = (await kl.environments.get({ environment: "acme-dev" })) as { services: Service[] };const services = [...env.services, { name: "cache", image: "redis:7", ports: [6379] }];await kl.environments.setServices({ environment: "acme-dev", services });

   GoCopy

   kl := kloudlite.New(kloudlite.Options{})env, err := kl.Environments.Get("acme-dev")if err != nil {    log.Fatal(err)}var services []kloudlite.Serviceraw, _ := json.Marshal(env["services"])if err := json.Unmarshal(raw, &services); err != nil {    log.Fatal(err)}services = append(services, kloudlite.Service{Name: "cache", Image: "redis:7", Ports: []int{6379}})if err := kl.Environments.SetServices(kloudlite.SetServices{Environment: "acme-dev", Services: services}); err != nil {    log.Fatal(err)}

   RubyCopy

   require_relative "kloudlite"kl = Kloudlite::Client.newenv = kl.environments.get(environment: "acme-dev")services = env["services"] + [{ name: "cache", image: "redis:7", ports: [6379] }]kl.environments.set_services(environment: "acme-dev", services: services)

   JavaCopy

   var kl = new Kloudlite();// Replaces the list: describe every service that stays, and the new one.var db = new Kloudlite.Service().name("db").image("postgres:16").port(5432)    .env("POSTGRES_PASSWORD", "dev").mount("pgdata", "/var/lib/postgresql/data");var cache = new Kloudlite.Service().name("cache").image("redis:7").port(6379);kl.environments().setServices(new Kloudlite.SetServices().environment("acme-dev").services(db, cache));

   CLICopy

   # Replaces the list: send every service, including the new one.kode environments set-services acme-dev --services '[  {"name": "db", "image": "postgres:16", "ports": [5432], "env": {"POSTGRES_PASSWORD": "dev"}, "mounts": [{"folder": "pgdata", "path": "/var/lib/postgresql/data"}]},  {"name": "cache", "image": "redis:7", "ports": [6379]}]'

Close-out

1. Make sure that service_status shows cache as ready.

Change a service

Reason for the task

Change the image, variables, ports, or mounts of a service.

Job set-up

• Access: you. A team environment needs team membership.
• References: PATCH /v1/environments/{id}.

Procedure

1. Send the changed service, here db on postgres:17.

   PythonCopy

   env = kl.environments.get(environment="acme-dev")services = [{**sv, "image": "postgres:17"} if sv["name"] == "db" else sv for sv in env["services"]]kl.environments.set_services(environment="acme-dev", services=services)

   TypeScriptCopy

   const env = (await kl.environments.get({ environment: "acme-dev" })) as { services: Service[] };const services = env.services.map((sv) => (sv.name === "db" ? { ...sv, image: "postgres:17" } : sv));await kl.environments.setServices({ environment: "acme-dev", services });

   GoCopy

   env, err := kl.Environments.Get("acme-dev")if err != nil {    log.Fatal(err)}var services []kloudlite.Serviceraw, _ := json.Marshal(env["services"])if err := json.Unmarshal(raw, &services); err != nil {    log.Fatal(err)}for i := range services {    if services[i].Name == "db" {        services[i].Image = "postgres:17"    }}if err := kl.Environments.SetServices(kloudlite.SetServices{Environment: "acme-dev", Services: services}); err != nil {    log.Fatal(err)}

   RubyCopy

   env = kl.environments.get(environment: "acme-dev")services = env["services"].map { |sv| sv["name"] == "db" ? sv.merge("image" => "postgres:17") : sv }kl.environments.set_services(environment: "acme-dev", services: services)

   JavaCopy

   // Replaces the list: describe every service, with the new image for db.var db = new Kloudlite.Service().name("db").image("postgres:17").port(5432)    .env("POSTGRES_PASSWORD", "dev").mount("pgdata", "/var/lib/postgresql/data");var cache = new Kloudlite.Service().name("cache").image("redis:7").port(6379);kl.environments().setServices(new Kloudlite.SetServices().environment("acme-dev").services(db, cache));

   CLICopy

   kode environments set-services acme-dev --services '[  {"name": "db", "image": "postgres:17", "ports": [5432], "env": {"POSTGRES_PASSWORD": "dev"}, "mounts": [{"folder": "pgdata", "path": "/var/lib/postgresql/data"}]},  {"name": "cache", "image": "redis:7", "ports": [6379]}]'

Close-out

1. Make sure that the service shows the new value and is ready.

Remove a service

Reason for the task

Stop a program and take it out of an environment.

Job set-up

• Access: you. A team environment needs team membership.
• References: PATCH /v1/environments/{id}.

Procedure

1. Send the list without the service. Its folders stay on the disk.

   PythonCopy

   env = kl.environments.get(environment="acme-dev")services = [sv for sv in env["services"] if sv["name"] != "cache"]kl.environments.set_services(environment="acme-dev", services=services)

   TypeScriptCopy

   const env = (await kl.environments.get({ environment: "acme-dev" })) as { services: Service[] };await kl.environments.setServices({ environment: "acme-dev", services: env.services.filter((sv) => sv.name !== "cache") });

   GoCopy

   env, err := kl.Environments.Get("acme-dev")if err != nil {    log.Fatal(err)}var services []kloudlite.Serviceraw, _ := json.Marshal(env["services"])if err := json.Unmarshal(raw, &services); err != nil {    log.Fatal(err)}kept := services[:0]for _, sv := range services {    if sv.Name != "cache" {        kept = append(kept, sv)    }}if err := kl.Environments.SetServices(kloudlite.SetServices{Environment: "acme-dev", Services: kept}); err != nil {    log.Fatal(err)}

   RubyCopy

   env = kl.environments.get(environment: "acme-dev")kl.environments.set_services(environment: "acme-dev", services: env["services"].reject { |sv| sv["name"] == "cache" })

   JavaCopy

   // Replaces the list: describe every service that stays.var db = new Kloudlite.Service().name("db").image("postgres:16").port(5432)    .env("POSTGRES_PASSWORD", "dev").mount("pgdata", "/var/lib/postgresql/data");kl.environments().setServices(new Kloudlite.SetServices().environment("acme-dev").services(db));

   CLICopy

   kode environments set-services acme-dev --services '[  {"name": "db", "image": "postgres:16", "ports": [5432], "env": {"POSTGRES_PASSWORD": "dev"}, "mounts": [{"folder": "pgdata", "path": "/var/lib/postgresql/data"}]}]'

Close-out

1. Make sure that the service is no longer in services.

Troubleshooting