Sessions

Description and operation

General

A session is a network group. It joins a set of workspaces to one environment, so that each workspace reaches the services of the environment by name, for example postgres://db:5432. Code in a workspace runs against the real dependencies of the application, with no local set-up.

A session belongs to the person who creates it, in their personal team or in a team. Other members of the team cannot see or change it. They work in their own sessions, which can connect to the same environment.

Sessions let several developers work on one environment at the same time, each in their own session. See Use cases.

A session has a name: name for a personal session, team/name for a team session. Its id starts with ses-.

States

Lifecycle

• Use. A session is in use while any of its workspaces is in use: an SSH connection, a tool request or a running sandbox. A detached process does not count.
• Idle stop. After 30 minutes without use, the session is idle and its workspaces stop, with idle_since set. Its environment stops 5 minutes later, unless another awake session is connected to it.
• Wake. Starting a workspace of the session, creating a workspace in it, connecting an environment or sending a hold wakes the session and its environment. A wake never starts a resource that you stopped yourself.
• Stop. Stopping a session stops all its workspaces. Their homes are kept. Starting the session starts them again.
• Time to live. The platform deletes a session that is not used for ttl_secs (600 to 2592000). An awake session never expires.
• End. Ending a session releases its intercepts and deletes its workspaces. Their snapshots and the environment remain.

Quota and limits

A running session uses 2 vCPU and 4 GB of memory from the owner's quota, and 10 GB of disk at all times. Its workspaces and its environment count separately.

Tasks

Create a session

Reason for the task: Start a working context for your workspaces.

Job set-up

• Access: you.
• References: POST /v1/sessions.

Procedure

1. Create the session. Use team/name for a team session, and set environment to connect one at once.

   PythonCopy

   from kloudlite import Kloudlitekl = Kloudlite()x = kl.sessions.create(session="dev", environment="shop")print(x["id"])

   TypeScriptCopy

   import { Kloudlite } from "./index.ts";const kl = new Kloudlite();const x: any = await kl.sessions.create({ session: "dev", environment: "shop" });console.log(x.id);

   GoCopy

   kl := kloudlite.New(kloudlite.Options{})x, err := kl.Sessions.Create(kloudlite.CreateSession{Session: "dev", Environment: "shop"})if err != nil {    log.Fatal(err)}fmt.Println(x["id"])

   RubyCopy

   require_relative "kloudlite"kl = Kloudlite::Client.newputs kl.sessions.create(session: "dev", environment: "shop")["id"]

   JavaCopy

   var kl = new Kloudlite();System.out.println(kl.sessions().create(new Kloudlite.CreateSession().session("dev").environment("shop")));

   CLICopy

   kloudlite sessions create dev --environment shop

Close-out

1. Make sure that the session is in kloudlite sessions list.

Keep a session awake

Reason for the task: Prevent an idle stop while you work outside kloudlite and the session.

Job set-up

• Access: you.
• References: POST /v1/sessions/{id}/hold.

Procedure

1. Send a hold for the session, and repeat it at least every 60 seconds. The response is 204.

   PythonCopy

   sid = kl.sessions.get(session="dev")["id"]kl.request("POST", f"/v1/sessions/{sid}/hold")

   TypeScriptCopy

   const sid: string = ((await kl.sessions.get({ session: "dev" })) as any).id;await kl.request("POST", `/v1/sessions/${sid}/hold`);

   GoCopy

   s, err := kl.Sessions.Get("dev")if err != nil {    log.Fatal(err)}if err := kl.Request("POST", "/v1/sessions/"+s["id"].(string)+"/hold", kloudlite.RequestOptions{}); err != nil {    log.Fatal(err)}

   RubyCopy

   sid = kl.sessions.get(session: "dev")["id"]kl.request("POST", "/v1/sessions/#{sid}/hold")

   JavaCopy

   // The client returns raw JSON; read "id" with your JSON library.var s = kl.sessions().get("dev");int k = s.indexOf("\"id\":\"") + 6;kl.request("POST", "/v1/sessions/" + s.substring(k, s.indexOf('"', k)) + "/hold");

   CLICopy

   kloudlite request POST /v1/sessions/$(kloudlite sessions get dev --json | jq -r .id)/hold

Close-out

1. Make sure that the session's workspaces are not stopped.

Set the time to live

Reason for the task: End a session automatically after a period without use.

Job set-up

• Access: you.
• References: PUT /v1/sessions/{id}/ttl.

Procedure

1. Set ttl_secs from 600 to 2592000. Set it to no value (None, null, nil) to clear it.

   PythonCopy

   kl.sessions.set_ttl(session="dev", ttl_secs=86400)

   TypeScriptCopy

   await kl.sessions.setTtl({ session: "dev", ttlSecs: 86400 });

   GoCopy

   ttl := int64(86400)if _, err := kl.Sessions.SetTTL("dev", &ttl); err != nil {    log.Fatal(err)}

   RubyCopy

   kl.sessions.set_ttl(session: "dev", ttl_secs: 86400)

   JavaCopy

   kl.sessions().setTtl("dev", 86400L);

   CLICopy

   kloudlite sessions set-ttl dev --ttl-secs 86400

Close-out

1. Make sure that expires_at shows a time, or no value if you cleared it.

Stop a session

Reason for the task: Release the compute of a session and keep its data.

Job set-up

• Access: you.
• References: POST /v1/sessions/{id}/stop.

Procedure

1. Stop the session. Use team/name for a team session.

   PythonCopy

   kl.sessions.stop(session="dev")

   TypeScriptCopy

   await kl.sessions.stop({ session: "dev" });

   GoCopy

   if _, err := kl.Sessions.Stop("dev"); err != nil {    log.Fatal(err)}

   RubyCopy

   kl.sessions.stop(session: "dev")

   JavaCopy

   kl.sessions().stop("dev");

   CLICopy

   kloudlite sessions stop --session dev

Close-out

1. Make sure that the session and its workspaces show stopped.

End a session

Reason for the task: Remove a session that you no longer need.

Job set-up

• Access: you.
• References: DELETE /v1/sessions/{id}.

Procedure

1. Delete the session.

   PythonCopy

   kl.sessions.delete(session="dev")

   TypeScriptCopy

   await kl.sessions.delete({ session: "dev" });

   GoCopy

   if err := kl.Sessions.Delete("dev"); err != nil {    log.Fatal(err)}

   RubyCopy

   kl.sessions.delete(session: "dev")

   JavaCopy

   kl.sessions().delete("dev");

   CLICopy

   kloudlite sessions delete dev

Close-out

1. Make sure that the session is no longer in kloudlite sessions list.

List sessions

Reason for the task: Find the sessions that you can use.

Job set-up

• Access: you.
• References: GET /v1/sessions, kloudlite sessions list.

Procedure

1. Show the list. Pass a team to list the sessions of that team.

   PythonCopy

   print(kl.sessions.list())

   TypeScriptCopy

   console.log(await kl.sessions.list());

   GoCopy

   list, err := kl.Sessions.List("")if err != nil {    log.Fatal(err)}fmt.Println(list)

   RubyCopy

   p kl.sessions.list

   JavaCopy

   System.out.println(kl.sessions().list(null));

   CLICopy

   kloudlite sessions list

Close-out

1. Make sure that each session that you expect is listed.

Troubleshooting