summaryrefslogtreecommitdiffhomepage
path: root/README.md
AgeCommit message (Collapse)Author
2020-05-18Fix typo a => an.Adin Scannell
Always happens. PiperOrigin-RevId: 312097591
2020-05-15Minor formatting updates for gvisor.dev.Adin Scannell
* 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
2019-12-06Build with C++17Michael Pratt
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-10-06Add SECURITY.md.Ian Lewis
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-09-11Update required Bazel version in README.Ian Lewis
PiperOrigin-RevId: 268397389
2019-06-13Update canonical repository.Adin Scannell
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-11Explicitly reference workspace root in test commandMichael Pratt
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-06Add the gVisor gitter badge to the READMEIan Lewis
Moves the build badge to just below the logo and adds the gitter badge next to it for consistency. PiperOrigin-RevId: 251956383
2019-05-03gvisor: run bazel in a docker containerAndrei Vagin
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-04-25Update required bazel version to 0.23.0 in READMEIan Lewis
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-23Add Linux version to requirements sectionFabricio Voznika
PiperOrigin-RevId: 244959388 Change-Id: Ifb08678d975cf9f694a21012f9a1e9f45b1f197c
2019-04-11README: add build badgeAdin Scannell
Change-Id: Ie6b73ac729c8c85b1229e09da5b113be9780fa95 PiperOrigin-RevId: 243131814
2019-04-09Update README.md to point to gvisor.devAdin Scannell
PiperOrigin-RevId: 242690968 Change-Id: I1ac2248b5ab3bcd95beed52ecddbb9f34eeb3775
2019-04-05Make it easier for humans to use RBE, and maintain our bazelrc.Nicolas Lacasse
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-03-21Address typos from github.Kevin Krakauer
https://github.com/google/gvisor/pull/132 PiperOrigin-RevId: 239641377 Change-Id: I7ba6b57730800cc98496c83cb643e70ec902ed3d
2019-01-11Update readme to say that 'kubectl cp' worksFabricio Voznika
PiperOrigin-RevId: 228904169 Change-Id: I948f417d1336cb69c5733b142c53850507432fda
2018-12-10Minor wording update to Kubernetes support section of the READMEIan Lewis
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-08Update K8s supportFabricio Voznika
Add pointers to Minikube and gvisor-containerd-shim. PiperOrigin-RevId: 224654334 Change-Id: Icefefbe531e901fe4807ba81904de8b01baf8a15
2018-11-20Add postgres to supported images listFabricio Voznika
PiperOrigin-RevId: 221706184 Change-Id: Ia186c51e5981e984f25c340e98b94225f860e473
2018-11-06Move bazelrc to new locationMichael Pratt
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-10-11Make debug log file name configurableFabricio Voznika
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-09-04runsc: Run sandbox as user nobody.Nicolas Lacasse
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-08-22Fix typoFabricio Voznika
PiperOrigin-RevId: 209788842 Change-Id: I70ecb58009777ce8f642f246bc161af1a0bf2628
2018-08-22Mark postgres as not supportedFabricio Voznika
See https://github.com/google/gvisor/issues/88 PiperOrigin-RevId: 209780532 Change-Id: Iff8004474020511503a0a5cd2cdba2b512c327ef
2018-08-14Readme: Fix typo in link.Nicolas Lacasse
PiperOrigin-RevId: 208674853 Change-Id: I6db4c59fdca1e5603a4d9dc021f3c3d7eaad7c6f
2018-08-10Move checkpoint/restore readme to g3doc directory.Nicolas Lacasse
PiperOrigin-RevId: 208282383 Change-Id: Ifa4aaf5d925b17d9a0672ea951a4570d35855300
2018-08-10Added a reference to the checkpoint/restore readme.Justine Olshan
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-07-12Format documentationMichael Pratt
PiperOrigin-RevId: 204323728 Change-Id: I1ff9aa062ffa12583b2e38ec94c87db7a3711971
2018-07-02Make default limits the same as with runcFabricio Voznika
Closes #2 PiperOrigin-RevId: 202997196 Change-Id: I0c9f6f5a8a1abe1ae427bca5f590bdf9f82a6675
2018-06-22Remove nginx failure note now that it worksMichael Pratt
Updates #1 PiperOrigin-RevId: 201760129 Change-Id: Ifd8ce9e0f93c6771083dc9bf8d35a2800c13481a
2018-06-18Add pointer to dated builds in READMEFabricio Voznika
PiperOrigin-RevId: 201068427 Change-Id: If03c8c22907e6ef623f39c8ae5316fdd76cf80cb
2018-06-02Add SHA512 pointer to READMEFabricio Voznika
PiperOrigin-RevId: 199008198 Change-Id: I6d1a0107ae1b11f160b42a2cabaf1fb8ce419edf
2018-05-17Move postgres to list of supported imagesFabricio Voznika
PiperOrigin-RevId: 197104043 Change-Id: I377c0727ebf0c44361ed221e1b197787825bfb7b
2018-05-11Update README to point to nightly builds.Nicolas Lacasse
The "install from source" section is moved under "advanced" header, right before the testing section. PiperOrigin-RevId: 196271666 Change-Id: I653ac0a2fa4661c96a0cb3daf3528c2109fed8d7
2018-05-09Small readme tweak.Nicolas Lacasse
Change-Id: Ibbb94cfd901d72d879657aca38bf3db1580f0d62 PiperOrigin-RevId: 196043734
2018-05-05Note architecture and Linux version requirementsMichael Pratt
PiperOrigin-RevId: 195522238 Change-Id: I0107f856bea72ea6af8b196c1c13bafbc293ce95
2018-05-03Add common docker error when version is wrongFabricio Voznika
Also updated gofer image with more accurate boundaries. PiperOrigin-RevId: 195373809 Change-Id: Id91f31fedf33db43a20bd678c1ca7d19287e85ff
2018-05-03Python 3.0 is now supported.Nicolas Lacasse
Also document that linux is required. Updates #8 PiperOrigin-RevId: 195317016 Change-Id: I4c0305a26339f03772001b56e7a0ac4b39a4352a
2018-05-03Readme: fix JSON formattingEric Chiang
PiperOrigin-RevId: 195310218 Change-Id: I1d5a6d2bc3bb72c505ad25427d285afbc26f59a0
2018-05-03Include Gold linker in requirements.Christopher Koch
Updates #26. PiperOrigin-RevId: 195303940 Change-Id: I833cee55b5df6196ed90c1f8987c3c9c07204678
2018-05-02Note that build requires Python 2.7Michael Pratt
Updates #8 PiperOrigin-RevId: 195122103 Change-Id: Iff190283961b8ab99ad4f3e47ffeb9ab491d0eb3
2018-05-02Fix links in README and CONTRIBUTING.Nicolas Lacasse
PiperOrigin-RevId: 195068006 Change-Id: I2d04a0c600b3850321f845fbdc0b6104dd178b3f
2018-05-01Note that the KVM platform is experimentalMichael Pratt
PiperOrigin-RevId: 195043285 Change-Id: Ie76112eff61062e1a54894b3707201fd284be377
2018-05-01Make images consistent.Adin Scannell
PiperOrigin-RevId: 194936276 Change-Id: I01f840f573c206e865de8e5e2dd4304dcb5e3621
2018-04-30Remove disclaimerZhengyu He
PiperOrigin-RevId: 194793271 Change-Id: I78517d5652ae38150e55a328a21cd276555f04f8
2018-04-28Restore markdown images that work universallyAdin Scannell
PiperOrigin-RevId: 194676199 Change-Id: Ibb9257a5504b10c4469a57ba27cd866f2d660fd8
2018-04-28Fix center alignmentFabricio Voznika
github markdown doesn't like {style} tags. Also moved the image after their respective section. PiperOrigin-RevId: 194663070 Change-Id: I7a7b97c1bc6f2b368837a3aa936f8bd3c00469fd
2018-04-28Update ImagesFabricio Voznika
PiperOrigin-RevId: 194661880 Change-Id: I2acdd63164de9a9652a00a70ee9a5d5cf5294a4d
2018-04-28Check in gVisor.Googler
PiperOrigin-RevId: 194583126 Change-Id: Ica1d8821a90f74e7e745962d71801c598c652463
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-29 09:00:50 +0000