Review and define agent bootstrapper events

[voievodin]

Agent installation spec defines agent bootstrapper events(see Agent lifecycle events).
According to new generation SPI, defined events - do not provide enough information. For example each agent event should provide machine identifier as well as its own identifier, it can be either structured id like

"workspaceId" : "workspace123",
"environment" : "main",
"machine" : "dev"

or it can be a path like

"machine" : "workpsace123/main/dev"

or it can be a machine id

"machine" : "machine123"

Another point is that the format of events names should fit the concept of workspace master events.

The DOD of the issue is to provide a list of jsonrpc2.0 events needed to be produced by bootstrapper,
which allows to develop java client & installer separately.

[voievodin]

I reviewed bootstrapper events, after they approved here i will change the spec.

Bootstrapper events

• Bootstrapper is ready to push events. Occurs when bootstrapper is configured to push events on start, it connects to the specified websocket url(workspace master probably) and publishes this event before any other event.

{
  "jsonrpc": "2.0",
  "method": "bootstrapper/statusChanged",
  "params": {
    "status": "READY",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

• Bootstrapping done, everything is started ok.

{
  "jsonrpc": "2.0",
  "method": "bootstrapper/statusChanged",
  "params": {
    "status": "DONE",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

• Bootstrapping failed(when any agent fails or any error occurs), followed by disconnect and os.Exit(1).

{
  "jsonrpc": "2.0",
  "method": "bootstrapper/statusChanged",
  "params": {
    "status": "FAILED",
    "error" : "couldn't start agent X",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

Agents events

• Bootstrapper starts agent X

{
  "jsonrpc": "2.0",
  "method": "installer/statusChanged",
  "params": {
    "status": "STARTING",
    "installer": "org.eclipse.che.ws-agent",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

• Bootstrapper successfully started agent X(No server defined)

{
  "jsonrpc": "2.0",
  "method": "installer/statusChanged",
  "params": {
    "status": "DONE",
    "installer": "org.eclipse.che.ws-agent",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

• Bootstrapper successfully started agent X(Server defined)

{
  "jsonrpc": "2.0",
  "method": "installer/statusChanged",
  "params": {
    "status": "RUNNING",
    "installer": "org.eclipse.che.ws-agent",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

• Bootstrapper failed to start agent X

{
  "jsonrpc": "2.0",
  "method": "installer/statusChanged",
  "params": {
    "status": "FAILED",
    "installer": "org.eclipse.che.my-agent",
    "error": "Install script exit code -1",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

• Agent X stderr

{
  "jsonrpc": "2.0",
  "method": "installer/log",
  "params": {
    "text": "no command found",
    "stream": "STDERR",
    "installer": "org.eclipse.che.ws-agent",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

• Agent X stdout

{
  "jsonrpc": "2.0",
  "method": "installer/log",
  "params": {
    "text": "Starting server...",
    "stream": "STDOUT",
    "installer": "org.eclipse.che.ws-agent",
    "machineName": "my-machine",
    "runtimeId": {
      "workspace": "workspace123",
      "environment": "default",
      "owner": "user123"
    },
    "time": "2017-02-23T16:22:22.50287146+02:00"
  }
}

[voievodin]

@gazarenkov, @garagatyi, @dkuleshov, @mshaposhnik WDYT?

[mshaposhnik]

LGTM

[voievodin]

Added events to the spec