You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs: update installation guide structure and AI backend details
- Change section headers from '###' to '##' for better hierarchy
- Add detailed descriptions for AI backend options (OpenAI, Azure OpenAI, Hugging Face)
- Ensure consistency in parameter descriptions across both English and Chinese versions
These changes improve the readability and clarity of the installation guide, making it easier for users to understand the configuration options available for the AI backend.
* docs: translate installation guide to Chinese
- Translate all sections of the installation guide from English to Chinese
- Update table headers and descriptions to match the Chinese language
- Ensure consistency in terminology and formatting throughout the document
* docs: update AI feature installation instructions
- Rephrase instructions for enabling AI features for clarity
- Add examples for different AI backends (OpenAI, Azure OpenAI, Hugging Face)
- Restructure configuration examples to improve readability
These changes aim to make the installation process for AI features more intuitive and provide better guidance for users configuring different AI backends.
* docs: update installation guide for Deepseek AI backend
- Change base URL from OpenAI to Deepseek
- Update model name from gpt-3.5-turbo to deepseek-chat
These changes reflect the switch from OpenAI to Deepseek as the AI backend service, ensuring the documentation is accurate and up-to-date.
If you are trying to install Karpor with AI features, including natural language search and AI analyze, `ai-auth-token` and `ai-base-url` should be configured, e.g.:
94
+
If you want to install Karpor with AI features, including natural language search and AI analysis, you should configure parameters such as `ai-auth-token`, `ai-base-url`, etc., for example:
95
95
96
96
```shell
97
-
#At a minimum, server.ai.authToken and server.ai.baseUrl must be configured.
97
+
#Minimal configuration, using OpenAI as the default AI backend
98
98
helm install karpor-release kusionstack/karpor \
99
-
--set server.ai.authToken=YOUR_AI_TOKEN \
100
-
--set server.ai.baseUrl=https://api.openai.com/v1
99
+
--set server.ai.authToken={YOUR_AI_TOKEN}
101
100
102
-
# server.ai.backend has default values `openai`, which can be overridden when necessary.
103
-
# If the backend you are using is compatible with OpenAI, then there is no need to make
The following table lists the configurable parameters of the chart and their default values.
127
126
128
-
####General Parameters
127
+
### General Parameters
129
128
130
129
| Key | Type | Default | Description |
131
130
|-----|------|---------|-------------|
132
131
| namespace | string |`"karpor"`| Which namespace to be deployed. |
133
132
| namespaceEnabled | bool |`true`| Whether to generate namespace. |
134
133
| registryProxy | string |`""`| Image registry proxy will be the prefix as all component image. |
135
134
136
-
####Global Parameters
135
+
### Global Parameters
137
136
138
137
| Key | Type | Default | Description |
139
138
|-----|------|---------|-------------|
140
139
| global.image.imagePullPolicy | string |`"IfNotPresent"`| Image pull policy to be applied to all Karpor components. |
141
140
142
-
####Karpor Server
141
+
### Karpor Server
143
142
144
143
The Karpor Server Component is main backend server. It itself is an `apiserver`, which also provides `/rest-api` to serve Dashboard.
145
144
146
145
| Key | Type | Default | Description |
147
146
|-----|------|---------|-------------|
148
147
| server.ai | object |`{"authToken":"","backend":"openai","baseUrl":"","model":"gpt-3.5-turbo","temperature":1,"topP":1}`| AI configuration section. The AI analysis feature requires that [authToken, baseUrl] be assigned values. |
149
-
| server.ai.authToken | string |`""`| Authentication token for accessing the AI service. |
150
-
| server.ai.backend | string |`"openai"`| Backend service or platform that the AI model is hosted on. e.g., "openai". If the backend you are using is compatible with OpenAI, then there is no need to make any changes here. |
148
+
| server.ai.authToken | string |`""`| Authentication token for accessing the AI service. |
149
+
| server.ai.backend | string |`"openai"`| Backend service or platform that the AI model is hosted on. Available options: <br/>- `"openai"`: OpenAI API (default)<br/>- `"azureopenai"`: Azure OpenAI Service<br/>- `"huggingface"`: Hugging Face API<br/> If the backend you are using is compatible with OpenAI, then there is no need to make any changes here. |
151
150
| server.ai.baseUrl | string |`""`| Base URL of the AI service. e.g., "https://api.openai.com/v1".|
152
151
| server.ai.model | string |`"gpt-3.5-turbo"`| Name or identifier of the AI model to be used. e.g., "gpt-3.5-turbo". |
153
152
| server.ai.temperature | float |`1`| Temperature parameter for the AI model. This controls the randomness of the output, where a higher value (e.g., 1.0) makes the output more random, and a lower value (e.g., 0.0) makes it more deterministic. |
@@ -161,7 +160,7 @@ The Karpor Server Component is main backend server. It itself is an `apiserver`,
161
160
| server.resources | object |`{"limits":{"cpu":"500m","ephemeral-storage":"10Gi","memory":"1Gi"},"requests":{"cpu":"250m","ephemeral-storage":"2Gi","memory":"256Mi"}}`| Resource limits and requests for the karpor server pods. |
162
161
| server.serviceType | string |`"ClusterIP"`| Service type for the karpor server. The available type values list as ["ClusterIP"、"NodePort"、"LoadBalancer"]. |
163
162
164
-
####Karpor Syncer
163
+
### Karpor Syncer
165
164
166
165
The Karpor Syncer Component is independent server to synchronize cluster resources in real-time.
167
166
@@ -174,7 +173,7 @@ The Karpor Syncer Component is independent server to synchronize cluster resourc
174
173
| syncer.replicas | int |`1`| The number of karpor syncer pods to run. |
175
174
| syncer.resources | object |`{"limits":{"cpu":"500m","ephemeral-storage":"10Gi","memory":"1Gi"},"requests":{"cpu":"250m","ephemeral-storage":"2Gi","memory":"256Mi"}}`| Resource limits and requests for the karpor syncer pods. |
176
175
177
-
####ElasticSearch
176
+
### ElasticSearch
178
177
179
178
The ElasticSearch Component to store the synchronized resources and user data.
180
179
@@ -187,7 +186,7 @@ The ElasticSearch Component to store the synchronized resources and user data.
187
186
| elasticsearch.replicas | int |`1`| The number of ElasticSearch pods to run. |
188
187
| elasticsearch.resources | object |`{"limits":{"cpu":"2","ephemeral-storage":"10Gi","memory":"4Gi"},"requests":{"cpu":"2","ephemeral-storage":"10Gi","memory":"4Gi"}}`| Resource limits and requests for the karpor elasticsearch pods. |
189
188
190
-
####ETCD
189
+
### ETCD
191
190
192
191
The ETCD Component is the storage of Karpor Server as `apiserver`.
193
192
@@ -202,11 +201,13 @@ The ETCD Component is the storage of Karpor Server as `apiserver`.
202
201
| etcd.replicas | int |`1`| The number of etcd pods to run. |
203
202
| etcd.resources | object |`{"limits":{"cpu":"500m","ephemeral-storage":"10Gi","memory":"1Gi"},"requests":{"cpu":"250m","ephemeral-storage":"2Gi","memory":"256Mi"}}`| Resource limits and requests for the karpor etcd pods. |
204
203
205
-
####Job
204
+
### Job
206
205
207
206
This one-time job is used to generate root certificates and some preliminary work.
208
207
209
208
| Key | Type | Default | Description |
210
209
|-----|------|---------|-------------|
211
210
| job.image.repo | string |`"kusionstack/karpor"`| Repository for the Job image. |
212
211
| job.image.tag | string |`""`| Tag for Karpor image. Defaults to the chart's appVersion if not specified. |
| server.name | string |`"karpor-server"`| Karpor Server 的组件名称 |
146
-
| server.port | int |`7443`| Karpor Server 的端口 |
147
-
| server.replicas | int |`1`| 要运行的 Karpor Server pod 的数量 |
148
-
| server.resources | object |`{"limits":{"cpu":"500m","ephemeral-storage":"10Gi","memory":"1Gi"},"requests":{"cpu":"250m","ephemeral-storage":"2Gi","memory":"256Mi"}}`| Karpor Server pod 的资源规格 |
149
-
| server.serviceType | string |`"ClusterIP"`| Karpor Server 的服务类型,可用的值为 ["ClusterIP"、"NodePort"、"LoadBalancer"]|
0 commit comments