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.

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

Docs: fix typo for sync_docs workflow #4057

Merged
merged 2 commits into from
Oct 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .github/sync_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ fanux/sealos-site:
- source: docs/4.0/i18n/zh-Hans/
dest: i18n/zh-Hans/docusaurus-plugin-content-docs/current/
deleteOrphaned: true
- source: docs/4.0/i18n/zh-Hans/current.json
dest: i18n/zh-Hans/docusaurus-plugin-content-docs/current.json
- source: docs/4.0/img/
dest: static/docs/4.0/img/
deleteOrphaned: true
Expand Down
2 changes: 1 addition & 1 deletion deploy/cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Other dns api please read: https://github.com/acmesh-official/acme.sh/wiki/dnsap
We provide a self-signed cert for you to test by default if you didn't provide a cert. You can replace it with your own cert.

### Kubernetes Setup
Please read sealos doc to create a kubernetes cluster: https://sealos.io/docs/lifecycle-management/quick-start/installation
Please read sealos doc to create a kubernetes cluster: https://sealos.io/docs/self-hosting/lifecycle-management/quick-start/deploy-kubernetes

```shell
sealos gen labring/kubernetes:v1.25.6\
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ $ sealos run labring/redis-operator:3.1.4

For cluster images not available in the Sealos ecosystem, users can easily build and customize their own cluster images. For example:

[Building an Ingress Cluster Image](https://docs.sealos.io/docs/lifecycle-management/quick-start/build-ingress-cluster-image)
[Building an Ingress Cluster Image](/self-hosting/lifecycle-management/quick-start/build-ingress-cluster-image.md)

You can also customize your own Kubernetes cluster:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,6 @@ sealos apply -f Clusterfile --values values.yaml

This command will apply the `Clusterfile` based on the values in the `values.yaml` file.

**For more examples, please refer to the [Run Cluster](https://docs.sealos.io/docs/lifecycle-management/operations/run-cluster/) section.**
**For more examples, please refer to the [Run Cluster](/self-hosting/lifecycle-management/operations/run-cluster/.md) section.**

That's it for the usage guide of the `sealos apply` command. We hope this helps you. If you have any questions or encounter any issues during the process, feel free to ask us.
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ Overall, the `--save-image` option provides a convenient way for Sealos to handl

Here are some detailed examples:

- [Build with Image Manifests](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-image_list)
- [Build with Deploy Manifests](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-manifests)
- [Build with Helm Charts](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-helm_charts)
- [Build with Binary](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-binary)
- [Build with go-template](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-go_template)
- [Build with exec and scp](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-scp_exec)
- [Build with Image Manifests](/self-hosting/lifecycle-management/operations/build-image/build-image-image_list.md)
- [Build with Deploy Manifests](/self-hosting/lifecycle-management/operations/build-image/build-image-manifests.md)
- [Build with Helm Charts](/self-hosting/lifecycle-management/operations/build-image/build-image-helm_charts.md)
- [Build with Binary](/self-hosting/lifecycle-management/operations/build-image/build-image-binary.md)
- [Build with go-template](/self-hosting/lifecycle-management/operations/build-image/build-image-go_template.md)
- [Build with exec and scp](/self-hosting/lifecycle-management/operations/build-image/build-image-scp_exec.md)

With the `build` command in Sealos, you can build OCI images based on various instruction files to provide the required images for Sealos. This process includes handling various instructions in Dockerfiles or other instruction files, such as `FROM`, `RUN`, `ADD`, etc., as well as managing image layers, labels, and more. The build process also involves pulling base images, running commands, saving the results, and more. Each step can be finely controlled and customized using the options mentioned above to accommodate different build requirements.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ sidebar_position: 0

The `--debug` flag in Sealos is a global flag used to enable debug mode for more detailed information about the system's operation when issues occur.

For installation instructions, please refer to the [Sealos Installation Guide](https://docs.sealos.io/docs/lifecycle-management/quick-start/installation); for a quick start guide, please refer to the [Quick Start Guide](https://docs.sealos.io/docs/lifecycle-management/quick-start/).
For installation instructions, please refer to the [Sealos Installation Guide](/self-hosting/lifecycle-management/quick-start/installation); for a quick start guide, please refer to the [Quick Start Guide](/self-hosting/lifecycle-management/quick-start/.md).
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ After the Clusterfile is generated, users can modify this file according to thei

Example explanations:

- [Custom Configuration Installation](https://docs.sealos.io/docs/lifecycle-management/operations/run-cluster/gen-apply-cluster)
- [Custom Configuration Installation](/self-hosting/lifecycle-management/operations/run-cluster/gen-apply-cluster.md)

That's the usage guide for the `sealos gen` command, and we hope it has been helpful. If you encounter any problems during usage, feel free to ask us.
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Here are some of the major `manifest` subcommands:

With the `sealos manifest` command, you can flexibly manage manifest lists or image indexes, providing support for multi-architecture Docker or OCI images. Users can create custom manifest lists according to their needs, making it convenient to deploy and run Docker images on different hardware architectures.

Users who want to build multi-architecture images through the manifest command can refer to the document [Building Cluster Images that Support Multiple Architectures](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-multi-arch-image).
Users who want to build multi-architecture images through the manifest command can refer to the document [Building Cluster Images that Support Multiple Architectures](/self-hosting/lifecycle-management/operations/build-image/build-multi-arch-image.md).
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ sealos run -e DashBoardPort=8443 mydashboard:latest --masters 192.168.0.2,192.1

These examples demonstrate the power and flexibility of the `sealos run` command, which can be customized and adjusted according to your needs.

For more examples, please refer to [Run Cluster](https://docs.sealos.io/docs/lifecycle-management/operations/run-cluster).
For more examples, please refer to [Run Cluster](/self-hosting/lifecycle-management/operations/run-cluster.md).
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Sealos is a unified cloud operating system designed to manage cloud-native appli

This chapter provides a user guide for using Sealos, as well as information related to cluster images.

- Sealos User Guide: For detailed information about each command, including all supported parameters and subcommands, please refer to the [sealos](https://docs.sealos.io/docs/lifecycle-management/reference/sealos/commands) reference documentation.
- Sealos User Guide: For detailed information about each command, including all supported parameters and subcommands, please refer to the [sealos](/self-hosting/lifecycle-management/reference/sealos/commands.md) reference documentation.
- Cluster Images:
- [Rootfs Cluster Images](https://docs.sealos.io/docs/lifecycle-management/reference/sealos/kubernetes-cluster-image)
- [Application Cluster Images](https://docs.sealos.io/docs/lifecycle-management/reference/sealos/app-cluster-image)
- [Rootfs Cluster Images](/self-hosting/lifecycle-management/reference/sealos/kubernetes-cluster-image.md)
- [Application Cluster Images](/self-hosting/lifecycle-management/reference/sealos/app-cluster-image.md)
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ $ sealos run labring/redis-operator:3.1.4

对于 Sealos 生态没有的集群镜像,用户可以方便地自己构建和定制属于自己的集群镜像。例如:

[构建一个 ingress 集群镜像](https://docs.sealos.io/docs/lifecycle-management/quick-start/build-ingress-cluster-image)
[构建一个 ingress 集群镜像](/self-hosting/lifecycle-management/quick-start/build-ingress-cluster-image.md)

您还可以定制一个完全属于自己的 Kubernetes:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,6 @@ sealos apply -f Clusterfile --values values.yaml

这条命令会根据 `values.yaml` 文件中的值应用 `Clusterfile`。

**更多示例请参考[启动镜像](https://docs.sealos.io/docs/lifecycle-management/operations/run-cluster/)**
**更多示例请参考[启动镜像](/self-hosting/lifecycle-management/operations/run-cluster/)**

以上就是 `sealos apply` 命令的使用指南,希望对你有所帮助。如果你在使用过程中遇到任何问题,欢迎向我们提问。
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ sealos build -t myapp:v1.0.0 -f Dockerfile .

下面有一些详细的示例:

- [基于镜像清单构建](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-image_list)
- [基于部署清单构建](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-manifests)
- [基于helm-charts构建](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-helm_charts)
- [基于二进制构建](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-binary)
- [基于go-template构建](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-go_template)
- [基于exec和scp构建](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-image-scp_exec)
- [基于镜像清单构建](/self-hosting/lifecycle-management/operations/build-image/build-image-image_list.md)
- [基于部署清单构建](/self-hosting/lifecycle-management/operations/build-image/build-image-manifests.md)
- [基于helm-charts构建](/self-hosting/lifecycle-management/operations/build-image/build-image-helm_charts.md)
- [基于二进制构建](/self-hosting/lifecycle-management/operations/build-image/build-image-binary.md)
- [基于go-template构建](/self-hosting/lifecycle-management/operations/build-image/build-image-go_template.md)
- [基于exec和scp构建](/self-hosting/lifecycle-management/operations/build-image/build-image-scp_exec.md)

通过 Sealos `build` 命令,可以基于多种指令文件构建 OCI 镜像,为sealos提供所需的镜像。这个过程包括处理 Dockerfile 或其他指令文件中的各种指令,如 `FROM`、`RUN`、`ADD` 等,以及处理镜像层次、镜像标签等。构建过程也包括拉取基础镜像、运行命令、保存结果等步骤。每一个步骤都可以通过上述的选项进行详细的控制和定制,以满足不同的构建需求。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ sidebar_position: 0

Sealos 的 `--debug` 参数是一个全局参数,用于开启调试模式,以便在出现问题时能更详细地了解系统的运行情况。

有关安装说明,请参见[安装 sealos](https://docs.sealos.io/docs/lifecycle-management/quick-start/installation); 如需快速指南,请参见[快速开始](https://docs.sealos.io/docs/lifecycle-management/quick-start/)。
有关安装说明,请参见[下载 Sealos 命令行工具](/self-hosting/lifecycle-management/quick-start/install-cli.md); 如需安装 Kubernetes 集群,请参见[安装 Kubernetes 集群](/self-hosting/lifecycle-management/quick-start/deploy-kubernetes.md)。
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ Sealos 的 `gen` 命令是用于生成 Kubernetes 集群的配置文件(Cluste

示例说明:

- [自定义配置安装](https://docs.sealos.io/docs/lifecycle-management/operations/run-cluster/gen-apply-cluster)
- [自定义配置安装](/self-hosting/lifecycle-management/operations/run-cluster/gen-apply-cluster.md)

以上就是 `sealos gen` 命令的使用指南,希望对你有所帮助。如果你在使用过程中遇到任何问题,欢迎向我们提问。
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Sealos 的 `manifest` 命令用于创建、修改和推送 manifest 列表和镜

通过 `sealos manifest` 命令,可以灵活地管理 manifest 列表或镜像索引,为多架构的 Docker 或 OCI 镜像提供支持。用户可以根据自己的需求,创建自定义的 manifest 列表,方便在不同的硬件架构上部署和运行 Docker 镜像。

用户如果想通过manifest命令构建多架构镜像,可以参考文档[构建支持多架构的集群镜像](https://docs.sealos.io/docs/lifecycle-management/operations/build-image/build-multi-arch-image)
用户如果想通过manifest命令构建多架构镜像,可以参考文档[构建支持多架构的集群镜像](/self-hosting/lifecycle-management/operations/build-image/build-multi-arch-image.md)
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ sealos run -e DashBoardPort=8443 mydashboard:latest --masters 192.168.0.2,192.1

这些示例展示了 `sealos run` 命令的强大和灵活性,可以根据您的需求进行定制和调整。

更多示例请参考 [运行集群](https://docs.sealos.io/docs/lifecycle-management/operations/run-cluster)。
更多示例请参考 [运行集群](/self-hosting/lifecycle-management/operations/run-cluster.md)。
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Sealos 是一个统一的云操作系统,用于管理云原生应用。它提

本章节主要介绍 Sealos 的使用指南以及集群镜像相关说明。

- Sealos使用指南: 有关每个命令的详细信息,包括所有受支持的参数和子命令, 请参阅 [sealos](https://docs.sealos.io/docs/lifecycle-management/reference/sealos/commands) 参考文档。
- Sealos使用指南: 有关每个命令的详细信息,包括所有受支持的参数和子命令, 请参阅 [sealos](/self-hosting/lifecycle-management/reference/sealos/commands.md) 参考文档。
- 集群镜像:
- [Rootfs集群镜像](https://docs.sealos.io/docs/lifecycle-management/reference/sealos/kubernetes-cluster-image)
- [Application集群镜像](https://docs.sealos.io/docs/lifecycle-management/reference/sealos/app-cluster-image)
- [Rootfs集群镜像](/self-hosting/lifecycle-management/reference/sealos/kubernetes-cluster-image.md)
- [Application集群镜像](/self-hosting/lifecycle-management/reference/sealos/app-cluster-image.md)


2 changes: 1 addition & 1 deletion docs/blog/2022/06/30/sealos-is-unique.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ tags: [kubernetes,sealos]
- sealos 内嵌一个私有镜像仓库来存放集群中所有需要用到的 docker 镜像,helm 并没有.

Best Practise: 最佳实践是配合 helm 与 sealos 使用,用 helm 编排 用 sealos 打包整个集群, 和应用所有的依赖.
Example: [Building an ingress cluster images](https://github.com/labring/sealos/blob/main/docs/4.0/docs/lifecycle-management/quick-start/build-ingress-cluster-image.md)
Example: [Building an ingress cluster images](/docs/self-hosting/lifecycle-management/quick-start/build-ingress-cluster-image.md)

## sealos 与 kubeadm

Expand Down
Loading