Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
23fb986
:arrow_up: Bump moment from 2.29.3 to 2.29.4 in /web
dependabot[bot] Jul 7, 2022
582f540
Merge pull request #29 from nickcdon/dependabot/npm_and_yarn/web/mome…
nickcdon Jul 7, 2022
95b706a
Merge remote-tracking branch 'upstream/main'
Jul 13, 2022
f6cbef8
Merge branch 'main' of github.com:Faberiii/CodeAnalysis
Faberiii Jul 19, 2022
7e9994b
feat: 分析方案适配团队节点
Faberiii Jul 20, 2022
a9b6678
style: 修正错别字
Faberiii Jul 21, 2022
346b070
feat: 后台管理团队节点、团队标签
Faberiii Jul 21, 2022
b8a24d3
feat: 团队内管理节点、标签
Faberiii Jul 21, 2022
6286a5b
Merge branch 'Tencent:main' into main
nickcdon Jul 21, 2022
715c005
feat: 使用团队标签接口获取运行环境
Faberiii Jul 25, 2022
b7104a8
Merge pull request #34 from Faberiii/dev/organization-node
nickcdon Jul 26, 2022
b8dc83d
Merge branch 'Tencent:main' into main
nickcdon Jul 26, 2022
fcc5aaa
fix: 弹框标题
Faberiii Jul 28, 2022
0d65a49
Merge pull request #35 from Faberiii/dev/organization-node
nickcdon Jul 29, 2022
ef848d8
Merge branch 'Tencent:main' into main
nickcdon Jul 29, 2022
edcb40d
fix: update node state
Faberiii Aug 3, 2022
92fc852
Merge pull request #36 from Faberiii/dev/organization-node
Faberiii Aug 3, 2022
f23f36c
Merge remote-tracking branch 'upstream/main'
Aug 4, 2022
08159cf
Merge remote-tracking branch 'upstream/main'
Aug 5, 2022
4b60565
Merge remote-tracking branch 'upstream/main'
Aug 8, 2022
d31662b
:arrow_up: 升级配置
Aug 8, 2022
2e2fba2
:wrench: 调整eslint配置
Aug 8, 2022
4835856
:sparkles: 封装 webpack
Aug 8, 2022
f15f32a
:sparkles: 增加公共模块
Aug 8, 2022
297ab4c
:art: 调整登录微前端代码结构
Aug 8, 2022
fdeaeb4
:art: 调整基座代码结构
Aug 8, 2022
8e4b7ba
:art: 调整代码格式
Aug 8, 2022
6fef239
:art: 调整tca-manage代码结构
Aug 8, 2022
9ad9925
:art: 调整tca-layout manage nav
Aug 8, 2022
ea1ea58
Merge remote-tracking branch 'upstream/main'
nickcdon Aug 9, 2022
d03249c
Merge remote-tracking branch 'upstream/main'
nickcdon Aug 11, 2022
c554be9
:art: 同步web shared模块
nickcdon Aug 11, 2022
f666a0a
:art: 同步login模块,支持回车登录
nickcdon Aug 11, 2022
9da482d
:art: 同步web tca-manage模块
nickcdon Aug 11, 2022
777c0dd
:art: 同步帮助文档,生成资源文件
nickcdon Aug 11, 2022
ef69605
:art: 节点支持状态调整
nickcdon Aug 11, 2022
e067dfd
:bento: web 打包构建资源
nickcdon Aug 11, 2022
53a24e2
Merge remote-tracking branch 'upstream/main'
nickcdon Aug 15, 2022
964bdf1
:art: 调整团队节点管理,团队节点仅能选择团队标签
nickcdon Aug 15, 2022
8649fb8
:package: 更新代码分析微前端资源包
nickcdon Aug 15, 2022
19886e9
Merge remote-tracking branch 'upstream/main'
nickcdon Aug 16, 2022
74b8d27
:memo: 帮助文档增加团队节点管理文档
nickcdon Aug 16, 2022
dbccfc7
:art: 团队概览显示唯一标识
nickcdon Aug 16, 2022
a231475
:memo: 同步帮助文档至tca-document
nickcdon Aug 16, 2022
9063471
:memo: fix en doc config
nickcdon Aug 16, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions doc/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export default defineUserConfig({

// sidebar
sidebar: sidebar.en,
sidebarDepth: 1,

// page meta
editLinkText: 'Edit this page on GitHub',
Expand Down
17 changes: 12 additions & 5 deletions doc/.vuepress/configs/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ export const en: SidebarConfig = {
],
},
{
text: '团队管理相关',
text: '团队管理',
children: [
'/en/guide/团队管理/团队管理.md',
'/en/guide/团队管理/成员权限.md',
'/en/guide/团队管理/节点管理.md',
]
},
{
Expand All @@ -23,7 +24,7 @@ export const en: SidebarConfig = {
]
},
{
text: '分析方案 & 模板',
text: '分析方案',
children: [
'/en/guide/分析方案/基础属性配置.md',
'/en/guide/分析方案/代码检查配置.md',
Expand All @@ -45,7 +46,13 @@ export const en: SidebarConfig = {
{
text: '后台管理',
children: [
'/en/guide/后台管理/后台管理说明.md',
'/en/guide/后台管理/用户管理.md',
'/en/guide/后台管理/团队管理.md',
'/en/guide/后台管理/项目管理.md',
'/en/guide/后台管理/分析记录管理.md',
'/en/guide/后台管理/节点管理.md',
'/en/guide/后台管理/工具管理.md',
'/en/guide/后台管理/OAuth管理.md',
]
},
{
Expand Down Expand Up @@ -108,11 +115,11 @@ export const en: SidebarConfig = {
'/en/quickStarted/': [
{
text: '快速入门',
link: '/zh/quickStarted/deploySever.md',
link: '/en/quickStarted/deploySever.md',
// children: [
// {
// text: '快速入门',
// link: '/zh/quickStarted/deploySever.md',
// link: '/en/quickStarted/deploySever.md',
// },
// ],
},
Expand Down
13 changes: 10 additions & 3 deletions doc/.vuepress/configs/sidebar/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ export const zh: SidebarConfig = {
],
},
{
text: '团队管理相关',
text: '团队管理',
children: [
'/zh/guide/团队管理/团队管理.md',
'/zh/guide/团队管理/成员权限.md',
'/zh/guide/团队管理/节点管理.md',
]
},
{
Expand All @@ -23,7 +24,7 @@ export const zh: SidebarConfig = {
]
},
{
text: '分析方案 & 模板',
text: '分析方案',
children: [
'/zh/guide/分析方案/基础属性配置.md',
'/zh/guide/分析方案/代码检查配置.md',
Expand All @@ -45,7 +46,13 @@ export const zh: SidebarConfig = {
{
text: '后台管理',
children: [
'/zh/guide/后台管理/后台管理说明.md',
'/zh/guide/后台管理/用户管理.md',
'/zh/guide/后台管理/团队管理.md',
'/zh/guide/后台管理/项目管理.md',
'/zh/guide/后台管理/分析记录管理.md',
'/zh/guide/后台管理/节点管理.md',
'/zh/guide/后台管理/工具管理.md',
'/zh/guide/后台管理/OAuth管理.md',
]
},
{
Expand Down
18 changes: 18 additions & 0 deletions doc/en/guide/后台管理/OAuth管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# OAuth管理

- 可**创建**、**编辑**、**清除**主流代码托管平台的Oauth应用配置,为使用者提供OAuth授权支持。

- 支持平台及如何创建OAuth应用:

- 腾讯工蜂:[创建 OAuth 应用程序](https://code.tencent.com/help/oauth2/)
- GitHub:[创建 OAuth 应用程序](https://docs.github.com/cn/developers/apps/building-oauth-apps/creating-an-oauth-app)
- Gitee:[创建 OAuth 应用程序](https://gitee.com/api/v5/oauth_doc#/list-item-3)
- GitLab:[创建 OAuth 应用程序](https://docs.gitlab.com/ee/integration/oauth_provider.html)

![OAuth管理](../../../images/manage_oauth_01.png)

![OAuth管理](../../../images/manage_oauth_02.png)

::: tip
配置OAuth应用时,回调地址栏需填入当前TCA平台配置的域名或IP地址(如当前页面非80端口,需要显式指定端口号),作为Git平台上OAuth应用的回调地址。
:::
7 changes: 7 additions & 0 deletions doc/en/guide/后台管理/分析记录管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 分析记录管理

- 可查看平台**全部分析记录**。

- 可点击查阅**分析记录详情**。

![分析记录列表](../../../images/manage_job_01.png)
53 changes: 0 additions & 53 deletions doc/en/guide/后台管理/后台管理说明.md

This file was deleted.

9 changes: 9 additions & 0 deletions doc/en/guide/后台管理/团队管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 团队管理

- 可查看平台创建的团队列表,并提供了相应筛选

- 可**禁用**、**恢复**团队

![团队列表](../../../images/manage_org_01.png)

![团队操作](../../../images/manage_org_02.png)
19 changes: 19 additions & 0 deletions doc/en/guide/后台管理/工具管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 工具管理

- 可查看**全部工具**(包含平台提供工具、团队自定义工具)。

- 可**查看**、**编辑**工具。

- 可变更工具**权限状态**。

![工具管理](../../../images/manage_tool_01.png)

::: tip
工具的权限状态仅能由**平台管理员**进行变更调整,需谨慎调整

- **团队内可用**:即工具配置了可用团队白名单的团队可以使用该工具,默认创建工具的团队已在白名单内

- **全平台可用**:即不同团队都可见可用该工具

- **支持自定义规则,全平台可用**:即该工具不同团队都可见可用,且支持用户添加团队所需的自定义规则,该自定义规则存在团队隔离,仅团队内可以,其他团队不可使用
:::
9 changes: 9 additions & 0 deletions doc/en/guide/后台管理/用户管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 用户管理

- 可**查看**、**编辑**、**创建**平台用户。

- 可配置用户的**登录密码**、**用户级别**、**超级管理员**等。

![用户列表](../../../images/manage_user_01.png)

![用户编辑](../../../images/manage_user_02.png)
14 changes: 14 additions & 0 deletions doc/en/guide/后台管理/节点管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 节点管理

- 可查看**常驻节点状态**,包含**公共节点**和**团队节点**。

- 可**查看**、**编辑**、**删除**常驻节点。

- 可配置节点**工具进程**。

- 可配置**节点标签**

![节点管理](../../../images/manage_node_01.png)
![节点管理](../../../images/manage_node_02.png)
![节点管理](../../../images/manage_node_03.png)
![节点管理](../../../images/manage_node_04.png)
7 changes: 7 additions & 0 deletions doc/en/guide/后台管理/项目管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 项目管理

- 可查看平台创建的项目列表,并提供了提供相应筛选

- 可**禁用**、**恢复**项目

![项目列表](../../../images/manage_team_01.png)
2 changes: 1 addition & 1 deletion doc/en/guide/团队管理/团队管理.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 团队管理
# 团队说明

![成员权限](../../../images/team_member.png)

Expand Down
4 changes: 2 additions & 2 deletions doc/en/guide/团队管理/成员权限.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 成员权限

## 团队成员管理
## 团队成员

![成员权限](../../../images/team_member.png)

Expand All @@ -10,7 +10,7 @@

**团队普通成员**:可以创建项目,可以访问自己有权限的项目。创建项目的人会自动成为这个项目的项目管理员。

## 项目成员管理
## 项目成员

项目成员分为**项目管理员**和**项目普通成员**。

Expand Down
105 changes: 105 additions & 0 deletions doc/en/guide/团队管理/节点管理.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# 节点与标签

除了使用**公共节点**执行代码分析外,团队还可以利用**团队标签**注册并使用**团队节点**。

## 名词释义与特点

- 团队节点是**团队注册并管理**的**私有**节点。

- 团队节点**仅会运行**当前团队所属的分析任务。

- 团队标签是用于关联节点机器与分析项目。
::: tip
当一个分析项目在方案中配置运行环境为团队标签后,该项目创建的任务就会下发到团队标签关联的节点机器上运行
:::

## 适用场景

1. 业务项目**不想**在公共机器上**排队**等待

2. 业务项目**代码比较敏感**,不能在公共机器上运行

3. 业务项目需要**依赖特定**的**机器环境**(比如CPU架构、操作系统等)

4. ...

以上场景,均可考虑使用团队节点,业务团队提供机器资源接入作为团队节点,仅分析自己业务的代码库,**保证执行效率**,**保护源码不泄漏**,**支持项目特殊依赖**等

## 团队节点注册

- 根据环境下载客户端二进制文件或拉取源码,参考[客户端](../客户端/配置说明.md)。

- 通过终端启动客户端:

- 客户端二进制启动

```bash
./codepuppy start -t TOKEN --org-sid ORG_SID
```

- 客户端源码启动

```bash
python3 codepuppy.py start -t TOKEN --org-sid ORG_SID
```

::: tip
1. TOKEN 可以从平台**个人中心-个人令牌**页面获取
2. ORG_SID 可以从**页面链接**中获取
:::

## 团队节点管理

完成团队节点注册后,可以在当前团队下看到对应的节点信息,同时**需要进行配置**

::: warning
- 团队节点**首次注册**时,需要手动在平台上配置**所属标签**、**节点可用性**、**工具进程**等。
- 将节点的**节点可用性**调整为**活跃**后,运行客户端节点的终端会输出**心跳上报成功**的日志
:::

- 首次注册团队节点,节点状态为不可用

![注册团队节点](../../../images/org_node_manager_1.png)

- 调整后的节点

![注册团队节点](../../../images/org_node_manager_2.png)

- 配置节点关联的工具进程:

![配置工具进程](../../../images/org_node_process.png)

::: tip
1. 团队节点使用的**所属标签**均为当前团队内创建的标签,可参见[团队标签管理](#团队标签管理)
2. 团队标签可以参考`CodeDog`标签为不同的系统类型(Linux、MacOS、Windows)建立标签,比如`专属标签-Linux`、`专属标签-Mac`等
:::

### 团队节点执行任务范围

::: warning 使用团队节点运行分析任务的前提
对应分析项目使用的分析方案中,需要配置分析方案中的**运行环境**为该团队节点配置的所属标签。
:::

::: warning 团队节点执行的任务范围取决于该节点的负责人
- 如果节点负责人为团队管理员,该节点可以执行当前团队所有项目的分析任务
- 如果节点负责人为项目管理员,该节点只能运行指定项目下的分析任务
- 如果节点负责人为部分代码库的管理员,该节点只能运行对应代码库的分析任务
:::


## 团队标签管理

您可以创建一个团队标签,并配置到您的团队节点和您的分析方案中

- 创建团队标签。

![创建团队标签](../../../images/org_tag_manager.png)

- 配置团队节点所属标签。

![节点配置团队标签](../../../images/org_tag_node.png)

- 配置分析方案运行环境。

![方案配置团队标签](../../../images/org_tag_scheme.png)

Loading