mirror of
https://github.com/netbirdio/gvisor.git
synced 2026-05-22 17:12:49 -07:00
Move website to a simpler jekyll-based template
This will allow us to merge the site into the main repository. This merge allows the documentation to be kept up-to-date and synchronized with the main project. Builds will be triggered on any update, removing the need for the cron-based reploy.
This commit is contained in:
Adin Scannell
@@ -1,5 +0,0 @@
|
||||
bin/
|
||||
public/
|
||||
resources/
|
||||
node_modules/
|
||||
upstream/
|
||||
@@ -1 +0,0 @@
|
||||
themes/docsy/* linguist-vendored
|
||||
@@ -1,6 +0,0 @@
|
||||
bin/
|
||||
bazel_user_root/
|
||||
public/
|
||||
resources/
|
||||
node_modules/
|
||||
upstream/
|
||||
@@ -1 +0,0 @@
|
||||
* @google/gvisor
|
||||
@@ -1,28 +0,0 @@
|
||||
# How to Contribute
|
||||
|
||||
We'd love to accept your patches and contributions to this project. There are
|
||||
just a few small guidelines you need to follow.
|
||||
|
||||
## Contributor License Agreement
|
||||
|
||||
Contributions to this project must be accompanied by a Contributor License
|
||||
Agreement. You (or your employer) retain the copyright to your contribution;
|
||||
this simply gives us permission to use and redistribute your contributions as
|
||||
part of the project. Head over to <https://cla.developers.google.com/> to see
|
||||
your current agreements on file or to sign a new one.
|
||||
|
||||
You generally only need to submit a CLA once, so if you've already submitted one
|
||||
(even if it was for a different project), you probably don't need to do it
|
||||
again.
|
||||
|
||||
## Code reviews
|
||||
|
||||
All submissions, including submissions by project members, require review. We
|
||||
use GitHub pull requests for this purpose. Consult
|
||||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
||||
information on using pull requests.
|
||||
|
||||
## Community Guidelines
|
||||
|
||||
This project follows
|
||||
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
|
||||
@@ -1,201 +0,0 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -1,178 +0,0 @@
|
||||
HUGO_VERSION := 0.53
|
||||
HTMLPROOFER_VERSION := 3.10.2
|
||||
GCLOUD := gcloud
|
||||
GCP_PROJECT := gvisor-website
|
||||
|
||||
# Source Go files, example: main.go, foo/bar.go.
|
||||
GEN_SOURCE = $(wildcard cmd/generate-syscall-docs/*)
|
||||
APP_SOURCE = $(wildcard cmd/gvisor-website/*)
|
||||
# Target Go files, example: public/main.go, public/foo/bar.go.
|
||||
APP_TARGET = $(patsubst cmd/gvisor-website/%,public/%,$(APP_SOURCE))
|
||||
CONTENT_SOURCE = $(wildcard content/*)
|
||||
|
||||
default: website
|
||||
.PHONY: default
|
||||
|
||||
website: all-upstream app static-production
|
||||
.PHONY: website
|
||||
|
||||
app: $(APP_TARGET)
|
||||
.PHONY: app
|
||||
|
||||
public:
|
||||
mkdir -p public
|
||||
|
||||
# Load repositories.
|
||||
upstream:
|
||||
mkdir -p upstream
|
||||
upstream-%: upstream
|
||||
if [ -d upstream/$* ]; then (cd upstream/$* && git pull --rebase); else git clone https://gvisor.googlesource.com/$*/ upstream/$*; fi
|
||||
all-upstream: upstream-gvisor upstream-community
|
||||
# All repositories are listed here: force updates.
|
||||
.PHONY: all-upstream upstream-%
|
||||
|
||||
# This target regenerates the sigs directory; this is not PHONY.
|
||||
content/docs/community/sigs: upstream/community $(wildcard upstream/community/sigs/*)
|
||||
rm -rf content/docs/community/sigs && mkdir -p content/docs/community/sigs
|
||||
for file in $(shell cd upstream/community/sigs && ls -1 *.md | cut -d'.' -f1 | grep -v TEMPLATE); do \
|
||||
title=$$(cat upstream/community/sigs/$$file.md | grep -E '^# ' | cut -d' ' -f2-); \
|
||||
echo -e "+++\ntitle = \"$$title\"\n+++\n" > content/docs/community/sigs/$$file.md; \
|
||||
cat upstream/community/sigs/$$file.md |grep -v -E '^# ' >> content/docs/community/sigs/$$file.md; \
|
||||
done
|
||||
|
||||
$(APP_TARGET): public $(APP_SOURCE)
|
||||
cp -a cmd/gvisor-website/$(patsubst public/%,%,$@) public/
|
||||
|
||||
static-production: hugo-docker-image compatibility-docs node_modules config.toml $(shell find archetypes assets content themes -type f | sed 's/ /\\ /g')
|
||||
docker run \
|
||||
--rm \
|
||||
-e HUGO_ENV="production" \
|
||||
-e USER="$(shell id -u)" \
|
||||
-e HOME="/tmp" \
|
||||
-u="$(shell id -u):$(shell id -g)" \
|
||||
-v $(PWD):/workspace \
|
||||
-w /workspace \
|
||||
gcr.io/gvisor-website/hugo:$(HUGO_VERSION) \
|
||||
hugo
|
||||
.PHONY: static-production
|
||||
|
||||
static-staging: hugo-docker-image compatibility-docs node_modules config.toml $(shell find archetypes assets content themes -type f | sed 's/ /\\ /g')
|
||||
docker run \
|
||||
--rm \
|
||||
-e HUGO_ENV="production" \
|
||||
-e USER="$(shell id -u)" \
|
||||
-e HOME="/tmp" \
|
||||
-u="$(shell id -u):$(shell id -g)" \
|
||||
-v $(PWD):/workspace \
|
||||
-w /workspace \
|
||||
gcr.io/gvisor-website/hugo:$(HUGO_VERSION) \
|
||||
hugo \
|
||||
-b "https://staging-$(shell git branch | grep \* | cut -d ' ' -f2)-dot-gvisor-website.appspot.com"
|
||||
.PHONY: static-staging
|
||||
|
||||
node_modules: package.json package-lock.json
|
||||
# Use npm ci because npm install will update the package-lock.json.
|
||||
# See: https://github.com/npm/npm/issues/18286
|
||||
docker run \
|
||||
--rm \
|
||||
-e USER="$(shell id -u)" \
|
||||
-e HOME="/tmp" \
|
||||
-u="$(shell id -u):$(shell id -g)" \
|
||||
-v $(PWD):/workspace \
|
||||
-w /workspace \
|
||||
--entrypoint 'npm' \
|
||||
node ci
|
||||
|
||||
bin/generate-syscall-docs: $(GEN_SOURCE)
|
||||
mkdir -p bin/
|
||||
go build -o bin/generate-syscall-docs gvisor.dev/website/cmd/generate-syscall-docs
|
||||
|
||||
compatibility-docs: bin/generate-syscall-docs
|
||||
# bazel_user_root is used for caching bazel packages.
|
||||
mkdir -p bazel_user_root/
|
||||
docker run \
|
||||
--rm \
|
||||
-v $(PWD)/upstream/gvisor:/workspace \
|
||||
-v $(PWD)/bazel_user_root:/bazel_user_root \
|
||||
-w /workspace \
|
||||
--entrypoint 'sh' \
|
||||
l.gcr.io/google/bazel \
|
||||
-c '\
|
||||
groupadd --gid $(shell id -g) $(shell id -gn) && \
|
||||
useradd --uid $(shell id -u) --gid $(shell id -g) -ms /bin/bash $(USER) && \
|
||||
su $(USER) -c "bazel --output_user_root=/bazel_user_root run //runsc -- help syscalls -o json"' | ./bin/generate-syscall-docs -out ./content/docs/user_guide/compatibility/
|
||||
.PHONY: compatibility-docs
|
||||
|
||||
check: check-markdown check-html
|
||||
.PHONY: check
|
||||
|
||||
check-markdown: node_modules $(CONTENT_SOURCE) compatibility-docs
|
||||
docker run \
|
||||
--rm \
|
||||
-e USER="$(shell id -u)" \
|
||||
-e HOME="/tmp" \
|
||||
-u="$(shell id -u):$(shell id -g)" \
|
||||
-v $(PWD):/workspace \
|
||||
-v /tmp:/tmp \
|
||||
-w /workspace \
|
||||
--entrypoint 'npm' \
|
||||
node run lint-md
|
||||
.PHONY: check-markdown
|
||||
|
||||
check-html: website
|
||||
docker run \
|
||||
-v $(shell pwd)/public:/public gcr.io/gvisor-website/html-proofer:$(HTMLPROOFER_VERSION) \
|
||||
htmlproofer --disable-external --check-html public/static
|
||||
.PHONY: check-html
|
||||
|
||||
# Run a local content development server. Redirects will not be supported.
|
||||
devserver: hugo-docker-image all-upstream compatibility-docs
|
||||
docker run \
|
||||
--rm \
|
||||
-e USER="$(shell id -u)" \
|
||||
-e HOME="/tmp" \
|
||||
-u="$(shell id -u):$(shell id -g)" \
|
||||
-v $(PWD):/workspace \
|
||||
-w /workspace \
|
||||
-p 8080:8080 \
|
||||
gcr.io/gvisor-website/hugo:$(HUGO_VERSION) \
|
||||
hugo server \
|
||||
-FD \
|
||||
--bind 0.0.0.0 \
|
||||
--port 8080
|
||||
.PHONY: server
|
||||
|
||||
server: website
|
||||
cd public/ && go run main.go --custom-domain localhost
|
||||
.PHONY: server
|
||||
|
||||
# Stage the website to App Engine at a version based on the git branch name.
|
||||
stage: all-upstream app static-staging
|
||||
# Disallow indexing staged content.
|
||||
printf "User-agent: *\nDisallow: /" > public/static/robots.txt
|
||||
cd public && $(GCLOUD) app deploy -v staging-$(shell git branch | grep \* | cut -d ' ' -f2) --no-promote
|
||||
.PHONY: stage
|
||||
|
||||
# CI related Commmands
|
||||
##############################################################################
|
||||
|
||||
# Submit a build to Cloud Build manually. Used to test cloudbuild.yaml changes.
|
||||
cloud-build:
|
||||
gcloud builds submit --config cloudbuild.yaml .
|
||||
|
||||
# Build the hugo Docker image.
|
||||
hugo-docker-image:
|
||||
docker build --build-arg HUGO_VERSION=$(HUGO_VERSION) -t gcr.io/gvisor-website/hugo:$(HUGO_VERSION) cloudbuild/hugo/
|
||||
.PHONY: hugo-docker-image
|
||||
|
||||
# Build the html-proofer image used by Cloud Build.
|
||||
htmlproofer-docker-image:
|
||||
docker build --build-arg HTMLPROOFER_VERSION=$(HTMLPROOFER_VERSION) -t gcr.io/gvisor-website/html-proofer:$(HTMLPROOFER_VERSION) cloudbuild/html-proofer/
|
||||
.PHONY: htmlproofer-docker-image
|
||||
|
||||
clean:
|
||||
ifneq ("$(wildcard bazel_user_root/)","")
|
||||
chmod -R +w bazel_user_root/
|
||||
endif
|
||||
rm -rf bazel_user_root/ public/ resources/ node_modules/ upstream/ content/docs/user_guide/compatibility/linux/
|
||||
.PHONY: clean
|
||||
@@ -1,79 +0,0 @@
|
||||
# gVisor Website
|
||||
|
||||
This repository holds the content for the gVisor website. It uses
|
||||
[hugo](https://gohugo.io/) to generate the website and
|
||||
[Docsy](https://github.com/google/docsy) as the theme.
|
||||
|
||||
## Using Github
|
||||
|
||||
The easiest way to contribute to the documentation is to use the "Edit this
|
||||
page" link on any documentation page to edit the page content directly via
|
||||
GitHub and submit a pull request. This should generally be done for changes to
|
||||
a single page.
|
||||
|
||||
## Using Git
|
||||
|
||||
You can submit pull requests by making changes in a Git branch. See more
|
||||
information on GitHub pull requests
|
||||
[here](https://help.github.com/en/articles/about-pull-requests).
|
||||
|
||||
Documentation is located in the [content/docs/](content/docs/) directory.
|
||||
Documentation is written in markdown with hugo extensions. Please read more
|
||||
about [content management](https://gohugo.io/categories/content-management) in
|
||||
the hugo documentation.
|
||||
|
||||
### Requirements
|
||||
|
||||
Building the website requires [Docker](https://www.docker.com/). Please
|
||||
[install](https://docs.docker.com/install/) it before building.
|
||||
|
||||
### Building
|
||||
|
||||
If you want to simply build the website, you can do that using `make`. This
|
||||
will output the App Engine application code, configuration, and html and CSS
|
||||
into the `public/` directory.
|
||||
|
||||
```
|
||||
make
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
You can use the hugo web server for testing documentation or style changes.
|
||||
This will start a webserver that will rebuild the site when you make content
|
||||
changes:
|
||||
|
||||
```
|
||||
make devserver
|
||||
```
|
||||
|
||||
Access the site at http://localhost:8080
|
||||
|
||||
If you need to test all functionality including redirects you can start the App
|
||||
Engine app locally. However, you will need to restart the app when making
|
||||
content changes:
|
||||
|
||||
```
|
||||
make server
|
||||
```
|
||||
|
||||
## Updating Styles
|
||||
|
||||
If you want to update style on the website you can do this by updating
|
||||
templates or CSS for the website. Check out the [Hugo
|
||||
documentation](https://gohugo.io/documentation/) for info on hugo templating.
|
||||
Check out the [Docsy documentation](https://www.docsy.dev/docs/) for info on
|
||||
the Docsy theme.
|
||||
|
||||
### Custom templates, partials, and shortcodes
|
||||
|
||||
Custom templates, including partials and shortcodes, should go under the
|
||||
[layouts/](layouts) directory.
|
||||
|
||||
## Custom CSS
|
||||
|
||||
Custom CSS styles should go into the
|
||||
[_styles_project.scss](assets/scss/_styles_project.scss) file.
|
||||
|
||||
If you need to override or create variables used in scss styles, update the
|
||||
[_variables_project.scss](assets/scss/_variables_project.scss) file.
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
draft: true
|
||||
---
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 7.7 MiB |
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 9.5 MiB |
@@ -1 +0,0 @@
|
||||
../logos/logo_solo_on_dark.svg
|
||||
@@ -1,81 +0,0 @@
|
||||
// Custom styles.
|
||||
|
||||
// Apply the link-color to blocks with white background to improve
|
||||
// accessibility.
|
||||
a, .td-box--secondary p > a, .td-box--white p > a {
|
||||
color: $link-color;
|
||||
}
|
||||
|
||||
// The table anchor for syscall references so that entries referenced
|
||||
// directly by an anchor aren't buried underneath the header.
|
||||
a.doc-table-anchor {
|
||||
display: block;
|
||||
position: relative;
|
||||
top: -75px;
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
// Adjust the width of the svg logo in the header. For smaller svg
|
||||
// files the width is too large.
|
||||
.td-navbar .navbar-brand .navbar-logo svg {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
// Only show the navbar after scrolling down the page.
|
||||
.td-navbar-cover .navbar-brand {
|
||||
display: none;
|
||||
}
|
||||
.td-navbar-cover .td-navbar-nav-scroll {
|
||||
@media (min-width: 768px) {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
.td-navbar-cover.navbar-bg-onscroll .navbar-brand, .td-navbar-cover.navbar-bg-onscroll .td-navbar-nav-scroll {
|
||||
@media (min-width: 768px) {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
|
||||
// Show an inner navbar as part of the cover block
|
||||
.cover-content nav {
|
||||
@media (max-width: 767px) {
|
||||
display: none;
|
||||
}
|
||||
padding: 0;
|
||||
margin-top: 3rem;
|
||||
float: right;
|
||||
}
|
||||
// Left align the cover block and increase text size.
|
||||
.td-default main section.td-cover-block {
|
||||
@media (max-width: 767px) {
|
||||
text-align: center;
|
||||
}
|
||||
}
|
||||
.td-default main section.td-cover-block h1 {
|
||||
@media (min-width: 768px) {
|
||||
padding-top: 0.5rem; // match padding for .nav-link
|
||||
padding-bottom: 8rem;
|
||||
}
|
||||
}
|
||||
.td-default main section.td-cover-block {
|
||||
@media (min-width: 768px) {
|
||||
padding-top: 0;
|
||||
padding-bottom: 10rem;
|
||||
}
|
||||
}
|
||||
.td-default main section.td-cover-block p.lead {
|
||||
@media (min-width: 768px) {
|
||||
width: 50%;
|
||||
}
|
||||
font-size: $h1-font-size;
|
||||
}
|
||||
.td-default main section.td-cover-block p.lead strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.td-page,.td-section {
|
||||
main a.header-link {
|
||||
color: inherit;
|
||||
font-size: 60%;
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
// Colors.
|
||||
$primary: #262362;
|
||||
$secondary: #ffffff;
|
||||
$link-color: #286FD7;
|
||||
|
||||
// Fonts.
|
||||
$google_font_name: "Roboto";
|
||||
$google_font_family: "Roboto";
|
||||
|
||||
$font-size-base: 1rem;
|
||||
$h1-font-size: $font-size-base * 2;
|
||||
$h2-font-size: $font-size-base * 1.85;
|
||||
$h3-font-size: $font-size-base * 1.65;
|
||||
$h4-font-size: $font-size-base * 1.35;
|
||||
$h5-font-size: $font-size-base * 1.25;
|
||||
$h6-font-size: $font-size-base;
|
||||
@@ -1,81 +0,0 @@
|
||||
# Copyright 2019 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
steps:
|
||||
- name: 'bash'
|
||||
args: ['bash', '-c', 'mkdir -p upstream/']
|
||||
# Clone the upstream repos
|
||||
- name: 'gcr.io/cloud-builders/git'
|
||||
args: ['clone', 'https://github.com/google/gvisor.git']
|
||||
dir: 'upstream'
|
||||
- name: 'gcr.io/cloud-builders/git'
|
||||
args: ['clone', 'https://gvisor.googlesource.com/community']
|
||||
dir: 'upstream'
|
||||
# Build runsc
|
||||
- name: 'gcr.io/cloud-builders/bazel'
|
||||
args:
|
||||
- 'build'
|
||||
- '--show_timestamps'
|
||||
- '--test_output=errors'
|
||||
- '--keep_going'
|
||||
- '--verbose_failures'
|
||||
- 'runsc'
|
||||
dir: 'upstream/gvisor'
|
||||
# Build the compatibility doc generator tool
|
||||
- name: 'golang'
|
||||
env: ['GO111MODULE=on']
|
||||
args:
|
||||
- 'go'
|
||||
- 'build'
|
||||
- '-o'
|
||||
- 'bin/generate-syscall-docs'
|
||||
- 'gvisor.dev/website/cmd/generate-syscall-docs'
|
||||
# Generate compatibility docs.
|
||||
- name: 'bash'
|
||||
args:
|
||||
- 'bash'
|
||||
- '-c'
|
||||
- >
|
||||
./upstream/gvisor/bazel-bin/runsc/linux_amd64_pure_stripped/runsc help syscalls -o json |
|
||||
./bin/generate-syscall-docs -out ./content/docs/user_guide/compatibility/
|
||||
# Pull npm dependencies for scss and lint-md
|
||||
- name: 'gcr.io/cloud-builders/npm'
|
||||
args: ['ci']
|
||||
# Copy App Engine app files.
|
||||
- name: 'gcr.io/gvisor-website/hugo:0.53'
|
||||
args: ["make", "app"]
|
||||
# Generate the website.
|
||||
- name: 'gcr.io/gvisor-website/hugo:0.53'
|
||||
env: ['HUGO_ENV=production']
|
||||
args: ["hugo"]
|
||||
# Test Markdown for issues.
|
||||
- name: 'gcr.io/cloud-builders/npm'
|
||||
args: ['run', 'lint-md']
|
||||
# Test the HTML for issues.
|
||||
- name: 'gcr.io/gvisor-website/html-proofer:3.10.2'
|
||||
args:
|
||||
- "htmlproofer"
|
||||
- "--disable-external"
|
||||
- "--check-html"
|
||||
- "public/static"
|
||||
# Deploy to App Engine only for master branch.
|
||||
- name: 'gcr.io/cloud-builders/gcloud'
|
||||
entrypoint: 'bash'
|
||||
args:
|
||||
- '-c'
|
||||
- >
|
||||
if [[ "$PROJECT_ID" == "gvisor-website" && "$BRANCH_NAME" == "master" ]]; then
|
||||
gcloud app deploy public/app.yaml;
|
||||
fi
|
||||
timeout: 1200s
|
||||
@@ -1,23 +0,0 @@
|
||||
FROM ruby:2.4-alpine
|
||||
|
||||
LABEL MAINTAINER="ianlewis@google.com"
|
||||
|
||||
ARG HTMLPROOFER_VERSION
|
||||
|
||||
RUN set -x \
|
||||
&& apk add --no-cache \
|
||||
build-base \
|
||||
ca-certificates \
|
||||
curl \
|
||||
wget \
|
||||
libcurl \
|
||||
libxml2-dev \
|
||||
libxslt-dev \
|
||||
openssh \
|
||||
&& gem install \
|
||||
html-proofer:${HTMLPROOFER_VERSION} \
|
||||
nokogiri:1.10.1 \
|
||||
--no-document
|
||||
|
||||
CMD ["htmlproofer"]
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
FROM node:10.15.1-stretch-slim
|
||||
|
||||
LABEL MAINTAINER="ianlewis@google.com"
|
||||
|
||||
ARG HUGO_VERSION
|
||||
ENV HUGO_DOWNLOAD_URL=https://github.com/spf13/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_Linux-64bit.tar.gz
|
||||
|
||||
RUN set -x \
|
||||
&& apt-get update \
|
||||
&& apt-get install -y \
|
||||
ca-certificates \
|
||||
git \
|
||||
make \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
RUN wget "$HUGO_DOWNLOAD_URL" && \
|
||||
tar xzf hugo_extended_${HUGO_VERSION}_Linux-64bit.tar.gz && \
|
||||
mv hugo /usr/bin/hugo && \
|
||||
rm hugo_extended_${HUGO_VERSION}_Linux-64bit.tar.gz LICENSE README.md
|
||||
|
||||
CMD ["hugo"]
|
||||
-149
@@ -1,149 +0,0 @@
|
||||
baseURL = "https://gvisor.dev/"
|
||||
title = "gVisor"
|
||||
|
||||
publishDir = "public/static"
|
||||
|
||||
enableRobotsTXT = true
|
||||
|
||||
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
|
||||
theme = ["docsy"]
|
||||
|
||||
# Will give values to .Lastmod etc.
|
||||
# Disabled due to Cloud Build limitations.
|
||||
enableGitInfo = false
|
||||
|
||||
# Language settings
|
||||
contentDir = "content"
|
||||
defaultContentLanguage = "en"
|
||||
defaultContentLanguageInSubdir = false
|
||||
# Useful when translating.
|
||||
enableMissingTranslationPlaceholders = false
|
||||
|
||||
disableKinds = ["taxonomy", "taxonomyTerm"]
|
||||
|
||||
# Highlighting config
|
||||
pygmentsCodeFences = true
|
||||
pygmentsUseClasses = false
|
||||
# Use the new Chroma Go highlighter in Hugo.
|
||||
pygmentsUseClassic = false
|
||||
#pygmentsOptions = "linenos=table"
|
||||
# See https://help.farbox.com/pygments.html
|
||||
pygmentsStyle = "tango"
|
||||
|
||||
[[menu.main]]
|
||||
name = "Documentation"
|
||||
weight = -100
|
||||
url = "/docs/"
|
||||
[[menu.main]]
|
||||
name = "Blog"
|
||||
weight = -99
|
||||
url = "/blog/"
|
||||
[[menu.main]]
|
||||
name = "GitHub"
|
||||
weight = -98
|
||||
url = "https://github.com/google/gvisor"
|
||||
|
||||
# First one is picked as the Twitter card image if not set on page.
|
||||
#images = ["images/project-illustration.png"]
|
||||
|
||||
# Configure how URLs look like per section.
|
||||
[permalinks]
|
||||
blog = "/:section/:year/:month/:day/:slug/"
|
||||
|
||||
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
|
||||
[blackfriday]
|
||||
plainIDAnchors = true
|
||||
hrefTargetBlank = false
|
||||
angledQuotes = false
|
||||
latexDashes = true
|
||||
|
||||
# Image processing configuration.
|
||||
[imaging]
|
||||
resampleFilter = "CatmullRom"
|
||||
quality = 75
|
||||
anchor = "smart"
|
||||
|
||||
[services]
|
||||
[services.googleAnalytics]
|
||||
id = "UA-150193582-1"
|
||||
|
||||
# Everything below this are Site Params
|
||||
|
||||
[params]
|
||||
copyright = "Google LLC"
|
||||
privacy_policy = "https://policies.google.com/privacy"
|
||||
github_repo = "https://github.com/google/gvisor-website"
|
||||
|
||||
# Google Custom Search Engine ID. Remove or comment out to disable search.
|
||||
# TODO: custom search engine
|
||||
# gcs_engine_id = ""
|
||||
|
||||
# User interface configuration
|
||||
[params.ui]
|
||||
# Enable to show the side bar menu in its compact state.
|
||||
sidebar_menu_compact = false
|
||||
# Set to true to disable breadcrumb navigation.
|
||||
breadcrumb_disable = false
|
||||
|
||||
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
|
||||
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
|
||||
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
|
||||
# add "hide_feedback: true" to the page's front matter.
|
||||
[params.ui.feedback]
|
||||
enable = false
|
||||
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
|
||||
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
|
||||
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
|
||||
|
||||
[params.links]
|
||||
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
|
||||
# [[params.links.user]]
|
||||
# name = "User mailing list"
|
||||
# url = "https://groups.google.com/forum/#!forum/gvisor-users"
|
||||
# icon = "fa fa-envelope"
|
||||
# desc = "Discussion and help from your fellow users"
|
||||
# [[params.links.user]]
|
||||
# name ="Twitter"
|
||||
# url = "https://example.org/twitter"
|
||||
# icon = "fab fa-twitter"
|
||||
# desc = "Follow us on Twitter to get the latest news!"
|
||||
# [[params.links.user]]
|
||||
# name = "Stack Overflow"
|
||||
# url = "https://example.org/stack"
|
||||
# icon = "fab fa-stack-overflow"
|
||||
# desc = "Practical questions and curated answers"
|
||||
[[params.links.user]]
|
||||
name = "Docs"
|
||||
url = "/docs/"
|
||||
icon = "fa fa-book"
|
||||
desc = "Read our documentation to understand gVisor, its architecture and trade-offs, and how to use it."
|
||||
[[params.links.user]]
|
||||
name = "Chat"
|
||||
url = "https://gitter.im/gvisor/community"
|
||||
icon = "fa fa-comment"
|
||||
desc = "Get support and chat about how to use gVisor"
|
||||
[[params.links.user]]
|
||||
name = "User mailing list"
|
||||
url = "https://groups.google.com/forum/#!forum/gvisor-users"
|
||||
icon = "fa fa-envelope"
|
||||
desc = "Get support and discuss how to use gVisor"
|
||||
|
||||
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
|
||||
[[params.links.developer]]
|
||||
name = "GitHub"
|
||||
url = "https://github.com/google/gvisor"
|
||||
icon = "fab fa-github"
|
||||
desc = "Development takes place here!"
|
||||
# [[params.links.developer]]
|
||||
# name = "Slack"
|
||||
# url = "https://example.org/slack"
|
||||
# icon = "fab fa-slack"
|
||||
# desc = "Chat with other project developers"
|
||||
[[params.links.developer]]
|
||||
name = "Developer mailing list"
|
||||
url = "https://groups.google.com/forum/#!forum/gvisor-dev"
|
||||
icon = "fa fa-envelope"
|
||||
desc = "Get info on the development of gVisor"
|
||||
|
||||
[params.vars]
|
||||
required_linux = "4.14.77+"
|
||||
@@ -1,51 +0,0 @@
|
||||
+++
|
||||
title = "gVisor"
|
||||
linkTitle = "gVisor"
|
||||
description = "A container sandbox runtime focused on security, efficiency, and ease of use."
|
||||
+++
|
||||
|
||||
{{< blocks/cover image_anchor="top" height="auto" color="primary" title="gVisor" >}}
|
||||
<div class="mx-auto">
|
||||
<p class="lead">A container sandbox runtime focused on <strong>security</strong>, <strong>efficiency</strong>, and <strong>ease of use</strong>.</p>
|
||||
<a class="btn btn-lg btn-primary mr-3 mb-4" href="./docs/user_guide/quick_start/docker/">Quick Start<i class="fas fa-arrow-alt-circle-right ml-2"></i></a>
|
||||
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/gvisor" rel="noopener">GitHub <i class="fab fa-github ml-2"></i></a>
|
||||
</div>
|
||||
{{< /blocks/cover >}}
|
||||
|
||||
{{% blocks/lead color="secondary" %}}
|
||||
gVisor is an open-source, <a href="https://www.opencontainers.org/" target="_blank" rel="noopener">OCI-compatible</a> sandbox runtime that provides a virtualized container environment. It runs containers with a new <a href="https://en.wikipedia.org/wiki/User_space" target="_blank" rel="noopener">user-space</a> kernel, delivering a low overhead container security solution for high-density applications.
|
||||
|
||||
gVisor integrates with <a href="https://www.docker.com/" target="_blank" rel="noopener">Docker</a>, <a href="https://containerd.io/" target="_blank" rel="noopener">containerd</a> and <a href="https://kubernetes.io/" target="_blank" rel="noopener">Kubernetes</a>, making it easier to improve the security isolation of your containers while still using familiar tooling. Additionally, gVisor supports a variety of underlying mechanisms for intercepting application calls, allowing it to run in diverse host environments, including cloud-hosted virtual machines.
|
||||
{{% /blocks/lead %}}
|
||||
|
||||
{{< blocks/section color="dark" >}}
|
||||
|
||||
{{% blocks/feature icon="fas fa-lock" title="Defense in Depth" %}}
|
||||
Each sandbox has its own user-space kernel, providing additional protection from host kernel vulnerabilities.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fas fa-feather-alt" title="Lightweight" %}}
|
||||
Runs as a normal process and uses the host kernel for memory management and scheduling.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fab fa-linux" title="Zero Configuration" %}}
|
||||
Capable of running most Linux applications unmodified, with zero configuration.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{< /blocks/section >}}
|
||||
|
||||
{{< blocks/section color="white" >}}
|
||||
|
||||
{{% blocks/feature icon="fas fa-book" title="Read the Docs" %}}
|
||||
Read the [documentation](./docs/) to understand gVisor, its architecture and trade-offs, and how to use it.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fas fa-code-branch" title="Contribute to gVisor" %}}
|
||||
Anyone is welcome to be a gVisor contributor. Please check out the [community information](./docs/community/) to get started.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fab fa-github" title="Give Feedback" %}}
|
||||
File feature requests, bugs, and compatibility issues on <a href="https://github.com/google/gvisor/issues" target="_blank" rel="noopener">GitHub</a>.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{< /blocks/section >}}
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
title: "gVisor Blog"
|
||||
linkTitle: "Blog"
|
||||
---
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user