Skip to content

Commit

Permalink
add servicemesh extension (#22)
Browse files Browse the repository at this point in the history
Signed-off-by: renyunkang <[email protected]>
  • Loading branch information
renyunkang authored Sep 20, 2024
1 parent c84a904 commit f414b0b
Show file tree
Hide file tree
Showing 75 changed files with 18,457 additions and 0 deletions.
23 changes: 23 additions & 0 deletions servicemesh/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
24 changes: 24 additions & 0 deletions servicemesh/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!---
Please do not delete this line of version tag
RELEASE_MARK v4.1.2 RELEASE_MARK
Please do not delete this line of version tag
-->

## v1.0.0

### Features
- Refactor based on the new microkernel architecture KubeSphere LuBan.
- Support for more granular permission configurations, including service mesh management and viewing.

### Enhancements
- Simplify the installation process of this extension.
- Improve product interaction by changing the entry points for "Composed Applications" and "Gray Releases."

### Bug Fixes
- Fix the issue where the ingress does not have a gateway address after deploying the sample application.
- Fix the format error of routing rules when deploying the sample application.

### Misc
- Istio Version: v1.14.6 -> v1.16.5
- Kiali Version: v1.50 -> v1.59
- Jaeger Version: 1.29 -> 1.35
25 changes: 25 additions & 0 deletions servicemesh/CHANGELOG_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!---
Please do not delete this line of version tag
RELEASE_MARK v4.1.2 RELEASE_MARK
Please do not delete this line of version tag
-->

## v1.0.0

### 新特性
- 支持通过全新微内核架构 KubeSphere LuBan 热插拔
- 支持更细粒度的权限配置

### 优化
- 简化了 KubeSphere 服务网格扩展组件的安装操作
- 优化了产品交互,改变“自制应用“与”灰度发布“的入口位置

### 缺陷修复

- 修复部署示例应用后,对应的应用路由没有网关地址的问题
- 修复部署示例应用时路由规则的格式错误

### 其他
- Istio 版本:v1.14.6 -> v1.16.5
- Kiali 版本:v1.50 -> v1.59
- Jaeger 版本:1.29 -> 1.35
201 changes: 201 additions & 0 deletions servicemesh/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
27 changes: 27 additions & 0 deletions servicemesh/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Core Features

- Blue-green deployment: Create identical standby environments and run new application versions to ensure avoidance of downtime or service interruption.
- Canary release: Slowly push changes to a small portion of users to minimize version upgrade risks.
- Traffic mirroring: Replicate real-time production traffic and send it to mirroring services.
- Traffic monitoring: Visually displays the traffic situation between each microservice, and supports users to configure current limiting and circuit breakers.
- Link tracking: Visually displays key information such as the mutual calling relationship, span, and time consumption between each microservice.

## Installation

- Navigate to the KubeSphere Service Mesh extension component on the Extension Market page, select the latest version, and click the Next button.
- On the Extension Component Installation tab, click and modify the extension component configuration as needed. After configuration, click the Install button to begin installation.
- After installation is complete, click the Next button to proceed to the cluster selection page. Check the clusters that need to be installed, then click the Next button to proceed to the Differential Configuration page.
- Update the differential configuration according to requirements, then begin installation. Wait patiently for the installation to complete.

## Notes

- It is necessary to configure available Prometheus services and OpenSearch services in the configuration before using the related features of KubeSphere Service Mesh.

| Name | Meaning |Default | Range |
| ------------------------------------------------ | ------------------- | -------------------------------------------------------------------- | -------- |
| backend.istio.meshConfig.defaultConfig.tracing.sampling | Tracing Sampling Rate | 1.0 | 1-100 |
| backend.kiali.prometheus_url | Promethus URL | http://prometheus-k8s.kubesphere-monitoring-system.svc:9090 | |
| backend.jaeger.storage.options.es.server-urls | OpenSearch/ES URL | https://opensearch-cluster-data.kubesphere-logging-system.svc:9200 | |
| backend.jaeger.storage.options.es.username | OpenSearch/ES Username | admin | |
| backend.jaeger.storage.options.es.password | OpenSearch/ES Password | admin | |
| backend.jaeger.storage.options.secretName | OpenSearch/ES Secret 名 | | |
28 changes: 28 additions & 0 deletions servicemesh/README_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## 核心功能

- 蓝绿部署:创建相同备用环境并运行新应用版本,确保避免宕机或者服务中断。
- 金丝雀发布:缓慢地向一小部分用户推送变更,将版本升级风险降到最低。
- 流量镜像:复制实时生产流量并发送至镜像服务。
- 流量监控:可视化展示各个微服务间的流量情况,支持用户支持配置限流熔断。
- 链路追踪:可视化展示各个微服务间相互的调用关系、跨度与耗时等关键信息。

## 安装

- 通过 扩展市场 页面找到 KubeSphere 服务网格 扩展组件,选择最新版本,点击 下一步 按钮;
- 在 扩展组件安装 标签页面中,根据需求点击并修改 扩展组件配置, 配置完成后,点击 安装 按钮, 开始安装;
- 安装完成后, 点击 下一步 按钮,进入集群选择页面,勾选需要安装的集群,点击 下一步 按钮,进入 差异化配置 页面;
- 根据需求更新 差异化配置,更新完成,开始安装,静待安装完成。

## 注意事项

- 需要在配置中配置可用的 Prometheus 服务和 OpenSearch 服务后,方可使用 KubeSphere 服务网格的相关功能。


| 参数 | 含义 | 默认值 | 取值 |
| ------------------------------------------------ | -------------------- | -------------------------------------------------------------------- | -------- |
| backend.istio.meshConfig.defaultConfig.tracing.sampling | 链路追踪采样率 | 1.0 | 1-100 |
| backend.kiali.prometheus_url | promethus 地址 | http://prometheus-k8s.kubesphere-monitoring-system.svc:9090 | |
| backend.jaeger.storage.options.es.server-urls | OpenSearch/ES 地址 | https://opensearch-cluster-data.kubesphere-logging-system.svc:9200 | |
| backend.jaeger.storage.options.es.username | OpenSearch/ES 账户名 | admin | |
| backend.jaeger.storage.options.es.password | OpenSearch/ES 密码 | admin | |
| backend.jaeger.storage.options.secretName | OpenSearch/ES 访问 Secret 名 | | |
9 changes: 9 additions & 0 deletions servicemesh/charts/backend/Chart.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
dependencies:
- name: jaeger-operator
repository: https://jaegertracing.github.io/helm-charts
version: 2.33.0
- name: kiali-operator
repository: https://kiali.org/helm-charts
version: 1.59.1
digest: sha256:f1982ef14b21f4bae6388161b6057564a08f0b3fc6119d1d326e5551ad0cf5b3
generated: "2024-03-08T16:14:46.651181+08:00"
16 changes: 16 additions & 0 deletions servicemesh/charts/backend/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
apiVersion: v2
name: backend
description: Backend of servicemesh extension.
type: application
version: 0.1.0
appVersion: "0.1.0"
home: https://kubesphere.io
sources:
- https://github.com/kubesphere-extensions/servicemesh
dependencies:
- name: jaeger-operator
version: "2.33.0"
repository: "https://jaegertracing.github.io/helm-charts"
- name: kiali-operator
version: "1.59.1"
repository: "https://kiali.org/helm-charts"
3 changes: 3 additions & 0 deletions servicemesh/charts/backend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Prerequisites

Jaeger Operator needs cert-manager 1.6.1+ installed, or certificate for webhook service in a secret.
21 changes: 21 additions & 0 deletions servicemesh/charts/backend/charts/jaeger-operator/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*~
# Various IDEs
.project
.idea/
*.tmproj
Loading

0 comments on commit f414b0b

Please sign in to comment.