Weave Scope

本节将以 Weave Scope 集成为例,介绍如何快速将已有 Web UI 的第三方工具和系统通过 iframe 整合到扩展组件中。

Weave Scope 可以自动生成应用程序的映射,以便您直观地理解、监视和控制基于容器化微服务的应用程序。

部署 Weave Scope

参考文档部署 Weave Scope,或通过以下命令在 K8s 集群中一键部署 Weave Scope。

kubectl apply -f https://raw.githubusercontent.com/kubesphere/extension-samples/master/extensions-backend/weave-scope/manifests.yaml

为 Weave Scope 创建反向代理

kubectl apply -f https://raw.githubusercontent.com/kubesphere/extension-samples/master/extensions-backend/weave-scope/weave-scope-reverse-proxy.yaml

前端扩展组件开发

从 GitHub 上克隆本示例的代码,然后参照创建 Hello World 扩展组件进行创建项目、本地开发和调试。

cd  ~/kubesphere-extensions
git clone https://github.com/kubesphere/extension-samples.git
cp -r ~/kubesphere-extensions/extension-samples/extensions-frontend/extensions/weave-scope ~/kubesphere-extensions/ks-console/extensions

接下来,将重点介绍如何将 Weave Scope 的页面集成到扩展组件。

文件路径: ~/kubesphere-extensions/ks-console/extensions/weave-scope/src/App.jsx

import React, { useState, useRef } from 'react';
import { Loading } from '@kubed/components';
import { useLocalStorage } from '@kubed/hooks';

export default function App() {
  const [loading, setLoading] = useState(true);

  const FRAME_URL = '/proxy/weave.works/#!/state/{"topologyId":"pods"}';

  const iframeRef = useRef();

  const onIframeLoad = () => {
    const iframeDom = iframeRef.current?.contentWindow.document;
    if (iframeDom) {
      if (iframeDom.querySelector('#app > div > div.header > div')) {
        iframeDom.querySelector('#app > div > div.header > div').style.display = 'none';
      }
    }
    setLoading(false);
  };

  return (
    <>
      {loading && <Loading className="page-loading" />}
      <iframe
        ref={iframeRef}
        src={FRAME_URL}
        width="100%"
        height="100%"
        frameBorder="0"
        style={{
          height: 'calc(100vh - 68px)',
          display: loading ? 'none' : 'block',
        }}
        onLoad={onIframeLoad}
      />
    </>
  );
}

以上代码主要完成了以下两个任务:

  1. 将 Weave Scope 页面以 iframe 的形式嵌入到扩展组件中。FRAME_URL 为 Weave Scope 的反向代理地址,且与 KubeSphere 页面地址同源

由于浏览器的同源策略(Same-Origin Policy),如果第三方系统网页与 KubeSphere 前端网页不同源,将无法使用 JavaScript 直接读取和操作第三方系统的 iframe。通常,需要由后端将第三方系统的前端访问地址处理成与 KubeSphere 前端访问地址同源(同协议同主机同端口)的地址。

2. 调整 Weave Scope 页面的样式。由于同源,扩展组件可以通过 Reactref 读取和操作 Weave Scope 页面(iframe)的 DOM,从而调整页面的样式,将 selector 部分隐藏。

通过 yarn dev 启动本地预览环境,然后通过扩展组件入口访问到以下页面。

weave-scope-dashboard