Intercepts

Overview

An intercept sends all traffic of one environment service to a workspace of your desk. The code that you edit in the workspace answers real requests from the rest of the environment, with no build and no deploy. Callers do not change: they use the same name and port as before.

An intercept is for the whole environment, not only for your desk. Every caller of the service reaches your workspace, including the workspaces of other desks on the environment. This is what lets several developers test their changes against each other. See Ways to work.

Ports

By default each port of the service goes to the same port in the workspace. Give ports to map a service port to another workspace port, for example api:8080 to port 3000, where a development server listens. Callers still use port 8080.

Switch

Traffic moves only when the workspace can take it, so callers never reach a workspace that is not ready.

If the switch cannot be made, proxy is failed and the service keeps its traffic. An intercept is in force when the service in the environment's service_status shows interceptedBy.

Lifecycle

• Stays until removed. An intercept stays in the desk's intercepts until you remove it.
• Workspace stopped or not answering. If the workspace stops or does not answer for 30 seconds, traffic goes back to the service. The intercept is kept, and takes hold again when the workspace is back.
• Released with the desk. Deleting the workspace, changing the desk's environment, deleting the desk, or deleting the environment releases the intercept.
• Owned by one desk. Only the desk that holds an intercept can remove it. Another desk that asks for the same service is refused, with the name of the holder.

Limits

Tasks

Intercept a service

Reason for the task

Run a service from your workspace against the rest of the environment.

Job set-up

• Access: you.
• References: POST /v1/desks/{id}/intercepts.

Procedure

1. Create the intercept. Map ports with ports when the workspace listens on another port; this example sends 8080 to 3000.

   PythonCopy

   from kloudlite import Kodekl = Kloudlite()kl.desks.intercept(desk="dev", service="api", workspace="backend", ports={8080: 3000})

   TypeScriptCopy

   import { Kode } from "./index.ts";const kl = new Kloudlite();await kl.desks.intercept({ desk: "dev", service: "api", workspace: "backend", ports: { 8080: 3000 } });

   GoCopy

   kl := kloudlite.New(kloudlite.Options{})_, err := kl.Desks.Intercept(kloudlite.InterceptService{Desk: "dev", Service: "api", Workspace: "backend", Ports: map[int]int{8080: 3000}})if err != nil {    log.Fatal(err)}

   RubyCopy

   require_relative "kloudlite"kl = Kloudlite::Client.newkl.desks.intercept(desk: "dev", service: "api", workspace: "backend", ports: { 8080 => 3000 })

   JavaCopy

   var kl = new Kloudlite();kl.desks().intercept(new Kloudlite.InterceptService()    .desk("dev").service("api").workspace("backend").ports(Map.of(8080, 3000)));

   CLICopy

   kode desks intercept api --workspace backend --port 8080=3000 --desk dev

Close-out

1. Wait until the service in service_status shows interceptedBy and proxy is ready.

List the intercepts

Reason for the task

Check which services your desk routes to a workspace.

Job set-up

• Access: you.
• References: GET /v1/desks/{id}.

Procedure

1. Show the desk's intercepts.

   PythonCopy

   for i in kl.desks.get(desk="dev")["intercepts"]:    print(i["service"], i["workspace"], i["ports"])

   TypeScriptCopy

   const s: any = await kl.desks.get({ desk: "dev" });for (const i of s.intercepts) console.log(i.service, i.workspace, i.ports);

   GoCopy

   s, err := kl.Desks.Get("dev")if err != nil {    log.Fatal(err)}for _, v := range s["intercepts"].([]any) {    i := v.(map[string]any)    fmt.Println(i["service"], i["workspace"], i["ports"])}

   RubyCopy

   kl.desks.get(desk: "dev")["intercepts"].each { |i| puts "#{i['service']} #{i['workspace']} #{i['ports']}" }

   JavaCopy

   System.out.println(kl.desks().get("dev"));

   CLICopy

   kode desks get dev

Close-out

1. Make sure that every service that you intercepted is listed.

Remove an intercept

Reason for the task

Give a service its traffic back.

Job set-up

• Access: you.
• References: DELETE /v1/desks/{id}/intercepts/{service}.

Procedure

1. Remove the intercept.

   PythonCopy

   kl.desks.release(desk="dev", service="api")

   TypeScriptCopy

   await kl.desks.release({ desk: "dev", service: "api" });

   GoCopy

   if err := kl.Desks.Release(kloudlite.ReleaseService{Desk: "dev", Service: "api"}); err != nil {    log.Fatal(err)}

   RubyCopy

   kl.desks.release(desk: "dev", service: "api")

   JavaCopy

   kl.desks().release(new Kloudlite.ReleaseService().desk("dev").service("api"));

   CLICopy

   kode desks release api --desk dev

Close-out

1. List the intercepts as in task 002. Make sure that the service is gone.

Troubleshooting