Commit Graph

58 Commits

Author SHA1 Message Date
Fabricio Voznika 8b0f0b4d11 Delete shim v1
gvisor-containerd-shim is not compatible with containerd 1.1 or earlier.
Starting from containerd 1.2, shim v2 is the preferred interface.

PiperOrigin-RevId: 351485556
2021-01-12 17:54:10 -08:00
Adin Scannell 33d59811fc Change the build badge to point to BuildKite.
PiperOrigin-RevId: 350197814
2021-01-05 12:40:22 -08:00
Ian Lewis 3bee863aee Add code search badge
PiperOrigin-RevId: 329042549
2020-08-28 18:09:13 -07:00
Adin Scannell 10f6c41bbd Include shim binaries in the Go branch.
PiperOrigin-RevId: 324615016
2020-08-03 09:09:51 -07:00
Adin Scannell 00ee5abaa7 Drop unused markdown links.
PiperOrigin-RevId: 318284693
2020-06-25 09:18:30 -07:00
Ian Lewis 51c61cb2dc Add back gitter badge.
PiperOrigin-RevId: 314630516
2020-06-05 11:26:50 -07:00
Joshua Abraham a01078de32 README: fix link to GOVERNANCE document 2020-05-23 15:33:27 -04:00
Geethanjali Eswaran fff2232b5f Typo fix in README
'make test TARGETS=""'
TARGET => TARGETS
2020-05-19 08:51:54 +05:30
Adin Scannell f2f2dec728 Add simplified badge and Build workflow.
PiperOrigin-RevId: 312159017
2020-05-18 14:53:23 -07:00
Adin Scannell c27e334f26 Fix typo a => an.
Always happens.

PiperOrigin-RevId: 312097591
2020-05-18 09:49:58 -07:00
Adin Scannell 420b791a3d Minor formatting updates for gvisor.dev.
* Aggregate architecture Overview in "What is gVisor?" as it makes more sense
  in one place.

* Drop "user-space kernel" and use "application kernel". The term "user-space
  kernel" is confusing when some platform implementation do not run in
  user-space (instead running in guest ring zero).

* Clear up the relationship between the Platform page in the user guide and the
  Platform page in the architecture guide, and ensure they are cross-linked.

* Restore the call-to-action quick start link in the main page, and drop the
  GitHub link (which also appears in the top-right).

* Improve image formatting by centering all doc and blog images, and move the
  image captions to the alt text.

PiperOrigin-RevId: 311845158
2020-05-15 20:05:18 -07:00
Michael Pratt 7b81633ff8 Build with C++17
This will require a reasonably modern toolchain. I've put minimum compiler
versions in the README based on versions in
https://en.cppreference.com/w/cpp/compiler_support that have mostly complete
language and library support.

The minimum Bazel version bump is unrelated, but 0.28 is definitely not
supported anymore.

Please report issues on gvisor.dev/issue/1349.

Fixes #1349

PiperOrigin-RevId: 284274250
2019-12-06 15:26:47 -08:00
Ian Lewis 5ac2cc5491 Add SECURITY.md.
Adds minimal security policy info to SECURITY.md. This allows Github to
advertise the security policy doc for the repo.

See: https://github.blog/changelog/2019-05-23-security-policy/
See: https://help.github.com/en/articles/adding-a-security-policy-to-your-repository
PiperOrigin-RevId: 273214306
2019-10-06 21:08:11 -07:00
Ian Lewis d24be656c9 Update required Bazel version in README.
PiperOrigin-RevId: 268397389
2019-09-11 00:09:59 -07:00
Adin Scannell add40fd6ad Update canonical repository.
This can be merged after:
https://github.com/google/gvisor-website/pull/77
  or
https://github.com/google/gvisor-website/pull/78

PiperOrigin-RevId: 253132620
2019-06-13 16:50:15 -07:00
Michael Pratt 478a0873e1 Explicitly reference workspace root in test command
oh-my-zsh aliases ... to ../.. [1]. Add an explicit reference
to workspace root to work around the alias.

[1] https://github.com/robbyrussell/oh-my-zsh/blob/master/lib/directories.zsh

Fixes #341

PiperOrigin-RevId: 252720590
2019-06-11 16:15:39 -07:00
Ian Lewis 6a4c006564 Add the gVisor gitter badge to the README
Moves the build badge to just below the logo and adds the gitter badge next to
it for consistency.

PiperOrigin-RevId: 251956383
2019-06-06 16:58:29 -07:00
Andrei Vagin 9e1c253fe8 gvisor: run bazel in a docker container
bazel has a lot of dependencies and users don't want to install them
just to build gvisor.

These changes allows to run bazel in a docker container.
A bazel cache is on the local file system (~/.cache/bazel), so
incremental builds should be fast event after recreating a bazel
container.

Here is an example how to build runsc:
make BAZEL_OPTIONS="build runsc:runsc" bazel

