Skip to content

Commit

Permalink
Docs: fix ES catalog descriptions (#173)
Browse files Browse the repository at this point in the history
Signed-off-by: xingcan-ltc <xingcan.hu@hotmail.com>
  • Loading branch information
xingcan-ltc authored Jul 26, 2024
1 parent 4227a55 commit 38bb5f2
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 14 deletions.
2 changes: 1 addition & 1 deletion catalog/elasticsearch/apps/elasticsearch.app/app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: bdc.kdp.io/v1alpha1
kind: Application
metadata:
annotations:
app.core.bdos/catalog: juicefs
app.core.bdos/catalog: elasticsearch
labels:
app: elasticsearch
app.core.bdos/type: system
Expand Down
10 changes: 5 additions & 5 deletions catalog/elasticsearch/apps/elasticsearch.app/i18n/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ curl -X DELETE "${ES_ENDPOINT}/${ES_INDEX}?pretty"

### 3. FAQ

1. Elasticsearch 有哪些常用 node role ?
1. What are the common node roles in Elasticsearch?

- 主节点(Master-eligible Node):有资格被选举为主节点的节点。主节点负责管理集群的状态,包括创建和删除索引、跟踪集群中的节点以及分配分片到节点等。
- 数据节点(Data Node):负责存储数据并执行数据相关的操作,如搜索和聚合。数据节点处理与数据存储和查询相关的负载。
- 协调节点(Coordinating Node):负责接收客户端请求,将请求分发到相应的数据节点,并收集结果返回给客户端。每个节点默认都是协调节点,但可以通过配置专门指定某些节点为协调节点。
- 摄取节点(Ingest Node):负责执行预处理管道,对文档进行转换和 enrich 操作。摄取节点在索引文档之前对文档进行预处理。
- **Master-eligible Node**: Nodes that are eligible to be elected as the master node. The master node is responsible for managing the cluster state, including creating and deleting indices, tracking nodes in the cluster, and allocating shards to nodes, among other tasks.
- **Data Node**: Responsible for storing data and performing data-related operations such as searches and aggregations. Data nodes handle the load related to data storage and querying.
- **Coordinating Node**: Responsible for receiving client requests, dispatching requests to the appropriate data nodes, and collecting results to return to the client. By default, every node is a coordinating node, but specific nodes can be designated as coordinating nodes through configuration.
- **Ingest Node**: Responsible for executing pre-processing pipelines, transforming and enriching documents. Ingest nodes perform pre-processing on documents before they are indexed.


> https://www.elastic.co/guide/en/elasticsearch/reference/8.14/troubleshooting.html
Expand Down
6 changes: 3 additions & 3 deletions catalog/elasticsearch/apps/elasticsearch.app/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ i18n:
description: >-
Elasticsearch is a distributed, RESTful search and analytics engine that centrally stores your data so you can search, index, and analyze data of all shapes and sizes.
dashboard:
- id: juicefs
name: JuiceFS 监控面板
- id: elasticsearch
name: Elasticsearch 监控面板
i18n:
en: JuiceFS Dashboard
en: Elasticsearch Dashboard
29 changes: 25 additions & 4 deletions catalog/elasticsearch/x-definitions/app-elasticsearch.cue
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

template: {
_ingressHost: context["name"] + "-" + context["namespace"] + "." + context["ingress.root_domain"]
_kibanaIngressHost: context["name"] + "-kibana-" + context["namespace"] + "." + context["ingress.root_domain"]
output: {
apiVersion: "core.oam.dev/v1beta1"
kind: "Application"
Expand Down Expand Up @@ -136,6 +137,18 @@ template: {
},
]
},
if parameter.kibana.enabled {
{
host: _kibanaIngressHost
paths: [
{
path: "/"
serviceName: "elasticsearch-kibana"
servicePort: 5601
},
]
},
}
]
tls: [
{
Expand All @@ -144,6 +157,14 @@ template: {
]
tlsSecretName: context["ingress.tls_secret_name"]
},
if parameter.kibana.enabled {
{
hosts: [
_kibanaIngressHost,
]
tlsSecretName: context["ingress.tls_secret_name"]
},
}
]
}
type: "bdos-ingress"
Expand Down Expand Up @@ -218,14 +239,14 @@ template: {
// +ui:order=1
master: {
// +minimum=1
// +ui:description=master 节点数量, 建议生产环境设置为 3
// +ui:description=master 节点数量, 建议生产环境配置3个
// +ui:order=1
replicaCount: *1 | int

// +ui:title=存储配置
// +ui:order=2
persistence: {
// +ui:description=是否启用持久化存储, 建议生产环境设置为 true
// +ui:description=是否启用持久化存储, 建议生产环境设置为true
// +ui:order=1
enabled: *true | bool

Expand Down Expand Up @@ -405,7 +426,7 @@ template: {
enabled: *false | bool

// +minimum=0
// +ui:description=master 节点数量, 建议生产环境设置为 3
// +ui:description=节点数量, 建议生产环境配置2个起
// +ui:order=2
replicaCount: *0 | int

Expand Down Expand Up @@ -455,7 +476,7 @@ template: {
enabled: *false | bool

// +minimum=0
// +ui:description=master 节点数量, 建议生产环境设置为 3
// +ui:description=节点数量, 建议生产环境配置2个起
// +ui:hidden={{rootFormData.kibana.enabled == false}}
// +ui:order=2
replicaCount: *1 | int
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"ctx-setting-juicefs": {
"ctx-setting-elasticsearch": {
description: ""
type: "xdefinition"
attributes: {
Expand Down

0 comments on commit 38bb5f2

Please sign in to comment.