Skip to content

Commit faddebc

Browse files
committed
Updated docs
* removed benchmarking docs * updated the quickstart and dev guides, readme,and changelog Signed-off-by: Dmitrii Ustiugov <dmitrii.ustiugov@epfl.ch>
1 parent a0785fc commit faddebc

10 files changed

+111
-514
lines changed

CHANGELOG.md

+22-8
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,41 @@
44

55
### Added
66

7-
- Added Python tracing module and an [example](./function-images/tests/tracing/python/integ-tests/client-server/) showing its usage.
8-
- Added self-hosted stock-Knative runners on KinD, see [`scripts/self-hosted-kind`](./scripts/self-hosted-kind/).
9-
- Added Golang and Python storage modules.
7+
### Changed
8+
9+
### Fixed
10+
11+
12+
## v1.4
13+
14+
### Added
15+
16+
- Added support for [gVisor](https://gvisor.dev) MicroVMs, as an alternative to Firecracker.
17+
- Added [vSwarm](https://github.com/ease-lab/vSwarm), a suite of representative serverless workloads.
18+
Currently, in a beta testing mode.
19+
- Added Python and Go tracing modules and an example showing its usage.
20+
Moved to [vSwarm](https://github.com/ease-lab/vSwarm/tree/main/utils/tracing).
21+
- Added Golang and Python storage modules, supporting AWS S3 and AWS ElastiCache.
22+
Moved to [vSwarm](https://github.com/ease-lab/vSwarm/tree/main/utils/storage).
23+
- Added self-hosted stock-Knative runners on KinD,
24+
see [`scripts/self-hosted-kind`](./scripts/self-hosted-kind/).
1025

1126
### Changed
1227

13-
- Workload stdout/stderr is not directly redirected to vhive stdout/stderr anymore but is printed by vhive via `logrus.WithFields(logrus.Fields{"vmID": vmID})`.
28+
- Workload stdout/stderr is not directly redirected to vhive stdout/stderr anymore
29+
but is printed by vhive via `logrus.WithFields(logrus.Fields{"vmID": vmID})`.
1430
- Moved the CRI non-Firecracker tests to self-hosted stock-Knative runners.
1531

16-
### Fixed
17-
1832

1933
## v1.3
2034

2135
### Added
2236

2337
- Added 2 chained-functions microbenchmarks, synchronous and asynchronous, that use Knative Serving and Eventing, correspondingly.
2438
Tracing is fully supported for Serving function composition, partially supported for Eventing function composition.
25-
- Added [documentation](./docs/benchmarking/methodology.md) on vHive benchmarking methodology
39+
- Added documentation on vHive benchmarking methodology
2640
for arbitrary serverless deployments.
27-
- Added [documentation](./docs/benchmarking/adding_benchmarks.md) for adding benchmarks to vHive.
41+
- Added documentation for adding benchmarks to vHive.
2842
- Added Knative Eventing Tutorial: [documentation](./docs/knative/eventing.md) and [example](./examples/knative-eventing-tutorial).
2943
- Added a Go module for tracing using zipkin.
3044
- Improved CI troubleshooting: CRI test logs are now stored as GitHub artifacts.

README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ The details of the vHive architecture can be found in our ASPLOS'21 paper
3535
([extended abstract](https://asplos-conference.org/abstracts/asplos21-paper212-extended_abstract.pdf),
3636
[full paper](docs/papers/REAP_ASPLOS21.pdf)).
3737

38+
Currently, vHive supports 3 types of sandboxes for functions, namely
39+
[Firecracker MicroVMs](https://firecracker-microvm.github.io/) (default),
40+
[gVisor MicroVMs](https://gvisor.dev/),
41+
and Containerd containers (as in vanilla Knative).
42+
3843

3944
### Technical talks
4045

@@ -100,7 +105,9 @@ The statistics of this repository's views, clones, forks is available by the fol
100105
We would be happy to answer any questions in GitHub Issues and encourage the open-source community
101106
to submit new Issues, assist in addressing existing issues and limitations, and contribute their code with Pull Requests.
102107
Please check our guide on [Contributing to vHive](docs/contributing_to_vhive.md) if you would like contribute.
103-
You can also talk to us on the official [Firecracker Slack](https://join.slack.com/t/firecracker-microvm/shared_invite/zt-oxbm7tqt-GLlze9zZ7sdRSDY6OnXXHg) in the **#firecracker-vHive-research** channel.
108+
You can also talk to us on the official
109+
[Firecracker Slack](https://join.slack.com/t/firecracker-microvm/shared_invite/zt-oxbm7tqt-GLlze9zZ7sdRSDY6OnXXHg)
110+
in the **#firecracker-vHive-research** channel.
104111

105112

106113
## License and copyright
@@ -113,7 +120,8 @@ The software is maintained at the [EASE lab](https://easelab.inf.ed.ac.uk/) in t
113120

114121
### Maintainers
115122

116-
* Dmitrii Ustiugov: [GitHub](https://github.com/ustiugov),
117-
[twitter](https://twitter.com/DmitriiUstiugov), [web page](http://homepages.inf.ed.ac.uk/s1373190/)
118-
* [Plamen Petrov](https://github.com/plamenmpetrov)
119-
123+
* High-level architecture, issues and discussions on GitHub, roadmap: Dmitrii Ustiugov ([GitHub](https://github.com/ustiugov),
124+
[twitter](https://twitter.com/DmitriiUstiugov), [web page](http://homepages.inf.ed.ac.uk/s1373190/));
125+
* Integration with firecracker-containerd [Plamen Petrov](https://github.com/plamenmpetrov);
126+
* Integration with gVisor: [Nathaniel Tornow](https://github.com/nathanieltornow), [Alexandrina Panfil](https://github.com/alexandrinapanfil);
127+
* Integration with Knative: [Shyam Jesalpura](https://github.com/shyamjesal)

configs/.wordlist.txt

+20-11
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ Adileh
44
al
55
Alberquilla
66
Aldus
7+
Alexandrina
78
AMAC
89
amna
910
Amna
1011
Amna's
1112
amohoste
1213
analytics
1314
Analytics
14-
Ansible
1515
ansible
16+
Ansible
1617
antonis
1718
Antonis
1819
Apache
@@ -58,13 +59,13 @@ cd
5859
celsius
5960
Changelog
6061
Chunduri
61-
CloudEvent
6262
cloudevent
63+
CloudEvent
6364
CloudEvents
6465
cloudlab
6566
CloudLab
66-
CloudWatch
6767
cloudwatch
68+
CloudWatch
6869
CMP
6970
CMPMSI
7071
CNCF
@@ -100,8 +101,8 @@ Daglis
100101
datacenter
101102
Datacenter
102103
david
103-
DBG
104104
dbg
105+
DBG
105106
DCNs
106107
De
107108
debian
@@ -131,6 +132,7 @@ eba
131132
Edouard
132133
edu
133134
ef
135+
ElastiCache
134136
EndExperiment
135137
endpointsFile
136138
env
@@ -171,10 +173,12 @@ goroutine
171173
Gratz
172174
grot
173175
Grot
174-
gRPC
175176
grpc
177+
gRPC
176178
grpcServer
177179
grpcurl
180+
gvisor
181+
gVisor
178182
gz
179183
Harald
180184
HDDs
@@ -196,12 +200,12 @@ IISWC
196200
IIT
197201
imageFile
198202
imagePullPolicy
199-
In-Memory
200203
InfiniBand
201204
init
202205
InitBasicTracer
203206
InitCustomTracer
204207
Initializr
208+
In-Memory
205209
inproceedings
206210
insteadOf
207211
integ
@@ -215,6 +219,7 @@ ISPASS
215219
Istio
216220
istioctl
217221
jekyll
222+
Jesalpura
218223
Jevdjic
219224
Joshi
220225
jpg
@@ -326,6 +331,7 @@ orchestrator
326331
otelgrpc
327332
Ozer
328333
PageMaker
334+
Panfil
329335
params
330336
Passwordless
331337
pc
@@ -382,8 +388,8 @@ Ranganathan
382388
RDMA
383389
rdquo
384390
ReadTemp
385-
Rebase
386391
rebase
392+
Rebase
387393
rebasing
388394
repo
389395
Repos
@@ -412,14 +418,15 @@ SGD
412418
sha
413419
shahab
414420
Shahab
421+
Shyam
415422
siavash
416423
Siavash
417424
Siavash's
418425
Siddharth
419426
SIGARCH
420427
SIGPLAN
421-
SinkBinding
422428
sinkbinding
429+
SinkBinding
423430
SinkBindings
424431
sms
425432
SMT
@@ -467,8 +474,9 @@ TopDown
467474
toplev
468475
topologies
469476
Topologies
470-
traceId
477+
Tornow
471478
traceid
479+
traceId
472480
tscli
473481
tsim
474482
TSIM
@@ -495,10 +503,10 @@ utils
495503
UUID
496504
vhive
497505
vHive
498-
vHive's
499506
vhiveease
500-
vHiveMetadata
501507
vhivemetadata
508+
vHiveMetadata
509+
vHive's
502510
Vijay
503511
virtualized
504512
Vlachos
@@ -509,6 +517,7 @@ vmID
509517
vmIncrStep
510518
VMs
511519
Volos
520+
vSwarm
512521
warmUpTime
513522
wc
514523
WDDD

0 commit comments

Comments
 (0)