Skip to content

Commit fd83860

Browse files
author
kakzhou719
committed
first commit: move web site from sealer repo to separate repo
1 parent 9473439 commit fd83860

Some content is hidden

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

69 files changed

+6735
-0
lines changed

‎README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# How to run this page
2+
3+
This page generated by [vuepress](https://github.com/vuepress/create-vuepress-site)
4+
5+
How to build static files:
6+
7+
```
8+
npm run build
9+
cd .vuepress/dist
10+
```
11+
12+
Vuepress syntax error will cause the failure of building. [docs](https://vuepress.vuejs.org/guide/using-vue.html)

‎package.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "site",
3+
"version": "0.0.1",
4+
"description": "sealer home page",
5+
"main": "index.js",
6+
"authors": {
7+
"name": "fanux",
8+
"email": "[email protected]"
9+
},
10+
"repository": "https://github.com/sealerio/sealer/site",
11+
"scripts": {
12+
"dev": "vuepress dev src",
13+
"build": "vuepress build src"
14+
},
15+
"license": "MIT",
16+
"devDependencies": {
17+
"vuepress": "^0.14.11"
18+
}
19+
}

‎src/.vuepress/components/Foo/Bar.vue

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<template>
2+
<p class="demo">
3+
{{ msg }}
4+
</p>
5+
</template>
6+
7+
<script>
8+
export default {
9+
data () {
10+
return {
11+
msg: 'Hello this is <Foo-Bar>'
12+
}
13+
}
14+
}
15+
</script>

‎src/.vuepress/components/OtherComponent.vue

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<template>
2+
<p class="demo">This is another component</p>
3+
</template>

‎src/.vuepress/components/demo-component.vue

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<template>
2+
<p class="demo">
3+
{{ msg }}
4+
</p>
5+
</template>
6+
7+
<script>
8+
export default {
9+
data() {
10+
return {
11+
msg: 'Hello this is <demo-component>'
12+
}
13+
}
14+
}
15+
</script>

‎src/.vuepress/config.js

+213
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,213 @@
1+
const { description } = require('../../package')
2+
3+
enSideBar = {
4+
nav: [
5+
{
6+
text: 'docs',
7+
link: '/docs/getting-started/introduction',
8+
},
9+
{
10+
text: 'github',
11+
link: 'https://github.com/sealerio/sealer'
12+
}
13+
],
14+
sidebar: {
15+
'/docs/': [
16+
{
17+
title: 'Getting Started',
18+
collapsable: true,
19+
children: [
20+
'getting-started/introduction',
21+
'getting-started/quick-start',
22+
'getting-started/run-cloudimage',
23+
'getting-started/using-clusterfile',
24+
'getting-started/build-cloudimage',
25+
'getting-started/build-appimage',
26+
'getting-started/config',
27+
'getting-started/plugin',
28+
'getting-started/applications',
29+
]
30+
},
31+
{
32+
title: 'Advanced',
33+
collapsable: true,
34+
children: [
35+
'advanced/architecture',
36+
'advanced/arm-cloudimage',
37+
'advanced/containerd-baseimage',
38+
'advanced/define-cloudimage',
39+
'advanced/develop-plugin',
40+
'advanced/gpu-cloudimage',
41+
'advanced/raw-docker-baseimage',
42+
'advanced/registry-configuration',
43+
'advanced/save-charts-package',
44+
'advanced/takeover-existed-cluster',
45+
'advanced/use-kyverno-baseimage',
46+
'advanced/use-sealer-in-container',
47+
]
48+
},
49+
{
50+
title: 'Reference',
51+
collapsable: true,
52+
children: [
53+
'reference/cli',
54+
'reference/cloudrootfs',
55+
'reference/clusterfile',
56+
'reference/kubefile',
57+
]
58+
},
59+
{
60+
title: 'Contributing',
61+
collapsable: true,
62+
children: [
63+
'contributing/code-of-conduct',
64+
'contributing/contribute',
65+
]
66+
},
67+
{
68+
title: 'Help',
69+
collapsable: true,
70+
children: [
71+
'help/contact',
72+
'help/faq',
73+
]
74+
},
75+
],
76+
},
77+
};
78+
79+
zhSideBar = {
80+
selectText:'选择语言',
81+
nav: [
82+
{
83+
text: '文档',
84+
link: '/zh/getting-started/introduction',
85+
},
86+
{
87+
text: 'github',
88+
link: 'https://github.com/sealerio/sealer'
89+
}
90+
],
91+
sidebar: {
92+
'/zh/': [
93+
{
94+
title: '快速开始',
95+
collapsable: true,
96+
children: [
97+
'getting-started/introduction',
98+
'getting-started/quick-start',
99+
'getting-started/using-clusterfile',
100+
'getting-started/use-cloudimage',
101+
'getting-started/build-cloudimage',
102+
'getting-started/build-appimage',
103+
'getting-started/config',
104+
'getting-started/plugin',
105+
'getting-started/applications',
106+
]
107+
},
108+
{
109+
title: '高阶教程',
110+
collapsable: true,
111+
children: [
112+
'advanced/architecture',
113+
'advanced/arm-cloudimage',
114+
'advanced/containerd-baseimage',
115+
'advanced/define-cloudimage',
116+
'advanced/develop-plugin',
117+
'advanced/gpu-cloudimage',
118+
'advanced/raw-docker-baseimage',
119+
'advanced/registry-configuration',
120+
'advanced/save-charts-package',
121+
'advanced/use-kyverno-baseimage',
122+
]
123+
},
124+
{
125+
title: 'CLI&API',
126+
collapsable: true,
127+
children: [
128+
'reference/cli',
129+
'reference/cloudrootfs',
130+
'reference/clusterfile',
131+
'reference/kubefile',
132+
]
133+
},
134+
{
135+
title: '贡献',
136+
collapsable: true,
137+
children: [
138+
'contributing/code-of-conduct',
139+
'contributing/contribute',
140+
]
141+
},
142+
{
143+
title: '帮助',
144+
collapsable: true,
145+
children: [
146+
'help/contact',
147+
'help/faq',
148+
]
149+
},
150+
],
151+
},
152+
};
153+
154+
module.exports = {
155+
/**
156+
* Ref：https://v1.vuepress.vuejs.org/config/#title
157+
*/
158+
title: 'sealer',
159+
/**
160+
* Ref：https://v1.vuepress.vuejs.org/config/#description
161+
*/
162+
description: description,
163+
164+
/**
165+
* Extra tags to be injected to the page HTML `<head>`
166+
*'
167+
* ref：https://v1.vuepress.vuejs.org/config/#head
168+
*/
169+
head: [
170+
['meta', { name: 'theme-color', content: '#3eaf7c' }],
171+
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
172+
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
173+
['link', { rel: 'icon', href: 'https://sealer.oss-cn-beijing.aliyuncs.com/logo.png' }]
174+
],
175+
locales: {
176+
'/': {
177+
lang: 'en-US',
178+
title: 'sealer',
179+
description: description,
180+
},
181+
'/zh/': {
182+
lang: '简体中文',
183+
title: 'sealer',
184+
description: 'sealer 官方文档',
185+
}
186+
},
187+
188+
/**
189+
* Theme configuration, here is the default theme configuration for VuePress.
190+
*
191+
* ref：https://v1.vuepress.vuejs.org/theme/default-theme-config.html
192+
*/
193+
themeConfig: {
194+
repo: '',
195+
logo: 'https://sealer.oss-cn-beijing.aliyuncs.com/logo.png',
196+
editLinks: false,
197+
docsDir: '',
198+
editLinkText: '',
199+
lastUpdated: false,
200+
locales: {
201+
'/zh/': zhSideBar,
202+
'/': enSideBar,
203+
}
204+
},
205+
206+
/**
207+
* Apply plugins, ref：https://v1.vuepress.vuejs.org/zh/plugin/
208+
*/
209+
plugins: [
210+
'@vuepress/plugin-back-to-top',
211+
'@vuepress/plugin-medium-zoom',
212+
]
213+
}

‎src/.vuepress/enhanceApp.js

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/**
2+
* Client app enhancement file.
3+
*
4+
* https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
5+
*/
6+
7+
export default ({
8+
Vue, // the version of Vue being used in the VuePress app
9+
options, // the options for the root Vue instance
10+
router, // the router instance for the app
11+
siteData // site metadata
12+
}) => {
13+
// ...apply enhancements for the site.
14+
}

‎src/.vuepress/styles/index.styl

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* Custom Styles here.
3+
*
4+
* ref：https://v1.vuepress.vuejs.org/config/#index-styl
5+
*/
6+
7+
.home .hero img
8+
max-width 450px!important

‎src/.vuepress/styles/palette.styl

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
* Custom palette here.
3+
*
4+
* ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
5+
*/
6+
7+
$accentColor = #3eaf7c
8+
$textColor = #2c3e50
9+
$borderColor = #eaecef
10+
$codeBgColor = #282c34

‎src/docs/advanced/architecture.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Architecture
2+
3+
![](https://user-images.githubusercontent.com/8912557/133879086-f13e3e37-65c3-43e2-977c-e8ebf8c8fb34.png)
4+
5+
Sealer has two top module: Build Engine & Apply Engine
6+
7+
The Build Engine Using Kubefile and build context as input, and build a CloudImage that contains all the dependencies.
8+
The Apply Engine Using Clusterfile to init a cluster which contains kubernetes and other applications.
9+
10+
## Build Engine
11+
12+
* Parser : parse Kubefile into image metadata
13+
* Registry : push or pull the CloudImage
14+
* Store : save CloudImage to local disks
15+
16+
### Builders
17+
18+
* Lite Builder, sealer will check all the manifest or helm chart, decode docker images in those files, and cache them into CloudImage.
19+
* Cloud Builder, sealer will create a Cluster using public cloud, and exec `RUN & CMD` command witch defined in Kubefile, then cache all the docker image in the Cluster.
20+
* Container Builder, Using Docker container as a node, run kubernetes cluster in container then cache all the docker images.
21+
22+
## Apply Engine
23+
24+
* Infra : manage infrastructure, like create VMs in public cloud then apply the cluster on top of it. Or using docker emulation nodes.
25+
* Runtime : cluster installer implementation, like using kubeadm to install cluster.
26+
* Config : application config, like mysql username passwd or other configs, you can use Config overwrite any file you want.
27+
* Plugin : plugin help us do some extra work, like exec a shell command before install, or add a label to a node after install.
28+
* Debug : help us check the cluster is healthy or not, find reason when things unexpected.
29+
30+
## Other modules
31+
32+
* Filesystem : Copy CloudRootfs files to all nodes
33+
* Mount : mount CloudImage all layers together
34+
* Checker : do some pre-check and post check
35+
* Command : a command proxy to do some tasks which os don't have the command. Like ipvs or cert manager.
36+
* Guest : manage user application layer, like exec CMD command defined in Kubefile.

‎src/docs/advanced/arm-cloudimage.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# ARM CloudImage
2+
3+
Download sealer for example download v0.8.5:
4+
5+
```shell script
6+
wget https://github.com/sealerio/sealer/releases/download/v0.8.5/sealer-v0.8.5-linux-arm64.tar.gz
7+
```
8+
9+
## Run a cluster on ARM platform
10+
11+
```shell script
12+
sealer run kubernetes:v1.19.8 --master 192.168.0.3 --passwd xxx
13+
```
14+
15+
## Build an ARM cloud image
16+
17+
Just "FROM" the ARM cloud image to run sealer build on any platform will build out the ARM cloud image .
18+
19+
Kubefile example:
20+
21+
```shell
22+
FROM kubernetes-arm64:v1.19.7
23+
COPY imageList manifests
24+
COPY recommended.yaml manifests
25+
CMD kubectl apply -f manifests/recommended.yaml
26+
```
27+
28+
Run an ARM dashboard cloud image.
29+
30+
```shell
31+
sealer build -f Kubefile -t my-dashboard:v1 .
32+
```
33+
34+
Run this arm dashboard cloud image.
35+
36+
```shell
37+
sealer run my-dashboard:v1 --master 192.168.0.3 --passwd xxx
38+
```

‎src/docs/advanced/containerd-baseimage.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Containerd BaseImage

0 commit comments

Comments
 (0)