Commit Graph

54 Commits

Author SHA1 Message Date
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