open-lambda.github.io/_build/html/worker.html at master · open-lambda/open-lambda.github.io

History

529 lines (380 loc) · 19.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

<!DOCTYPE html>

<head>

<title>Worker — OpenLambda</title>

document.documentElement.dataset.mode = localStorage.getItem("mode") || "";

document.documentElement.dataset.theme = localStorage.getItem("theme") || "";

</script>

</head>

<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

<input type="checkbox"

class="sidebar-toggle"

id="pst-primary-sidebar-checkbox"/>

<input type="checkbox"

class="sidebar-toggle"

id="pst-secondary-sidebar-checkbox"/>

<form class="bd-search d-flex align-items-center"

action="search.html"

method="get">

<input type="search"

class="form-control"

name="q"

id="search-input"

placeholder="Search..."

aria-label="Search..."

autocomplete="off"

autocorrect="off"

autocapitalize="off"

spellcheck="false"/>

</form></div>

</div>

</div>

</header>

</div>

<p class="title logo__title">OpenLambda</p>

</a></div>

document.write(`

<span class="search-button__default-text">Search</span>

</button>

`);

</script></div>

<li class="toctree-l1 current active"><a class="current reference internal" href="#">Worker</a></li>

</ul>

</div>

</nav></div>

</div>

</div>

</div>

</button></div>

</div>

</button>

<li><a href="https://github.com/open-lambda/open-lambda.github.io" target="_blank"

class="btn btn-sm btn-source-repository-button dropdown-item"

title="Source repository"

data-bs-placement="left" data-bs-toggle="tooltip"

</span>

<span class="btn__text-container">Repository</span>

</a>

</li>

<li><a href="https://github.com/open-lambda/open-lambda.github.io/issues/new?title=Issue%20on%20page%20%2Fworker.html&body=Your%20issue%20content%20here." target="_blank"

class="btn btn-sm btn-source-issues-button dropdown-item"

title="Open an issue"

data-bs-placement="left" data-bs-toggle="tooltip"

</span>

<span class="btn__text-container">Open issue</span>

</a>

</li>

</ul>

</div>

<button onclick="toggleFullScreen()"

class="btn btn-sm btn-fullscreen-button"

title="Fullscreen mode"

data-bs-placement="bottom" data-bs-toggle="tooltip"

</span>

</button>

document.write(`

</button>

`);

</script>

document.write(`

</button>

`);

</script>

</button>

</div></div>

</div>

<h1>Worker</h1>

<div>

<h2> Contents </h2>

</div>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#overview">Overview</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#configuration">Configuration</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#starting-the-worker">Starting the Worker</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#deploying-multiple-workers">Deploying Multiple Workers</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#further-reading">Further Reading</a></li>

</ul>

</nav>

</div>

<h1>Worker<a class="headerlink" href="#worker" title="Link to this heading">#</a></h1>

<p>The OpenLambda <strong>worker</strong> is the core server-side component of a node. It listens for

incoming HTTP requests, manages container lifecycle, and returns responses to callers.</p>

<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">#</a></h2>

<p>Each worker is a standalone Go binary that exposes a single HTTP endpoint:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">POST</span> <span class="o">/</span><span class="n">runLambda</span><span class="o">/<</span><span class="k">lambda</span><span class="o">-</span><span class="n">name</span><span class="o">></span>

</pre></div>

</div>

<p>When a request arrives the worker:</p>

<li><p>Checks whether the lambda’s container image is already present on the node; if not, pulls it from the registry.</p></li>

<li><p>Starts a Linux container from the image.</p></li>

<li><p>Passes the request payload to the lambda function running inside the container.</p></li>

<li><p>Waits for the function to return a result, then forwards that result back to the caller.</p></li>

<li><p>Optionally keeps the container warm for a short period to reduce cold-start latency on subsequent calls.</p></li>

</ol>

</section>

<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">#</a></h2>

<p>The worker is configured via a JSON file (default <code class="docutils literal notranslate"><span class="pre">config.json</span></code>) in the working directory.

Key fields:</p>

<thead>

<tr class="row-odd"><th class="head"><p>Field</p></th>

<th class="head"><p>Description</p></th>

<th class="head"><p>Default</p></th>

</tr>

</thead>

<tbody>

<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">worker_port</span></code></p></td>

<td><p>Port the HTTP server listens on</p></td>

</tr>

<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">registry</span></code></p></td>

<td><p>URL of the lambda registry</p></td>

</tr>

<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">sandbox</span></code></p></td>

<td><p>Container backend (<code class="docutils literal notranslate"><span class="pre">docker</span></code> or <code class="docutils literal notranslate"><span class="pre">sock</span></code>)</p></td>

<td><p><code class="docutils literal notranslate"><span class="pre">docker</span></code></p></td>

</tr>

<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">log_output</span></code></p></td>

<td><p>Where to write logs (<code class="docutils literal notranslate"><span class="pre">stdout</span></code> or a file path)</p></td>

<td><p><code class="docutils literal notranslate"><span class="pre">stdout</span></code></p></td>

</tr>

</tbody>

</table>

</div>

</section>

<h2>Starting the Worker<a class="headerlink" href="#starting-the-worker" title="Link to this heading">#</a></h2>

<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># From the repo root after building:</span>

./bin/worker<span class="w"> </span>--config<span class="w"> </span>config.json

</pre></div>

</div>

<p>The worker prints its listening address on startup. You can verify it is running with:</p>

<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-w<span class="w"> </span><span class="s2">"\n"</span><span class="w"> </span>localhost:8080/status

</pre></div>

</div>

</section>

<h2>Deploying Multiple Workers<a class="headerlink" href="#deploying-multiple-workers" title="Link to this heading">#</a></h2>

<p>Workers are stateless with respect to routing — each one operates independently. To scale

horizontally, start one worker process per node and place a standard HTTP load balancer

(Nginx, HAProxy, or similar) in front of them. No coordination between workers is required.</p>

<p>A centralized <strong>boss</strong> component for cluster-wide management is currently under development.

Until then, manual deployment behind a load balancer is the recommended approach for

multi-node setups.</p>

</div>

</section>

<h2>Further Reading<a class="headerlink" href="#further-reading" title="Link to this heading">#</a></h2>

<li><p><a class="reference internal" href="#doc.htm"><span class="xref myst">Quickstart guide</span></a> — get a single worker running locally in minutes</p></li>

<li><p><a class="reference external" href="https://www.usenix.org/conference/atc18/presentation/oakes">SOCK: Rapid Task Provisioning with Serverless-Optimized Containers</a> — the research paper describing the container backend.</p></li>

</ul>

</section>

{

requestKernel: true,

binderOptions: {

repo: "binder-examples/jupyter-stacks-datascience",

ref: "master",

codeMirrorConfig: {

theme: "abcdef",

mode: "python"

kernelOptions: {

name: "python3",

path: "./."

predefinedOutput: true

}

</script>

</article>

<a class="left-prev"

href="index.html"

title="previous page">

<p class="prev-next-subtitle">previous</p>

<p class="prev-next-title">OpenLambda</p>

</div>

</a>

</div>

</footer>

</div>

<i class="fa-solid fa-list"></i> Contents

</div>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#overview">Overview</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#configuration">Configuration</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#starting-the-worker">Starting the Worker</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#deploying-multiple-workers">Deploying Multiple Workers</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#further-reading">Further Reading</a></li>

</ul>

</nav></div>

</div></div>

</div>

By OpenLambda Contributors

</p>

</div>

<br/>

</p>

</div>

</div>

</div>

</footer>

</main>

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

worker.html

Latest commit

History

worker.html

File metadata and controls