Implement golang bootstrapper #5399

voievodin · 2017-06-19T08:23:41Z

Added golang app which implements bootstrapper spec(bootstrapper - agents workflow).

Usage

Usage of ./bootstrapper:
  -file string
        Path to configuration file on filesystem (default "/path/to/work/dir/config.json")
  -installer-timeout int
        Time(in seconds) given for one installer to complete its installation.
        If installation is not finished in time it will be interrupted (default 120)
  -machine-name string
        The name of the machine in which this bootstrapper is running
  -push-endpoint string
        WebSocket endpoint where to push statuses
  -push-logs-endpoint string
        WebSocket endpoint where to push logs
  -runtime-id string
        The identifier of the runtime in format 'workspace:environment:owner'
  -server-check-period int
        Time(in seconds) between servers availability checks.
        Once servers for one installer available - checks stopped

Example

For the configuration file

[
  {
    "id": "exec",
    "description": "Agent for command execution",
    "version": "1.0",
    "script": "printf \"1\n2\n3\n4\n5\n6\n7\n8\n9\n10\""
  },
  {
    "id": "agent",
    "description": "Agent",
    "version": "1.0",
    "script": "echo agent-007"
  },
  {
    "id": "agent-with-server",
    "description": "this is agent with server",
    "version": "1.0",
    "script": "set -e\ntdir\u003d$(mktemp -d)\ncd $tdir\nAGENT_TAR\u003dexec-agent-linux_amd64.tar.gz\nwget http://nightly.codenvy-stg.com/agent-binaries/linux_amd64/exec/${AGENT_TAR}\ntar -xzf ${AGENT_TAR}\n./exec-agent/che-exec-agent\n",
    "servers": {
      "exec": {
        "port": "9000/tcp",
        "protocol": "http"
      }
    }
  }
]

bootstrapper output will be

2017/06/19 11:17:00 Bootstrapper configuration
2017/06/19 11:17:00   Push endpoint: ws://localhost:2288/logging-server-connect
2017/06/19 11:17:00   Push logs endpoint: ws://localhost:2288/logging-server-connect
2017/06/19 11:17:00   Runtime ID:
2017/06/19 11:17:00     Workspace: workspace
2017/06/19 11:17:00     Environment: env
2017/06/19 11:17:00     Owner: owner
2017/06/19 11:17:00   Machine name: my-machine
2017/06/19 11:17:00   Installer timeout: 120seconds
2017/06/19 11:17:00   Check servers period: 3seconds
2017/06/19 11:17:00 Planning to install
2017/06/19 11:17:00 - exec:1.0 - Agent for command execution
2017/06/19 11:17:00 - agent:1.0 - Agent
2017/06/19 11:17:00 - agent-with-server:1.0 - this is agent with server
2017/06/19 11:17:00 Starting installations
2017/06/19 11:17:00 Installing 'exec'
2017/06/19 11:17:00 Installation of 'exec' successfully finished
2017/06/19 11:17:00 Installing 'agent'
2017/06/19 11:17:00 Installation of 'agent' successfully finished
2017/06/19 11:17:00 Installing 'agent-with-server'
2017/06/19 11:17:15 Installation of 'agent-with-server' successfully finished
2017/06/19 11:17:15 All installations successfully finished

During the installation corresponding events are emitted

Starting installations                                    <- bootstrapper/statusChanged { status : "STARTING" } 
Installing 'exec'                                         <- installer/statusChanged    { status : "STARTING" }
Installation of 'exec' successfully finished              <- installer/statusChanged    { status : "DONE" } 
Installing 'agent'                                        <- installer/statusChanged    { status : "STARTING" } 
Installation of 'agent' successfully finished             <- installer/statusChanged    { status : "DONE" } 
Installing 'agent-with-server'                            <- installer/statusChanged    { status : "STARTING" } 
Installation of 'agent-with-server' successfully finished <- installer/statusChanged    { status : "RUNNING" } 
All installations successfully finished                   <- bootstrapper/statusChanged { status : "DONE" }

What issues does this PR fix or reference?

resolves #4099
spec - #4096 (comment)
new installation approach - #3971

Please note that these changes are going to be merged into SPI branch.

skabashnyuk · 2017-06-19T11:07:53Z

agents/go-agents/bootstrapper/booter/installations.go

+		return fmt.Errorf("Port format is not supported %s", server.Port)
+	}
+	port := split[0]
+	addr := "localhost:" + port


Are you sure localhost is always available?

gazarenkov · 2017-06-19T11:50:18Z

Please specify what kind of events will be emitted during the sample bootstrapping
I think corresponding to this part of log:
2017/06/19 11:17:00 Starting installations
2017/06/19 11:17:00 Installing 'exec'
2017/06/19 11:17:00 Installation of 'exec' successfully finished
2017/06/19 11:17:00 Installing 'agent'
2017/06/19 11:17:00 Installation of 'agent' successfully finished
2017/06/19 11:17:00 Installing 'agent-with-server'
2017/06/19 11:17:15 Installation of 'agent-with-server' successfully finished
2017/06/19 11:17:15 All installations successfully finished

voievodin · 2017-06-19T12:12:25Z

ok

garagatyi · 2017-06-19T14:14:48Z

agents/bootstrapper/pom.xml

+        <version>5.13.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>bootstrapper</artifactId>
+    <name>Bootstrapper</name>


Could you add more info into the artifact and name fields? E.g. agent-bootstrapper, Agent :: Bootstrapper

garagatyi · 2017-06-19T14:40:53Z

agents/go-agents/bootstrapper/booter/booter.go

