diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/chrome-certificate-1.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/chrome-certificate-1.jpg new file mode 100644 index 00000000000..680d572141b Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/chrome-certificate-1.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/chrome-certificate-2.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/chrome-certificate-2.jpg new file mode 100644 index 00000000000..8b6a354702c Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/chrome-certificate-2.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-1.png b/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-1.png new file mode 100644 index 00000000000..6e2c46692cf Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-1.png differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-2.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-2.jpg new file mode 100644 index 00000000000..a99aaeaf5a0 Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-2.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-3.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-3.jpg new file mode 100644 index 00000000000..8a42e6c08c8 Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/firefox-export-certificate-3.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-1.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-1.jpg new file mode 100644 index 00000000000..3a211ccd3e1 Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-1.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-2.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-2.jpg new file mode 100644 index 00000000000..357d5880dbe Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-2.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-3.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-3.jpg new file mode 100644 index 00000000000..9c33c03204f Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/safari-export-certificate-3.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/images/windows-trust-certificate.jpg b/docs/4.0/i18n/zh-Hans/self-hosting/images/windows-trust-certificate.jpg new file mode 100644 index 00000000000..243d0d2d558 Binary files /dev/null and b/docs/4.0/i18n/zh-Hans/self-hosting/images/windows-trust-certificate.jpg differ diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/installation.md b/docs/4.0/i18n/zh-Hans/self-hosting/installation.md index ea98d41c76c..a76309f1b1c 100644 --- a/docs/4.0/i18n/zh-Hans/self-hosting/installation.md +++ b/docs/4.0/i18n/zh-Hans/self-hosting/installation.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +toc_max_heading_level: 5 --- # 安装 Sealos 集群 @@ -8,40 +9,291 @@ sidebar_position: 1 ### 服务器 -奇数台的master服务器及任意的node服务器，推荐使用ubuntu 22.04 LTS linux发行版，操作系统内核在5.4以上； +以下是一些基本的要求： -配置推荐4c8g，存储100g以上，i.e. 最少一台的服务器配置如下： +- 每个集群节点应该有不同的主机名。**主机名不要带下划线，也不要大写**。 +- 所有节点的时间需要同步。 +- 建议使用干净的操作系统来创建集群。**不要自己装 Docker！** +- 支持大多数 Linux 发行版，例如：Ubuntu、CentOS、Rocky linux。 +- 支持 [Docker Hub](https://hub.docker.com/r/labring/kubernetes/tags) 中的所有 Kubernetes 版本。 -| | cpu | memory | disk | -|-----------|-----|--------|------| -| recommend | 4 | 8G | 100G | -| minimum | 2 | 4G | 60G | +推荐配置： + +| 操作系统 | 内核版本 | CPU | 内存 | 存储 | Master 节点数量 | Node 节点数量 | +| ---------------- | -------- | ---- | ---- | ----- | --------------- | ------------- | +| Ubuntu 22.04 LTS | ≥ 5.4 | 4C | 8GB | 100GB | 奇数台 | 任意 | ### 网络 -服务器之间的网络互通，其中`master0`（执行sealos cli的master节点）可以通过ssh免密登陆到其他节点；所有节点间可以互相通信。 ++ 所有节点之间网络互通； ++ 需要在 Kubernetes 集群的**第一个 Master 节点**上执行脚本，目前**集群外的节点不支持集群安装**； ++ 所有节点之间可以互相通信。 ### 域名 -你需要一个域名，用于访问 Sealos 及你将部署的各种服务。如果您没有域名，可以使用`nip.io`提供的免费域名服务。 ++ 需要一个域名用于访问 Sealos 及相关服务； ++ 如果您没有域名，可以使用 `nip.io` 提供的免费域名服务。 ### 证书 Sealos 需要使用证书来保证通信安全，默认在您不提供证书的情况下我们会使用 [cert-manager](https://cert-manager.io/docs/) 来自动签发证书。 -如果您能提供证书，证书需要解析下列域名（假设您提供的域名为：cloud.example.io）： +如果您能提供证书，证书需要解析下列域名 (假设您提供的域名为：cloud.example.io)： + - `*.cloud.example.io` - `cloud.example.io` ## 安装步骤 -执行命令，并根据提示输入参数： +为了便于部署，我们提供了一个一键安装脚本。该脚本可以从零开始部署 Sealos 集群，也可以在已有的 Kubernetes 集群上部署 Sealos 集群。 + +:::info注意 + +该脚本只支持在 “使用 Sealos 安装的 Kubernetes 集群” 上部署 Sealos 集群，暂不支持其他方式部署的 Kubernetes。 + +关于如何使用 Sealos 部署 Kubernetes 集群，可以参考：[安装 Kubernetes 集群](/self-hosting/lifecycle-management/quick-start/deploy-kubernetes.md) + +::: + +如果您的机器还没有安装过 Kubernetes，**建议直接使用该脚本连同 Kubernetes 和 Sealos 集群一起安装。** + +根据您的域名情况，可以分为以下几种安装方式： + +### 1、无公网域名，也不想自定义域名 + +如果您没有公网域名，也不需要自定义域名，可以选择直接使用 `nip.io` 提供的免费域名服务。`nip.io` 是一个免费的通配符 DNS 服务，它可以将动态分配的 IP 地址映射到一个固定的子域名上，特别适合用于本地开发环境。具体的工作原理为： + +您可以使用任何 IP 地址作为 `nip.io` 子域名的一部分，而 `nip.io` 会将它解析回相应的 IP 地址。例如，如果你有一个内网 IP 地址 `192.168.1.10`，你可以使用 `192.168.1.10.nip.io` 作为域名，所有向这个域名发送的请求都会被解析到 `192.168.1.10` 这个 IP 地址上。这样就无需修改本地 hosts 文件，也不需要搭建内网 DNS 服务，直接通过这个域名就能访问内网服务了。 + +使用 nip.io 作为 Sealos 的域名非常简单，只需在第一个 Master 节点上执行以下命令，并根据提示输入参数： ```bash -curl -sfL https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/install.sh -o /tmp/install.sh && bash /tmp/install.sh +$ curl -sfL https://gh-proxy.com/https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/install.sh -o /tmp/install.sh && bash /tmp/install.sh \ + --image-registry=registry.cn-shanghai.aliyuncs.com --zh \ + --proxy-prefix=https://gh-proxy.com +``` + +当需要你输入 Sealos Cloud 域名时，你需要输入这种格式的域名：`[ip].nip.io`，其中 [ip] 是你的 Master 节点 IP。 + +安装完成后，终端会输出 Sealos 访问域名以及用户名和密码，例如： + +```bash +Sealos cloud login info: +Cloud Version: latest +URL: https://10.214.210.102.nip.io +admin Username: admin +admin Password: sealos2023 +``` + +### 2、有公网域名，想公网访问 + +如果你有自己的公网域名，并且想通过公网访问 Sealos，那你就需要准备好公网受信任的 SSL/TLS 证书。你可以通过 acme.sh 等工具自动签发证书，也可以从域名提供商处下载免费证书或者购买商业证书。 + +准备好域名证书后，需要将证书放到第一个 Master 节点的某个目录中，例如 `/root/certs/`。 + +:::info注意 + +您还需要在域名服务商处添加一条该域名的 A 记录，地址解析到第一个 Master 节点的公网 IP 地址。同时还需要添加一条泛解析记录，将该域名的子域名也解析到第一个 Master 节点的内网 IP 地址。 + +例如 (假设你的域名是 `cloud.example.io`，假设你的 Master 节点内网地址是 `192.168.1.10`)： + +```bash +cloud.example.io A 192.168.1.1 +*.cloud.example.io A 192.168.1.1 +``` + +::: + +然后在第一个 Master 节点上执行以下命令，并根据提示输入参数： + +```bash +$ curl -sfL https://gh-proxy.com/https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/install.sh -o /tmp/install.sh && bash /tmp/install.sh \ + --image-registry=registry.cn-shanghai.aliyuncs.com --zh \ + --proxy-prefix=https://gh-proxy.com \ + --cloud_domain= \ + --cert_path= \ + --key_path= +``` + ++ 需要替换成你自己的公网域名。 ++ 需要替换成你的证书位置，通常是 `.crt` 或 `.pem` 文件。例如：`/root/certs/example.crt`。 ++ 需要替换成你的私钥位置，通常是 `.key` 或 `.pem` 文件。例如：`/root/certs/example.key`。 + +### 3、有公网域名，想内网访问 + +如果您有自己的公网域名，但是只有内网 IP，或者只想在内网访问 Sealos，那您只需要在域名服务商处添加一条该域名的 A 记录，地址解析到第一个 Master 节点的内网 IP 地址。同时还需要添加一条泛解析记录，将该域名的子域名也解析到第一个 Master 节点的内网 IP 地址。 + +例如 (假设你的域名是 `cloud.example.io`，假设你的 Master 节点内网地址是 `192.168.1.10`)： + +```bash +cloud.example.io A 192.168.1.1 +*.cloud.example.io A 192.168.1.1 ``` -默认的用户名密码： +然后在第一个 Master 节点上执行以下命令，并根据提示输入参数： + +```bash +$ curl -sfL https://gh-proxy.com/https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/install.sh -o /tmp/install.sh && bash /tmp/install.sh \ + --image-registry=registry.cn-shanghai.aliyuncs.com --zh \ + --proxy-prefix=https://gh-proxy.com \ + --cloud_domain= +``` + +其中 需要替换成你自己的公网域名。 + +安装过程中 Sealos 会使用 [cert-manager](https://cert-manager.io/docs/) 来自签名证书。 + +### 4、无公网域名，但想自定义域名 + +如果您没有公网域名，但是需要自定义域名，那么就需要在内网自建 DNS，然后将自定义域名解析到第一个 Master 节点的内网 IP 地址。 + +:::note + +假设您的第一个 Master 节点的内网 IP 地址为 `192.168.1.10`。假设您的域名为 `cloud.example.io`。 + +::: + +可以考虑使用 CoreDNS 来自建 DNS 服务，参考配置： + +```nginx +(global_cache) { + cache { + # [5, 60] + success 65536 3600 300 + # [1, 10] + denial 8192 600 60 + prefetch 1 60m 10% + } +} + +.:53 { + errors + health + ready + + import global_cache + + template IN A cloud.example.io { + answer "{{ .Name }} 60 IN A 192.168.1.10" + fallthrough + } + + forward . 223.5.5.5 + + log + loop + reload 6s +} +``` + +这样不管您访问 `cloud.example.io` 还是 `*.cloud.example.io` 都会解析到第一个 Master 节点的内网 IP 地址。 + +然后在第一个 Master 节点上执行以下命令，并根据提示输入参数： + +```bash +$ curl -sfL https://gh-proxy.com/https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/install.sh -o /tmp/install.sh && bash /tmp/install.sh \ + --image-registry=registry.cn-shanghai.aliyuncs.com --zh \ + --proxy-prefix=https://gh-proxy.com \ + --cloud_domain= +``` + +其中 需要替换成你自己的自定义域名。 + +安装过程中 Sealos 会使用 [cert-manager](https://cert-manager.io/docs/) 来自签名证书。 + +## 信任自签名证书 + +如果您选择了上面提供的安装方式中的 1 或 3 或 4，那么您的证书默认是不受浏览器信任的，当你访问 Sealos Cloud 时，浏览器会提示下面的信息： + +![](./images/chrome-certificate-1.jpg) + +即使点击继续访问，进入 Sealos Cloud 之后也无法正常显示 App 图标，无法打开 App。 + +![](./images/chrome-certificate-2.jpg) + +我们需要导出自签名证书，并让系统信任自签名证书。步骤如下。 + +### 导出自签名证书 + +各个浏览器导出自签名证书的步骤略有不同。以下是在一些常用浏览器中导出自签名证书的步骤： + +#### Chrome (以及基于 Chromium 的浏览器如新版 Edge 和 Brave) + +1. 在浏览器地址栏左侧点击 “不安全” 字样。 +2. 点击 “证书无效”，这将打开一个证书信息窗口。 +3. 在打开的证书窗口中，切换到 “详细信息” 标签页。 +4. 在 “详细信息” 标签页中，找到并点击 “导出”。 +5. 选择一个文件名和保存位置，然后完成导出过程。 + +#### Firefox + +1. 点击页面中的 “高级”。 + + ![](./images/firefox-export-certificate-1.png) + +2. 然后点击 “查看证书”。 + + ![](./images/firefox-export-certificate-2.jpg) + +3. 在证书页面中点击 “PEM (证书)”。 + + ![](./images/firefox-export-certificate-3.jpg) + +#### Safari + +1. 点击页面中的 “显示详细信息”。 + + ![](./images/safari-export-certificate-1.jpg) + +2. 然后点击 “查看此证书”。 + + ![](./images/safari-export-certificate-2.jpg) + +3. 在证书视图中，可以看到一个带有证书链的窗口。 + + ![](./images/safari-export-certificate-3.jpg) + +4. 拖动红框圈出来的证书到桌面或文件夹中，证书就会被导出了。 + +### 信任自签名证书 + +#### macOS + +在 macOS 上信任自签名证书可以使用以下命令： + +```bash +# 假设证书保存在 ~/Downloads/10.214.210.102.nip.io.cer +$ sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain ~/Downloads/10.214.210.102.nip.io.cer +``` + +您也可以通过以下步骤来操作： + +##### 1、添加证书到钥匙串 + +1. 启动**钥匙串访问** (Keychain Access) 应用程序，点击左侧 “系统钥匙串” 下方的 “系统” 类别。 +2. 然后打开 “访达”，进入证书保存位置，**双击证书文件**：这通常是一个 `.cer`，`.crt`，或 `.pem` 文件。 +3. 输入您的用户名和密码以允许修改。 +4. 证书现在应该已经被添加到您的钥匙串中。 + +##### 2、信任证书 + +1. 在钥匙串访问中，从 “系统” 类别的列表中找到刚刚添加的自签名证书，并双击它。 +2. 在打开的窗口中，展开 “信任” 部分。 +3. 在 “当使用此证书时” 选项旁边，有一个下拉菜单，默认设置可能是 “使用系统默认值”。要信任证书，请改为 “始终信任”。 +4. 关闭证书信息窗口，系统可能会提示您验证您的用户名和密码，以确认更改。 +5. 现在，证书已经被标记为受信任。 + +:::info注意 + +自签名证书不由第三方证书颁发机构 (CA) 颁发，因此，其他设备也不会信任该证书。如果您是在公司或组织内部使用自签名证书，可能需要在每个需要信任此证书的设备上手动进行上述步骤。 + +::: + +#### Windows + +1. 在根证书文件点鼠标右键，选择 “安装证书”。 +2. 选择 “当前用户” 或者 “本地计算机”，下一步 +3. “将所有的证书都放入下列存储”，“浏览”，“受信任的根证书颁发机构”，“确定”，下一步。 +4. 完成，“是”，确定。 -+ 用户名：`admin` -+ 密码：`sealos2023` \ No newline at end of file +![](./images/windows-trust-certificate.jpg) \ No newline at end of file diff --git a/docs/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json b/docs/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json index 1e089993542..30f093328e2 100644 --- a/docs/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json +++ b/docs/website/i18n/zh-Hans/docusaurus-theme-classic/footer.json @@ -95,4 +95,4 @@ "message": "咨询合作", "description": "The label of footer link with label=Contact US linking to https://fael3z0zfze.feishu.cn/share/base/form/shrcnesSfEK65JZaAf2W6Fwz6Ad" } -} \ No newline at end of file +} diff --git a/docs/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json b/docs/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json index a7bb7fd772f..5681635dbcc 100644 --- a/docs/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json +++ b/docs/website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json @@ -9,7 +9,7 @@ }, "item.label.Pricing": { "message": "价格", - "description": "Navbar item with label Contact" + "description": "Navbar item with label Pricing" }, "logo.alt": { "message": "sealos", @@ -19,4 +19,4 @@ "message": "在线使用", "description": "Navbar item with label Start Now" } -} \ No newline at end of file +}