安装

使用 Helm 安装

如果您拥有 Kubernetes 集群，Helm 是推荐的安装方法。

以下教程将指导您使用 Helm 安装 Karpor，这将在命名空间 karpor 中以 karpor-release 为 Release 名称安装 Chart。

先决条件

• Helm v3+
• Kubernetes 集群（最简单的方法是使用 kind 或 minikube 在本地部署 Kubernetes 集群）

远程安装

首先，将 Karpor chart 仓库添加到您的本地仓库。

helm repo add kusionstack https://kusionstack.github.io/charts
helm repo update

然后，您可以使用以下命令安装 Karpor 的最新版本。

helm install karpor-release kusionstack/karpor

注意：直接安装此 Chart 意味着它将使用 Karpor 的 默认模板值。

如果将其部署到生产集群中，或者您想要自定义 Chart 配置，如 resources、replicas、port 等，您可以通过 --set 参数覆盖默认值。

Karpor Chart 的所有可配置参数都详细说明在 这里。

helm install karpor-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654

查看所有可用版本

您可以使用以下命令查看所有可安装的 Karpor Chart 版本。

helm repo update
helm search repo kusionstack/karpor --versions

升级到指定版本

您可以通过 --version 指定要升级的版本。

# 升级到最新版本
helm upgrade karpor-release kusionstack/karpor

# 升级到指定版本
helm upgrade karpor-release kusionstack/karpor --version 1.2.3

本地安装

如果您在生产中连接 https://kusionstack.github.io/charts/ 有问题，您可能需要从 这里 手动下载 Chart，并在本地使用它来安装或升级 Karpor 版本。

git clone https://github.com/KusionStack/charts.git
helm install karpor-release charts/karpor
helm upgrade karpor-release charts/karpor

卸载

卸载/删除命名空间 karpor 中的 karpor-release Helm Release：

helm uninstall karpor-release

中国镜像代理

如果你在中国、并且从官方 DockerHub 上拉取镜像时遇到困难，那么你可以使用第三方的镜像代理服务：

helm install karpor-release kusionstack/karpor --set registryProxy=docker.m.daocloud.io

注意: 以上只是一个样例，你可以根据需要替换 registryProxy 的值。

启用 AI 功能

如果您要安装带有 AI 功能的 Karpor，包括自然语言搜索和 AI 分析，则应配置 ai-auth-token、ai-base-url 等参数，例如：

# 最少配置，默认使用 OpenAI 作为 AI Backend
helm install karpor-release kusionstack/karpor \
   --set server.ai.authToken={YOUR_AI_TOKEN}

# 使用 Azure OpenAI 的样例
helm install karpor-release kusionstack/karpor \
   --set server.ai.authToken={YOUR_AI_TOKEN} \
   --set server.ai.baseUrl=https://{YOUR_RESOURCE_NAME}.openai.azure.com \
   --set server.ai.backend=azureopenai

# 使用 Hugging Face 的样例
helm install karpor-release kusionstack/karpor \
   --set server.ai.authToken={YOUR_AI_TOKEN} \
   --set server.ai.model={YOUR_HUGGINGFACE_MODEL} \
   --set server.ai.backend=huggingface

# 自定义配置
helm install karpor-release kusionstack/karpor \
   --set server.ai.authToken={YOUR_AI_TOKEN} \
   --set server.ai.baseUrl=https://api.deepseek.com \
   --set server.ai.backend=openai \
   --set server.ai.model=deepseek-chat \
   --set server.ai.topP=0.5 \
   --set server.ai.temperature=0.2

Chart 参数

以下表格列出了 Chart 的所有可配置参数及其默认值。

通用参数

键	类型	默认值	描述
namespace	string	"karpor"	部署的目标命名空间。
namespaceEnabled	bool	true	是否生成命名空间。
registryProxy	string	""	镜像仓库代理，将作为所有组件镜像的前缀。

全局参数

键	类型	默认值	描述
global.image.imagePullPolicy	string	"IfNotPresent"	应用于所有 Karpor 组件的镜像拉取策略。

Karpor 服务端

Karpor 服务器组件是主要的后端服务器。它本身是一个 apiserver，同时也提供 /rest-api 来服务仪表板。

