Skip to content

Commit d1503dc

Browse files
lucperkinslucperkins
committed
Migrate website to Hugo
Signed-off-by: Luc Perkins <[email protected]>
1 parent b511c39 commit d1503dc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+235
-240
lines changed

‎.ruby-version

-1
This file was deleted.

‎Gemfile

-4
This file was deleted.

‎Gemfile.lock

-69
This file was deleted.

‎docs/.editorconfig

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[*]
2+
end_of_line = lf
3+
charset = utf-8
4+
max_line_length = 80
5+
trim_trailing_whitespace = true
6+
insert_final_newline = false
7+
8+
[*.{html,js,sh,sass,md,mmark}]
9+
indent_style = space
10+
indent_size = 2
11+
12+
[Makefile]
13+
indent_style = tab

‎docs/.gitignore

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
**/.DS_Store
22
**/desktop.ini
3-
.bundle/**
4-
.jekyll-metadata
5-
_site/**
6-
.sass-cache/**
73
CNAME
8-
Gemfile.lock
4+
5+
# Hugo-generated content
6+
public/

‎docs/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515

1616
FROM nginx
1717

18-
COPY _site /usr/share/nginx/html
18+
COPY public /usr/share/nginx/html

‎docs/hooks/pre_build ‎docs/Makefile

+15-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
#!/bin/bash
2-
31
# Copyright The containerd Authors.
42

53
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,13 +12,20 @@
1412
# See the License for the specific language governing permissions and
1513
# limitations under the License.
1614

15+
HUGO = hugo
16+
BASE_URL = https://containerd.io
17+
18+
clean:
19+
rm -rf public
20+
21+
build: clean
22+
$(HUGO) \
23+
--baseURL $(BASE_URL)
1724

18-
echo "=> Building the binary"
19-
docker run --privileged \
20-
-v $(pwd):/usr/src/app \
21-
-v /var/run/docker.sock:/var/run/docker.sock \
22-
starefossen/github-pages jekyll build
23-
echo $(pwd)
24-
ls -la
25-
ls -la _site
25+
build-preview: clean
26+
$(HUGO)
2627

28+
dev: clean
29+
$(HUGO) server \
30+
--disableFastRender \
31+
--ignoreCache

‎docs/README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Containerd website
22

3-
The containerd website is built using Jekyll and published to Github pages.
3+
The containerd website at https://containerd.io is built using [Hugo](https://gohugo.io) and published to [Netlify](https://netlify.com).
44

5-
In order to build and test locally:
6-
```
7-
docker run -it -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages
5+
To develop the site locally in "watch" mode (using Docker):
6+
7+
```bash
8+
$ docker run -it -v $(pwd):/src -p "1313:1313" -e HUGO_WATCH=true jojomi/hugo
89
```
9-
Then browser to localhost:4000 to see the rendered site. The site autorefreshes when you modify files locally.
10+
11+
You can then open up your browser to localhost:1313 to see the rendered site. The site auto-refreshes when you modify files locally.
1012

‎docs/_config.yml

-23
This file was deleted.

‎docs/_includes/footer.html

-21
This file was deleted.

‎docs/_includes/header.html

-14
This file was deleted.

‎docs/_includes/links.html

-3
This file was deleted.

‎docs/_layouts/default.html

-15
This file was deleted.

‎docs/_layouts/home.html

-18
This file was deleted.

‎docs/config.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
title: containerd
2+
baseURL: /
3+
disableKinds: ["taxonomy", "taxonomyTerm"]
4+
5+
params:
6+
googleAnalyticsId: UA-71407002-1
7+
favicon: /img/favicon.png
8+
fontImport: https://fonts.googleapis.com/css?family=Lato:300,400|Raleway:400,700i,800
9+
css:
10+
- main
11+
- flexboxgrid
12+
- tomorrow-night
13+
js:
14+
- jquery-2.1.4.min
15+
- highlight.min
16+
- main

‎docs/index.md ‎docs/content/_index.md

+12-27
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
11
---
2-
title: containerd
3-
layout: home
42
---
53

64
## News
75

8-
* [Sign up for DockerCon in June](https://2018.dockercon.com)
9-
* [Feb 2018: containerd 1.0.2-rc.1 release](https://github.com/containerd/containerd/releases/tag/v1.0.2-rc.1)
10-
* [Dec 2017: The New Stack: Containerd 1.0 Release Becomes the Public Face of Containers](https://thenewstack.io/containerd-1-0-release/)
11-
* [Dec 2017: containerd 1.0 release announcement](https://blog.docker.com/2017/12/cncf-containerd-1-0-ga-announcement/)
12-
* [March 2017: Docker to donate containerd to the Cloud Native Computing Foundation](https://blog.docker.com/2017/03/docker-donates-containerd-to-cncf/)
13-
* [February 2017: containerd Summit recap](https://blog.docker.com/2017/02/containerd-summit-recap-slides-videos-meeting-notes/)
14-
* [January 2017: containerd Livestream recap](https://blog.docker.com/2017/01/containerd-livestream-recap)
6+
{{< news >}}
157

168
## About containerd
179

@@ -23,28 +15,21 @@ containerd includes a daemon exposing gRPC API over a local UNIX socket. The API
2315

2416
containerd is based on the Docker Engine’s core container runtime to benefit from its maturity and existing contributors.
2517

26-
![Containerd High Level Architecture](images/chart-a.png "Containerd High Level Architecture")
27-
18+
![Containerd High Level Architecture](/img/chart-a.png "Containerd High Level Architecture")
2819

2920
## Features and roadmap
3021

31-
* OCI Image Spec support
32-
* OCI Runtime Spec support (aka runC)
33-
* Image push and pull support
34-
* Container runtime and lifecycle support
35-
* Network primitives for creation, modification, and deletion of interfaces
36-
* Management of network namespaces containers to join existing namespaces
37-
* Multi-tenant supported with CAS storage for global images
22+
{{< features >}}
3823

3924
containerd, currently in [version 1.0.1](https://github.com/containerd/containerd/releases/tag/v1.0.1), is a daemon born from extracting the container execution subset of the Docker Engine, and is [used internally by Docker since the 1.11 release](https://blog.docker.com/2016/04/docker-engine-1-11-runc/). containerd versions prior to v1.0.x were used in Docker 17.10 and earlier (see Docker [version release notes](https://github.com/docker/docker-ce/releases)), and [Docker 17.12](https://github.com/docker/docker-ce/releases/tag/v17.12.0-ce) is the first release to use containerd v1.0.0.
4025

4126
The containerd maintainers do not provide a consolidated [containerd roadmap](https://github.com/containerd/containerd/blob/master/ROADMAP.md), but have chosen to use issues and milestones to track and implement major and minor features.
4227

4328
## Architecture
4429

45-
Containerd [architecture](https://github.com/containerd/containerd/blob/master/design/architecture.md) and [API](https://github.com/containerd/containerd/tree/master/api/) are described in the Github repository.
30+
Containerd [architecture](https://github.com/containerd/containerd/blob/master/design/architecture.md) and [API](https://github.com/containerd/containerd/tree/master/api/) are described in the GitHub repository.
4631

47-
![Containerd Architecture](images/chart-b.png "Containerd High Level Architecture")
32+
![Containerd Architecture](/img/chart-b.png "Containerd High Level Architecture")
4833

4934
## Principles and Releases
5035

@@ -93,34 +78,34 @@ Each major version will be supported for 1 year with bug fixes and security patc
9378
Docker is a complete platform and programming environment for containerized applications. containerd is one of dozens of specialized components integrated into Docker. Developers and IT professionals looking to build, ship and run containerized applications should continue to use Docker. Operators and integrators looking for specialized components to swap into their platform should consider containerd.
9479

9580

96-
![Containerd and Docker](images/chart-c.png "Containerd and Docker")
81+
![Containerd and Docker](/img/chart-c.png "Containerd and Docker")
9782

9883
containerd 0.2.4 used in Docker 1.12 covers only container execution and process management.
9984

100-
![Containerd in Docker today](images/chart-g.png "Containerd in Docker today")
85+
![Containerd in Docker today](/img/chart-g.png "Containerd in Docker today")
10186

10287
containerd's roadmap is to refactor the Docker Engine codebase to extract more of its logic for distribution, networking and storage on a single host into a reusable component that Docker will use, and that can be used by other container orchestration projects or hosted container services.
10388

104-
![Containerd in Docker tomorrow](images/chart-d.png "Containerd in Docker tomorrow")
89+
![Containerd in Docker tomorrow](/img/chart-d.png "Containerd in Docker tomorrow")
10590

10691
2. What is the relationship between containerd, OCI and runc?
10792

108-
Docker [donated the OCI specification to the Linux Foundation in 2015](https://blog.docker.com/2015/06/open-container-project-foundation/), along with a reference implementation called `runc`. containerd integrates [OCI](https://www.opencontainers.org/)/[runc](https://runc.io/) into a feature-complete, production-ready core container runtime. runc is a component of containerd, the executor for containers. containerd has a wider scope than just executing containers: downloading container images, managing storage and network interfaces, calling runc with the right parameters to run containers. containerd fully leverages the Open Container Initiative’s (OCI) runtime, image format specifications and OCI reference implementation (runc) and will pursue OCI certification when it is available. Because of its massive adoption, containerd is the industry standard for implementing OCI.
93+
Docker [donated the OCI specification to the Linux Foundation in 2015](https://blog.docker.com/2015/06/open-container-project-foundation/), along with a reference implementation called `runc`. containerd integrates [OCI](https://www.opencontainers.org/)/[runc](https://runc.io/) into a feature-complete, production-ready core container runtime. runc is a component of containerd, the executor for containers. containerd has a wider scope than just executing containers: downloading container images, managing storage and network interfaces, calling runc with the right parameters to run containers. containerd fully leverages the Open Container Initiative’s (OCI) runtime, image format specifications and OCI reference implementation (runc) and will pursue OCI certification when it is available. Because of its massive adoption, containerd is the industry standard for implementing OCI.
10994

110-
![Containerd, runc and OCI](images/chart-a.png "Containerd, runc and OCI")
95+
![Containerd, runc and OCI](/img/chart-a.png "Containerd, runc and OCI")
11196

11297
3. What is the relationship between containerd and container orchestration systems like Kubernetes and Mesos?
11398

11499
Kubernetes today uses Docker directly. In a future version Kubernetes can implement container support in the Kubelet by implementing it's [Container Runtime Interface](https://github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/container-runtime-interface.md) using containerd. Mesos and other orchestration engines can leverage containerd for core container runtime functionality as well.
115100

116-
![Containerd in the container ecosystem](images/chart-f.png "Containerd in the container ecosystem")
101+
![Containerd in the container ecosystem](/img/chart-f.png "Containerd in the container ecosystem")
117102

118103
4. What is the relationship between containerd and cloud managed container services?
119104

120105
See answer above: cloud managed container services can leverage containerd instead of Docker in order to provide container functionalities to their users.
121106

122107
## CNCF
123108

124-
![Containerd is a Cloud Native Computing Foundation member project](images/CNCF_Alternate_Pantone.png "Containerd is a Cloud Native Computing Foundation member project")
109+
![Containerd is a Cloud Native Computing Foundation member project](/img/CNCF_Alternate_Pantone.png "Containerd is a Cloud Native Computing Foundation member project")
125110

126111
We are a Cloud Native Computing Foundation member project.

‎docs/client-opts.md ‎docs/content/docs/client-opts.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Client Options
1+
---
2+
title: Client options
3+
draft: true
4+
---
25

36
The containerd client was built to be easily extended by consumers.
47
The goal is that the execution flow of the calls remain the same across implementations while `Opts` are written to extend functionality.

0 commit comments

Comments
 (0)