Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add v0.11.0 doc #70

Merged
merged 1 commit into from
Jul 25, 2023
Merged

add v0.11.0 doc #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 72 additions & 1 deletion src/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ enSideBar = {
{text: 'v0.9.0', link: '/v0.9.0/introduction/introduction'},
{text: 'v0.9.1', link: '/v0.9.1/introduction/introduction'},
{text: 'v0.9.2', link: '/v0.9.2/introduction/introduction'},
{text: 'v0.10.0', link: '/docs/introduction/introduction'},
{text: 'v0.10.0', link: '/v0.10.0/introduction/introduction'},
{text: 'v0.11.0', link: '/docs/introduction/introduction'},
]
},
],
Expand Down Expand Up @@ -90,6 +91,76 @@ enSideBar = {
},
// 'release-notes/0.9.2',
],
'/v0.10.0/': [
{
title: 'Introduction',
collapsable: true,
children: [
'introduction/introduction',
'introduction/architecture',
]
},
{
title: 'Getting Started',
collapsable: true,
children: [
'getting-started/quick-start',
'getting-started/install-sealer',
]
},
{
title: 'Commands',
collapsable: true,
children: [
'command/sealer',
'command/image/image',
'command/cluster/cluster',
'command/alpha/sealer_alpha',
]
},
{
title: 'Concepts',
collapsable: true,
children: [
'concept/kubefile',
'concept/sealer-image',
'concept/clusterfile',
]
},
{
title: 'Advanced',
collapsable: true,
children: [
'advanced/customize-cluster-image',
'advanced/use-sealer-image-offline',
'advanced/run-with-clusterfile',
'advanced/sealer-run-rootless',
]
},
{
title: 'Find Sealer Images',
collapsable: true,
children: [
'sealer-images/cluster-images',
]
},
{
title: 'Contributing',
collapsable: true,
children: [
'contributing/code-of-conduct',
'contributing/contribute',
]
},
{
title: 'Help',
collapsable: true,
children: [
'help/contact',
'help/faq',
]
},
],
'/v0.9.2/': [
{
title: 'Introduction',
Expand Down
1 change: 1 addition & 0 deletions src/docs/command/image/sealer_build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ build multi-platform image:
--build-arg strings set custom build args
-f, --file string Kubefile filepath (default "Kubefile")
-h, --help help for build
--build-mode whether to download container image during the build process. default is `all`.
--ignored-image-list pathname pathname of ignored image list filepath, if set, sealer will read its contents and prevent downloading of the corresponding container image (default "filepath")
--image-list pathname pathname of imageList filepath, if set, sealer will read its content and download extra container (default "filepath")
--image-list-with-auth pathname pathname of imageListWithAuth.yaml filepath, if set, sealer will read its content and download extra container images to rootfs(not usually used)
Expand Down
31 changes: 31 additions & 0 deletions src/docs/concept/clusterfile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ type ClusterSpec struct {
HostAliases []HostAlias `json:"hostAliases,omitempty"`
// Registry field contains configurations about local registry and remote registry.
Registry Registry `json:"registry,omitempty"`
// DataRoot set sealer rootfs directory path.
// if not set, default value is "/var/lib/sealer/data"
DataRoot string `json:"dataRoot,omitempty"`
}

type Host struct {
Expand Down Expand Up @@ -301,6 +304,34 @@ spec:
roles: [ node ]
```

#### Changing default rootfs data path in Clusterfile

When running a sealer image, sealer will mount the image content to rootfs data path. In some case, user want to change
this data path due to some reason, and then user could change default rootfs data path in Clusterfile via this
field `v2.cluster.spec.DataRoot`. if not set, sealer will use default rootfs data path `/var/lib/sealer/data` as default
data directory.

```yaml
apiVersion: sealer.io/v2
kind: Cluster
metadata:
name: my-cluster
spec:
dataRoot: /tmp/kaka
hosts:
- ips:
- 172.25.146.174
roles:
- master
ssh: { }
image: docker.io/sealerio/kubernetes:v1-22-15-sealerio-2
ssh:
passwd: xxxxx
pk: /root/.ssh/id_rsa
port: "22"
user: root
```

## Config API

Using config, you can overwrite or merge any config files you want. Like chart values, kubeadm config file ...
Expand Down
4 changes: 2 additions & 2 deletions src/docs/getting-started/install-sealer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ and installed.
1. Download sealer binary

```shell
wget https://github.com/sealerio/sealer/releases/download/v0.10.0/sealer-v0.10.0-linux-amd64.tar.gz
wget https://github.com/sealerio/sealer/releases/download/v0.11.0/sealer-v0.11.0-linux-amd64.tar.gz
```

2. Unpack it

```shell
tar zxvf sealer-v0.10.0-linux-amd64.tar.gz
tar zxvf sealer-v0.11.0-linux-amd64.tar.gz
```

3. Find the sealer binary in the unpacked directory, and move it to its desired destination
Expand Down
Loading
Loading