Change-Id: I8c0a6d0c30e835892377fb6dd5f4af7a0052d12a
PiperOrigin-RevId: 246570877
2019-05-03 14:13:08 -07:00
Ian Lewis 03be9ae88c Update required bazel version to 0.23.0 in README
Bazel 0.23.0 is required due to the use of cc_flags_supplier.bzl in the vdso
package. cc_flags_supplier.bzl was added in 0.23.0.

PiperOrigin-RevId: 245192715
Change-Id: I4258c064e5cc3bac2a587c887e0d8f87b6678ec7
2019-04-25 01:16:33 -07:00
Fabricio Voznika 7c9c5fd36d Add Linux version to requirements section
PiperOrigin-RevId: 244959388
Change-Id: Ifb08678d975cf9f694a21012f9a1e9f45b1f197c
2019-04-23 17:46:44 -07:00
Adin Scannell fab6352ac8 README: add build badge
Change-Id: Ie6b73ac729c8c85b1229e09da5b113be9780fa95
PiperOrigin-RevId: 243131814
2019-04-11 13:36:53 -07:00
Adin Scannell f18a8f9581 Update README.md to point to gvisor.dev
PiperOrigin-RevId: 242690968
Change-Id: I1ac2248b5ab3bcd95beed52ecddbb9f34eeb3775
2019-04-09 10:20:21 -07:00
Nicolas Lacasse f44f2f73b0 Make it easier for humans to use RBE, and maintain our bazelrc.
This CL merges all RBE-specific configuration from .bazelrc_rbe into .bazelrc
so that it will be picked up by default by users running bazel.

It also checks in a bazelrc from the upstream bazel-toolchains repository, and
imports that into our repo-specific .bazelrc. This makes it easier to maintain
and update the bazelrc going forward.

Documentation was added to the README.

PiperOrigin-RevId: 242208733
Change-Id: Iea32de9be85b024bd74f88909b56b2a8ab34851a
2019-04-05 15:48:32 -07:00
Kevin Krakauer ba937d74f9 Address typos from github.
https://github.com/google/gvisor/pull/132

PiperOrigin-RevId: 239641377
Change-Id: I7ba6b57730800cc98496c83cb643e70ec902ed3d
2019-03-21 11:54:10 -07:00
Fabricio Voznika 864eac4a5b Update readme to say that 'kubectl cp' works
PiperOrigin-RevId: 228904169
Change-Id: I948f417d1336cb69c5733b142c53850507432fda
2019-01-11 10:33:31 -08:00
Ian Lewis 93ac04a6c3 Minor wording update to Kubernetes support section of the README
Updated the README to correct some wording and clarify a bit that containerd
CRI runtime is needed.

PiperOrigin-RevId: 224944753
Change-Id: I7b9c527500f99571aca7ef73058472ae9b3d5371
2018-12-10 22:57:14 -08:00
Fabricio Voznika b89f9909d7 Update K8s support
Add pointers to Minikube and gvisor-containerd-shim.

PiperOrigin-RevId: 224654334
Change-Id: Icefefbe531e901fe4807ba81904de8b01baf8a15
2018-12-08 09:21:48 -08:00
Fabricio Voznika 45f4b90d4f Add postgres to supported images list
PiperOrigin-RevId: 221706184
Change-Id: Ia186c51e5981e984f25c340e98b94225f860e473
2018-11-20 14:01:36 -08:00
Michael Pratt 6ae1c90b89 Move bazelrc to new location
Bazel 0.18 moved the workspace bazelrc location from //tools/bazel.rc to
//.bazelrc. The old location will be dropped by a future version of
bazel.

This bumps the minimum required version of bazel to 0.18.

More context:
https://groups.google.com/forum/#!msg/bazel-discuss/ycDacctX2vw/EGFxGLibAgAJ

PiperOrigin-RevId: 220338084
Change-Id: Ib6fa83a4a0f89e8e898d67152c7bd429e0b9b21e
2018-11-06 13:12:50 -08:00
Fabricio Voznika e68d86e1bd Make debug log file name configurable
This is a breaking change if you're using --debug-log-dir.
The fix is to replace it with --debug-log and add a '/' at
the end:
  --debug-log-dir=/tmp/runsc ==> --debug-log=/tmp/runsc/

PiperOrigin-RevId: 216761212
Change-Id: I244270a0a522298c48115719fa08dad55e34ade1
2018-10-11 14:29:37 -07:00
Nicolas Lacasse 0a9a40abcd runsc: Run sandbox as user nobody.
When starting a sandbox without direct file or network access, we create an
empty user namespace and run the sandbox in there.  However, the root user in
that namespace is still mapped to the root user in the parent namespace.

This CL maps the "nobody" user from the parent namespace into the child
namespace, and runs the sandbox process as user "nobody" inside the new
namespace.

PiperOrigin-RevId: 211572223
Change-Id: I1b1f9b1a86c0b4e7e5ca7bc93be7d4887678bab6
2018-09-04 20:33:05 -07:00
Fabricio Voznika 23ca133657 Fix typo
PiperOrigin-RevId: 209788842
Change-Id: I70ecb58009777ce8f642f246bc161af1a0bf2628
2018-08-22 10:35:40 -07:00
Fabricio Voznika 3c5ec25f1c Mark postgres as not supported
See https://github.com/google/gvisor/issues/88