键	类型	默认值	描述
server.ai	object	{"authToken":"","backend":"openai","baseUrl":"","model":"gpt-3.5-turbo","temperature":1,"topP":1}	AI 配置部分。AI 分析功能需要为 [authToken, baseUrl] 赋值。
server.ai.authToken	string	""	访问 AI 服务的认证令牌。
server.ai.backend	string	"openai"	托管 AI 模型的后端服务或平台。可用选项： - "openai": OpenAI API（默认） - "azureopenai": Azure OpenAI 服务 - "huggingface": Hugging Face API 如果您使用的后端与 OpenAI 兼容，则无需在此处进行任何更改。
server.ai.baseUrl	string	""	AI 服务的基础 URL。例如："https://api.openai.com/v1"。
server.ai.model	string	"gpt-3.5-turbo"	要使用的 AI 模型的名称或标识符。例如："gpt-3.5-turbo"。
server.ai.temperature	float	1	AI 模型的温度参数。控制输出的随机性，较高的值（例如 1.0）使输出更随机，较低的值（例如 0.0）使输出更确定性。
server.ai.topP	float	1	AI 模型的 Top-p（核采样）参数。控制采样的概率质量，较高的值导致生成内容的多样性更大（通常范围为 0 到 1）。
server.enableRbac	bool	false	如果设置为 true，则启用 RBAC 授权。
server.image.repo	string	"kusionstack/karpor"	Karpor 服务器镜像的仓库。
server.image.tag	string	""	Karpor 服务器镜像的标签。如果未指定，则默认为 Chart 的 appVersion。
server.name	string	"karpor-server"	Karpor 服务器的组件名称。
server.port	int	7443	Karpor 服务器的端口。
server.replicas	int	1	要运行的 Karpor 服务器 Pod 数量。
server.resources	object	{"limits":{"cpu":"500m","ephemeral-storage":"10Gi","memory":"1Gi"},"requests":{"cpu":"250m","ephemeral-storage":"2Gi","memory":"256Mi"}}	Karpor 服务器 Pod 的资源限制和请求。
server.serviceType	string	"ClusterIP"	Karpor 服务器的服务类型。可用类型值为 ["ClusterIP"、"NodePort"、"LoadBalancer"]。

Karpor 同步器

Karpor 同步器组件是一个独立的服务器，用于实时同步集群资源。

键	类型	默认值	描述
syncer.image.repo	string	"kusionstack/karpor"	Karpor 同步器镜像的仓库。
syncer.image.tag	string	""	Karpor 同步器镜像的标签。如果未指定，则默认为 Chart 的 appVersion。
syncer.name	string	"karpor-syncer"	Karpor 同步器的组件名称。
syncer.port	int	7443	Karpor 同步器的端口。
syncer.replicas	int	1	要运行的 Karpor 同步器 Pod 数量。
syncer.resources	object	{"limits":{"cpu":"500m","ephemeral-storage":"10Gi","memory":"1Gi"},"requests":{"cpu":"250m","ephemeral-storage":"2Gi","memory":"256Mi"}}	Karpor 同步器 Pod 的资源限制和请求。

ElasticSearch

ElasticSearch 组件用于存储同步的资源数据和用户数据。

键	类型	默认值	描述
elasticsearch.image.repo	string	"docker.elastic.co/elasticsearch/elasticsearch"	ElasticSearch 镜像的仓库。
elasticsearch.image.tag	string	"8.6.2"	ElasticSearch 镜像的特定标签。
elasticsearch.name	string	"elasticsearch"	ElasticSearch 的组件名称。
elasticsearch.port	int	9200	ElasticSearch 的端口。
elasticsearch.replicas	int	1	要运行的 ElasticSearch Pod 数量。
elasticsearch.resources	object	{"limits":{"cpu":"2","ephemeral-storage":"10Gi","memory":"4Gi"},"requests":{"cpu":"2","ephemeral-storage":"10Gi","memory":"4Gi"}}	Karpor ElasticSearch Pod 的资源限制和请求。

ETCD

ETCD 组件是 Karpor 服务器作为 apiserver 的存储。

键	类型	默认值	描述
etcd.image.repo	string	"quay.io/coreos/etcd"	ETCD 镜像的仓库。
etcd.image.tag	string	"v3.5.11"	ETCD 镜像的特定标签。
etcd.name	string	"etcd"	ETCD 的组件名称。
etcd.persistence.accessModes	list	["ReadWriteOnce"]	卷访问模式，ReadWriteOnce 表示单节点读写访问。
etcd.persistence.size	string	"10Gi"	ETCD 持久卷的大小。
etcd.port	int	2379	ETCD 的端口。
etcd.replicas	int	1	要运行的 ETCD Pod 数量。
etcd.resources	object	{"limits":{"cpu":"500m","ephemeral-storage":"10Gi","memory":"1Gi"},"requests":{"cpu":"250m","ephemeral-storage":"2Gi","memory":"256Mi"}}	Karpor ETCD Pod 的资源限制和请求。

任务

此一次性任务用于生成根证书和一些准备工作。

键	类型	默认值	描述
job.image.repo	string	"kusionstack/karpor"	任务镜像的仓库。
job.image.tag	string	""	Karpor 镜像的标签。如果未指定，则默认为 Chart 的 appVersion。