+// AddAll adds batch of installers to the installation sequence.
+func AddAll(installers []Installer) {
+	for _, installer := range installers {
+		Add(installer)


Consider append(installers, newInstallers...) instead

makes sense

garagatyi · 2017-06-19T14:43:02Z

agents/go-agents/bootstrapper/booter/booter.go

+// If there is no installer which provides server, this func exits after
+// all the installation are completed.
+// In both cases if any error occurs during installation,
+// start exists returning that error.


I suppose exits instead of exists

codenvy-ci · 2017-06-19T16:54:54Z

Build success. https://ci.codenvycorp.com/job/che-pullrequests-build/2847/

codenvy-ci · 2017-06-19T20:46:00Z

Build success. https://ci.codenvycorp.com/job/che-pullrequests-build/2852/

garagatyi · 2017-06-20T09:06:08Z

agents/go-agents/bootstrapper/booter/installations.go

+func (svi *serverInst) preCheck() error {
+	for _, server := range svi.installer.Servers {
+		if tryConn(server) == nil {
+			return fmt.Errorf("server address 'localhost:%s' already in use", server.Port)


I suppose that already running server is not a problem for an agent start. For example, ubuntu_jdk8 image start SSHD as the main command of the container. So with this check SSH agent will fail on that image.

garagatyi · 2017-06-20T09:14:19Z

agents/go-agents/bootstrapper/booter/installations.go

+		return fmt.Errorf("Timeout reached before installation of '%s' finished", svi.installer.ID)
+	case <-diedC:
+		checker.stop()
+		return fmt.Errorf("Process of installation '%s' exited before server became available", svi.installer.ID)


I suppose in case SSHD is already running, installation script exits immediately, so this error will occur even if the server is available. WDYT?

I thought that execution of scripts which install servers must not exit, but it turns out that
exitCode == 0 + servers availability should be considered as successful installation.
I will rework it, thank you!

voievodin · 2017-06-20T09:45:05Z

@garagatyi fixed, please review changes

garagatyi

Looks good. Good job!

codenvy-ci · 2017-06-20T12:40:10Z

Build success. https://ci.codenvycorp.com/job/che-pullrequests-build/2861/

voievodin assigned voievodin and akorneta Jun 19, 2017

voievodin requested review from skabashnyuk and garagatyi June 19, 2017 08:23

skabashnyuk reviewed Jun 19, 2017

View reviewed changes

gazarenkov added the target/branch Indicates that a PR will be merged into a branch other than master. label Jun 19, 2017

gazarenkov requested review from gazarenkov and skabashnyuk June 19, 2017 11:50

garagatyi reviewed Jun 19, 2017

View reviewed changes

gazarenkov approved these changes Jun 19, 2017

View reviewed changes

skabashnyuk approved these changes Jun 20, 2017

View reviewed changes

Yevhenii Voievodin added 4 commits June 20, 2017 11:49

Add event-bus-consumer components to core/event.

94a4c44

Do not include null id to jsonrpc requests

3b3ca25

Do not panic on request/notify if tunnel is closed

b4afabf

Add ability to use func as process EventConsumer

f11e881

voievodin force-pushed the bootstrapper branch from 45f1dc9 to c2869d2 Compare June 20, 2017 08:49

garagatyi suggested changes Jun 20, 2017

View reviewed changes

garagatyi reviewed Jun 20, 2017

View reviewed changes

Yevhenii Voievodin added 2 commits June 20, 2017 14:13

Implement bootstrapper spec(#4096)

a3978d3

Wait jsonrpc main write loop to finish

0634460

garagatyi approved these changes Jun 20, 2017

View reviewed changes

voievodin force-pushed the bootstrapper branch from c98b321 to 0634460 Compare June 20, 2017 11:14

voievodin merged commit 7a0c1de into spi Jun 20, 2017

voievodin deleted the bootstrapper branch June 20, 2017 12:54

skabashnyuk mentioned this pull request Jun 20, 2017

Rework docker runtime infrastructure to use bootstrapper events during workspace start #4101

Closed

skabashnyuk mentioned this pull request Oct 15, 2017

Che6.0 #6698

Merged

skabashnyuk added this to the 6.0.0-M1 milestone Oct 19, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement golang bootstrapper #5399

Implement golang bootstrapper #5399

voievodin commented Jun 19, 2017 •

edited

Loading

skabashnyuk Jun 19, 2017

gazarenkov commented Jun 19, 2017

voievodin commented Jun 19, 2017

garagatyi Jun 19, 2017

garagatyi Jun 19, 2017

voievodin Jun 19, 2017

garagatyi Jun 19, 2017

voievodin Jun 19, 2017

codenvy-ci commented Jun 19, 2017

codenvy-ci commented Jun 19, 2017

garagatyi Jun 20, 2017

garagatyi Jun 20, 2017

voievodin Jun 20, 2017

voievodin commented Jun 20, 2017

garagatyi left a comment

codenvy-ci commented Jun 20, 2017

Implement golang bootstrapper #5399

Implement golang bootstrapper #5399

Conversation

voievodin commented Jun 19, 2017 • edited Loading

Usage

Example

What issues does this PR fix or reference?

Choose a reason for hiding this comment

gazarenkov commented Jun 19, 2017

voievodin commented Jun 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codenvy-ci commented Jun 19, 2017

codenvy-ci commented Jun 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

voievodin commented Jun 20, 2017

garagatyi left a comment

Choose a reason for hiding this comment

codenvy-ci commented Jun 20, 2017

voievodin commented Jun 19, 2017 •

edited

Loading