mirror of
https://github.com/kubesphere/website.git
synced 2025-12-26 00:12:48 +00:00
239 lines
11 KiB
Markdown
239 lines
11 KiB
Markdown
---
|
||
title: "代理连接"
|
||
keywords: 'Kubernetes, KubeSphere, 多集群, 代理连接'
|
||
description: '了解通过代理连接导入集群的一般步骤。'
|
||
linkTitle: "代理连接"
|
||
weight: 5220
|
||
---
|
||
|
||
KubeSphere 的组件 [Tower](https://github.com/kubesphere/tower) 用于代理连接。Tower 是一种通过代理在集群间建立网络连接的工具。如果 Host 集群（简称 H 集群）无法直接访问 Member 集群（简称 M 集群），您可以暴露 H 集群的代理服务地址，这样可以让 M 集群通过代理连接到 H 集群。当 M 集群部署在私有环境（例如 IDC）并且 H 集群可以暴露代理服务时，适用此连接方法。当您的集群分布部署在不同的云厂商上时，同样适用代理连接的方法。
|
||
|
||
要通过代理连接使用多集群功能，您必须拥有至少两个集群，分别用作 H 集群和 M 集群。您可以在安装 KubeSphere 之前或者之后将一个集群指定为 H 集群或 M 集群。有关安装 KubeSphere 的更多信息，请参考[在 Linux 上安装](../../../installing-on-linux/)和[在 Kubernetes 上安装](../../../installing-on-kubernetes/)。
|
||
|
||
## 准备 Host 集群
|
||
|
||
Host 集群为您提供中央控制平面，并且您只能指定一个 Host 集群。
|
||
|
||
{{< tabs >}}
|
||
|
||
{{< tab "已经安装 KubeSphere" >}}
|
||
|
||
如果已经安装了独立的 KubeSphere 集群，您可以编辑集群配置，将 `clusterRole` 的值设置为 `host`。
|
||
|
||
- 选项 A - 使用 Web 控制台：
|
||
|
||
使用 `admin` 帐户登录控制台，然后进入**集群管理**页面上的 **CRD**，输入关键字 `ClusterConfiguration`，然后转到其详情页面。编辑 `ks-installer` 的 YAML 文件，方法类似于[启用可插拔组件](../../../pluggable-components/)。
|
||
|
||
- 选项 B - 使用 Kubectl：
|
||
|
||
```shell
|
||
kubectl edit cc ks-installer -n kubesphere-system
|
||
```
|
||
|
||
在 `ks-installer` 的 YAML 文件中，搜寻到 `multicluster`，将 `clusterRole` 的值设置为 `host`，然后点击**更新**（如果使用 Web 控制台）使其生效：
|
||
|
||
```yaml
|
||
multicluster:
|
||
clusterRole: host
|
||
```
|
||
|
||
您需要**稍等片刻**待该更改生效。
|
||
|
||
{{</ tab >}}
|
||
|
||
{{< tab "尚未安装 KubeSphere" >}}
|
||
|
||
在 Linux 上或者在现有 Kubernetes 集群上安装 KubeSphere 之前，您可以定义一个 Host 集群。如果您想[在 Linux 上安装 KubeSphere](../../../installing-on-linux/introduction/multioverview/#1-创建示例配置文件)，需要使用 `config-sample.yaml` 文件。如果您想[在现有 Kubernetes 集群上安装 KubeSphere](../../../installing-on-kubernetes/introduction/overview/#部署-kubesphere)，需要使用两个 YAML 文件，其中一个是 `cluster-configuration.yaml`。要设置一个 Host 集群，请在安装 KubeSphere 之前，将 `config-sample.yaml` 或 `cluster-configuration.yaml` 文件中对应的 `clusterRole` 的值修改为 `host`。
|
||
|
||
```yaml
|
||
multicluster:
|
||
clusterRole: host
|
||
```
|
||
|
||
{{< notice note >}}
|
||
|
||
如果您在单节点集群上安装 KubeSphere ([All-in-One](../../../quick-start/all-in-one-on-linux/))，则不需要创建 `config-sample.yaml` 文件。这种情况下，您可以在安装 KubeSphere 之后设置 Host 集群。
|
||
|
||
{{</ notice >}}
|
||
|
||
{{</ tab >}}
|
||
|
||
{{</ tabs >}}
|
||
|
||
您可以使用 **kubectl** 来获取安装日志以验证状态。运行以下命令，稍等片刻，如果 Host 集群已准备就绪，您将看到成功的日志返回。
|
||
|
||
```bash
|
||
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
|
||
```
|
||
|
||
## 设置代理服务地址
|
||
|
||
安装 Host 集群后，将在 `kubesphere-system` 中创建一个名为 `tower` 的代理服务，其类型为 `LoadBalancer`。
|
||
|
||
{{< tabs >}}
|
||
|
||
{{< tab "集群中有可用的 LoadBalancer" >}}
|
||
|
||
如果集群中有可用的 LoadBalancer 插件，则可以看到 Tower 服务有相应的 `EXTERNAL-IP` 地址，该地址将由 KubeSphere 自动获取并配置代理服务地址，这意味着您可以跳过设置代理服务地址这一步。执行以下命令确认是否有 LoadBalancer 插件。
|
||
|
||
```bash
|
||
kubectl -n kubesphere-system get svc
|
||
```
|
||
|
||
命令输出结果可能如下所示：
|
||
|
||
```shell
|
||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
|
||
tower LoadBalancer 10.233.63.191 139.198.110.23 8080:30721/TCP 16h
|
||
```
|
||
|
||
{{< notice note >}}
|
||
|
||
一般来说，主流公有云厂商会提供 LoadBalancer 解决方案，并且负载均衡器可以自动分配外部 IP。如果您的集群运行在本地环境中，尤其是在**裸机环境**中，可以使用 [PorterLB](https://github.com/kubesphere/porter) 作为负载均衡器解决方案。
|
||
|
||
{{</ notice >}}
|
||
|
||
{{</ tab >}}
|
||
|
||
{{< tab "集群中没有可用的 LoadBalancer" >}}
|
||
|
||
1. 如果在 Tower 服务下没有显示相应的地址（`EXTERNAL-IP` 处于 `pending` 状态），则需要手动设置代理地址。例如，您有一个可用的公有 IP 地址 `139.198.120.120`，并且**此 IP 地址的端口** `8080` **被转发到集群的端口** `30721`。执行以下命令来检查服务。
|
||
|
||
```shell
|
||
kubectl -n kubesphere-system get svc
|
||
```
|
||
|
||
命令输出结果可能如下所示：
|
||
```
|
||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
|
||
tower LoadBalancer 10.233.63.191 <pending> 8080:30721/TCP 16h
|
||
```
|
||
|
||
2. 将 `proxyPublishAddress` 的值添加到 `ks-installer` 的配置文件中，并按如下所示输入公有 IP 地址（此处示例 `139.198.120.120`）和端口号。
|
||
|
||
- 选项 A - 使用 Web 控制台：
|
||
|
||
使用 `admin` 帐户登录控制台，然后进入**集群管理**页面上的 **CRD**，输入关键字 `ClusterConfiguration`，然后转到其详情页面。编辑 `ks-installer` 的 YAML 文件，方法类似于[启用可插拔组件](../../../pluggable-components/)。
|
||
|
||
- 选项 B - 使用 Kubectl：
|
||
|
||
```bash
|
||
kubectl -n kubesphere-system edit clusterconfiguration ks-installer
|
||
```
|
||
|
||
搜寻到 `multicluster` 并添加新行输入 `proxyPublishAddress` 来定义 IP 地址，以便访问 Tower。
|
||
|
||
```yaml
|
||
multicluster:
|
||
clusterRole: host
|
||
proxyPublishAddress: http://139.198.120.120:8080 # Add this line to set the address to access tower
|
||
```
|
||
|
||
3. 保存配置并稍等片刻，或者您可以运行以下命令手动重启 `ks-apiserver` 使修改立即生效。
|
||
|
||
```shell
|
||
kubectl -n kubesphere-system rollout restart deployment ks-apiserver
|
||
```
|
||
|
||
{{</ tab >}}
|
||
|
||
{{</ tabs >}}
|
||
|
||
## 准备 Member 集群
|
||
|
||
为了通过 **Host 集群**管理 Member 集群，您需要使它们之间的 `jwtSecret` 相同。因此，您首先需要在 **Host 集群**中执行以下命令来获取它。
|
||
|
||
```bash
|
||
kubectl -n kubesphere-system get cm kubesphere-config -o yaml | grep -v "apiVersion" | grep jwtSecret
|
||
```
|
||
|
||
命令输出结果可能如下所示：
|
||
|
||
```yaml
|
||
jwtSecret: "gfIwilcc0WjNGKJ5DLeksf2JKfcLgTZU"
|
||
```
|
||
|
||
{{< tabs >}}
|
||
|
||
{{< tab "已经安装 KubeSphere" >}}
|
||
|
||
如果已经安装了独立的 KubeSphere 集群，您可以编辑集群配置，将 `clusterRole` 的值设置为 `member`。
|
||
|
||
- 选项 A - 使用 Web 控制台：
|
||
|
||
使用 `admin` 帐户登录控制台，然后进入**集群管理**页面上的 **CRD**，输入关键字 `ClusterConfiguration`，然后转到其详情页面。编辑 `ks-installer` 的 YAML 文件，方法类似于[启用可插拔组件](../../../pluggable-components/)。
|
||
|
||
- 选项 B - 使用 Kubectl：
|
||
|
||
```shell
|
||
kubectl edit cc ks-installer -n kubesphere-system
|
||
```
|
||
|
||
在 `ks-installer` 的 YAML 文件中对应输入上面所示的 `jwtSecret`：
|
||
|
||
```yaml
|
||
authentication:
|
||
jwtSecret: gfIwilcc0WjNGKJ5DLeksf2JKfcLgTZU
|
||
```
|
||
|
||
向下滚动并将 `clusterRole` 的值设置为 `member`，然后点击**更新**（如果使用 Web 控制台）使其生效：
|
||
|
||
```yaml
|
||
multicluster:
|
||
clusterRole: member
|
||
```
|
||
|
||
您需要**稍等片刻**待该更改生效。
|
||
|
||
{{</ tab >}}
|
||
|
||
{{< tab "尚未安装 KubeSphere" >}}
|
||
|
||
在 Linux 上或者在现有 Kubernetes 集群上安装 KubeSphere 之前，您可以定义 Member 集群。如果您想[在 Linux 上安装 KubeSphere](../../../installing-on-linux/introduction/multioverview/#1-创建示例配置文件)，需要使用 `config-sample.yaml` 文件。如果您想[在现有 Kubernetes 集群上安装 KubeSphere](../../../installing-on-kubernetes/introduction/overview/#部署-kubesphere)，需要使用两个 YAML 文件，其中一个是 `cluster-configuration.yaml`。要设置 Member 集群，请在安装 KubeSphere 之前，在 `config-sample.yaml` 或 `cluster-configuration.yaml` 文件中输入上方 `jwtSecret` 所对应的值，并将 `clusterRole` 的值修改为 `member`。
|
||
|
||
```yaml
|
||
authentication:
|
||
jwtSecret: gfIwilcc0WjNGKJ5DLeksf2JKfcLgTZU
|
||
```
|
||
|
||
```yaml
|
||
multicluster:
|
||
clusterRole: member
|
||
```
|
||
|
||
{{< notice note >}}
|
||
|
||
如果您在单节点集群上安装 KubeSphere ([All-in-One](../../../quick-start/all-in-one-on-linux/))，则不需要创建 `config-sample.yaml` 文件。这种情况下，您可以在安装 KubeSphere 之后设置 Member 集群。
|
||
|
||
{{</ notice >}}
|
||
|
||
{{</ tab >}}
|
||
|
||
{{</ tabs >}}
|
||
|
||
您可以使用 **kubectl** 来获取安装日志以验证状态。运行以下命令，稍等片刻，如果 Member 集群已准备就绪，您将看到成功的日志返回。
|
||
|
||
```bash
|
||
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
|
||
```
|
||
|
||
## 导入 Member 集群
|
||
|
||
1. 以 `admin` 身份登录 KubeSphere 控制台，转到**集群管理**页面点击**添加集群**。
|
||
|
||
|
||
|
||
2. 在**导入集群**页面输入要导入的集群的基本信息。您也可以点击右上角的**编辑模式**以 YAML 格式查看并编辑基本信息。编辑完成后，点击**下一步**。
|
||
|
||
|
||
|
||
3. 在**连接方式**，选择**集群连接代理**，然后点击**创建**。H 集群为代理部署 (Deployment) 生成的 YAML 配置文件会显示在控制台上。
|
||
|
||
|
||
|
||
4. 根据指示在 M 集群中创建一个 `agent.yaml` 文件，然后将代理部署复制并粘贴到该文件中。在该节点上执行 `kubectl create -f agent.yaml` 然后等待代理启动并运行。请确保 M 集群可以访问代理地址。
|
||
|
||
5. 待集群代理启动并运行，您会看到 M 集群已经导入 H 集群。
|
||
|
||
|