PiperOrigin-RevId: 209780532
Change-Id: Iff8004474020511503a0a5cd2cdba2b512c327ef
2018-08-22 09:48:26 -07:00
Nicolas Lacasse 49031378d3 Readme: Fix typo in link.
PiperOrigin-RevId: 208674853
Change-Id: I6db4c59fdca1e5603a4d9dc021f3c3d7eaad7c6f
2018-08-14 10:56:17 -07:00
Nicolas Lacasse 36c940b093 Move checkpoint/restore readme to g3doc directory.
PiperOrigin-RevId: 208282383
Change-Id: Ifa4aaf5d925b17d9a0672ea951a4570d35855300
2018-08-10 15:57:49 -07:00
Justine Olshan 3c60a192ca Added a reference to the checkpoint/restore readme.
In the main readme, checkpoint and restore is listed as an
advanced feature, and a link to its readme is provided.

PiperOrigin-RevId: 208279833
Change-Id: Ib3db28a8df8ec93cf8d98d5dfd2ee2f75a61e664
2018-08-10 15:40:16 -07:00
Michael Pratt 41e0b977e5 Format documentation
PiperOrigin-RevId: 204323728
Change-Id: I1ff9aa062ffa12583b2e38ec94c87db7a3711971
2018-07-12 10:37:21 -07:00
Fabricio Voznika fa64c2a151 Make default limits the same as with runc
Closes #2

PiperOrigin-RevId: 202997196
Change-Id: I0c9f6f5a8a1abe1ae427bca5f590bdf9f82a6675
2018-07-02 12:51:38 -07:00
Michael Pratt 9c0c4fd8d0 Remove nginx failure note now that it works
Updates #1

PiperOrigin-RevId: 201760129
Change-Id: Ifd8ce9e0f93c6771083dc9bf8d35a2800c13481a
2018-06-22 16:37:36 -07:00
Fabricio Voznika 7eaca1074b Add pointer to dated builds in README
PiperOrigin-RevId: 201068427
Change-Id: If03c8c22907e6ef623f39c8ae5316fdd76cf80cb
2018-06-18 15:18:43 -07:00
Fabricio Voznika 43dd424f42 Add SHA512 pointer to README
PiperOrigin-RevId: 199008198
Change-Id: I6d1a0107ae1b11f160b42a2cabaf1fb8ce419edf
2018-06-02 15:22:21 -07:00
Fabricio Voznika a1e5862f3c Move postgres to list of supported images
PiperOrigin-RevId: 197104043
Change-Id: I377c0727ebf0c44361ed221e1b197787825bfb7b
2018-05-17 23:22:40 -07:00
Nicolas Lacasse f24db99498 Update README to point to nightly builds.
The "install from source" section is moved under "advanced" header, right
before the testing section.

PiperOrigin-RevId: 196271666
Change-Id: I653ac0a2fa4661c96a0cb3daf3528c2109fed8d7
2018-05-11 10:23:41 -07:00
Nicolas Lacasse b3bfb24991 Small readme tweak.
Change-Id: Ibbb94cfd901d72d879657aca38bf3db1580f0d62
PiperOrigin-RevId: 196043734
2018-05-09 16:01:24 -07:00
Michael Pratt ebae219162 Note architecture and Linux version requirements
PiperOrigin-RevId: 195522238
Change-Id: I0107f856bea72ea6af8b196c1c13bafbc293ce95
2018-05-05 00:27:40 -07:00
Fabricio Voznika 3ea6805e54 Add common docker error when version is wrong
Also updated gofer image with more accurate boundaries.

PiperOrigin-RevId: 195373809
Change-Id: Id91f31fedf33db43a20bd678c1ca7d19287e85ff
2018-05-03 23:27:22 -07:00
Nicolas Lacasse 6488f40aa3 Python 3.0 is now supported.
Also document that linux is required.

Updates #8

PiperOrigin-RevId: 195317016
Change-Id: I4c0305a26339f03772001b56e7a0ac4b39a4352a
2018-05-03 15:04:46 -07:00
Eric Chiang 1a59625a66 Readme: fix JSON formatting
PiperOrigin-RevId: 195310218
Change-Id: I1d5a6d2bc3bb72c505ad25427d285afbc26f59a0
2018-05-03 14:21:04 -07:00
Christopher Koch 18ebda3476 Include Gold linker in requirements.
Updates #26.

PiperOrigin-RevId: 195303940
Change-Id: I833cee55b5df6196ed90c1f8987c3c9c07204678
2018-05-03 13:44:05 -07:00
Michael Pratt 6c061ad913 Note that build requires Python 2.7
Updates #8

PiperOrigin-RevId: 195122103
Change-Id: Iff190283961b8ab99ad4f3e47ffeb9ab491d0eb3
2018-05-02 11:21:26 -07:00