Skip to content

Commit

Permalink
modify the jump address in some pages
Browse files Browse the repository at this point in the history
  • Loading branch information
li.wei9 committed Nov 22, 2023
1 parent 26327c1 commit 1f671a5
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 14 deletions.
4 changes: 2 additions & 2 deletions docs/develop-guid/building-base/add-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ export TOKENNAME=$(kubectl get serviceaccount/host-cluster-reader -n u4a-system
kubectl get secret $TOKENNAME -n u4a-system -o jsonpath='{.data.token}' | base64 -d
```

3. 登录管理平台,进入 “集群管理”,参考 [安装底座](docs/quick-start/buildingbase_quickstart.md),点击“添加集群”。
3. 登录管理平台,进入 “集群管理”,参考 [安装底座](../../quick-start/quick-install.md#安装底座),点击“添加集群”。

4. 输入集群名称,按需修改集群后缀,这里使用“API Token”方式接入集群。

* API Host,使用支持 OIDC 协议的 K8s API 地址,可以通过 **kubectl get ingress -nu4a-system** 查看kube-oidc-proxy-server-ingress 对应的 Host 信息,比如 https://k8s.172.22.96.136.nip.io(注意结尾不要有 /)
* API Host,使用支持 OIDC 协议的 K8s API 地址,可以通过 **kubectl get ingress -nu4a-system** 查看 kube-oidc-proxy-server-ingress 对应的 Host 信息,比如 `https://k8s.172.22.96.136.nip.io`(注意结尾不要有 /)
* API Token,输入第 2 步获取的 token 信息

5. 添加成功后,可以在列表上看到集群信息及其状态;选择“租户管理”,会看到名称为 "system-tenant" 的一个系统租户
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3
# 配置审计能力

:::tip
注意,审计功能依赖对审计日志的采集功能,需要在集群设置中配置日志服务 ElasticSearch 的地址,日志服务的配置参考[日志组件](docs/component-market/logging.md)
注意,审计功能依赖对审计日志的采集功能,需要在集群设置中配置日志服务 ElasticSearch 的地址,日志服务的配置参考[日志组件](../../component-market/logging.md)
:::

1、编辑 audit-policy.yaml 文件对审计进行配置,```kubectl edit cm audit-policy-conf -n u4a-system```
Expand Down
13 changes: 6 additions & 7 deletions docs/develop-guid/component-market/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,12 @@ sidebar_position: 2

### 功能描述
1. helm package包含了安装elasticsearch和对外暴露elasticsearch服务的ingress资源文件;
2. 支持配置的组件包括以下几个:
> - rbacSidecar(.Values.rbacSidecar.enabled): 在elasticsearch client节点上安装kube-rbac-proxy sidecar 用来认证用户token
> - ingress(.Values.ingress.enabled): 通过ingress暴露elasticsearch服务,按需开启,默认为 true
rbacSidecar 和 elasticsearch.secure 仅能使用其中一种,比如:
> - .Values.rbacSidecar.enabled: true, .Values.elasticsearch.secure: false
> - .Values.rbacSidecar.enabled: false, .Values.elasticsearch.secure: true
2. 支持配置的组件包括以下几个:

Check failure on line 12 in docs/develop-guid/component-market/logging.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "2. 支持配置的组件包括以下几个:"] Raw Output: docs/develop-guid/component-market/logging.md:12 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "2. 支持配置的组件包括以下几个:"]
- rbacSidecar(.Values.rbacSidecar.enabled):在elasticsearch client 节点上安装 kube-rbac-proxy sidecar 用来认证用户 token

Check failure on line 13 in docs/develop-guid/component-market/logging.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] Raw Output: docs/develop-guid/component-market/logging.md:13:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]

Check failure on line 13 in docs/develop-guid/component-market/logging.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- rbacSidecar(.Values.rbacSide..."] Raw Output: docs/develop-guid/component-market/logging.md:13 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- rbacSidecar(.Values.rbacSide..."]
- ingress(.Values.ingress.enabled):通过 ingress 暴露 elasticsearch 服务,按需开启,默认为 true

Check failure on line 14 in docs/develop-guid/component-market/logging.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] Raw Output: docs/develop-guid/component-market/logging.md:14:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
- rbacSidecar 和 elasticsearch.secure 仅能使用其中一种,比如:

Check failure on line 15 in docs/develop-guid/component-market/logging.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] Raw Output: docs/develop-guid/component-market/logging.md:15:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
- .Values.rbacSidecar.enabled: true, .Values.elasticsearch.secure: false

Check failure on line 16 in docs/develop-guid/component-market/logging.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] Raw Output: docs/develop-guid/component-market/logging.md:16:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
- .Values.rbacSidecar.enabled: false, .Values.elasticsearch.secure: true

Check failure on line 17 in docs/develop-guid/component-market/logging.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] Raw Output: docs/develop-guid/component-market/logging.md:17:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]

### values 字段解释

Expand Down
2 changes: 1 addition & 1 deletion docs/develop-guid/core/rating/enablerating.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1
默认情况下,Rating组件评级功能是关闭的,需要手动启用。我们建议按照以下步骤启用Rating:

:::tip
详细了解更多Rating有关内容,请参考[组件评测设计](../rating)[Rating CRD定义](../concepts/rating)
详细了解更多Rating有关内容,请参考[组件评测设计](../rating/rating.md)[Rating CRD定义](../concepts/rating.md)
:::

**Rating**依赖两个组件,分别是:
Expand Down
4 changes: 2 additions & 2 deletions docs/develop-guid/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,5 @@ Kubebb提供三个**套件**:
## 获取更多组件

浏览 [组件市场](/docs/category/组件市场),安装更多需要的服务组件到门户中,比如:
* [kubedashboard](/docs/component-market/kubedashboard)
* [kubelogin](/docs/component-market/kubelogin)
* [kubedashboard](/docs/develop-guid/component-market/kubedashboard.md)

Check failure on line 109 in docs/develop-guid/intro.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] Raw Output: docs/develop-guid/intro.md:109:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

Check failure on line 109 in docs/develop-guid/intro.md

View workflow job for this annotation

GitHub Actions / markdownlint

[markdownlint] reported by reviewdog 🐶 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* [kubedashboard](/docs/develo..."] Raw Output: docs/develop-guid/intro.md:109 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* [kubedashboard](/docs/develo..."]
* [kubelogin](/docs/develop-guid/component-market/kubelogin.md)
2 changes: 1 addition & 1 deletion docs/quick-start/quick-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ spec:
- `override.set.ingress-nginx.controller.nodeSelector.kubernetes\.io/hostname` 将作为[ingress-nginx](https://github.com/kubebb/components/tree/main/charts/cluster-component/charts/ingress-nginx)服务节点

> 此处基于[kind开发集群](./prerequisite#kind开发集群)的`kubebb-core-control-plane`节点。
> 此处基于[kind开发集群](#准备环境)的`kubebb-core-control-plane`节点。

通过一下命令部署:

Expand Down

0 comments on commit 1f671a5

Please sign in to comment.