Skip to content

Commit

Permalink
chore: improve description and add app-version for readme (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
ldming authored Nov 13, 2023
1 parent f80d7d7 commit b21facb
Show file tree
Hide file tree
Showing 20 changed files with 83 additions and 73 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @nayutah @ldming
* @nayutah @ldming @heng4fun @free6om @wangyelei @leon-inf @shanshanying
71 changes: 35 additions & 36 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion addons/elasticsearch/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: elasticsearch
description: A Helm chart for elasticsearch
description: Elasticsearch is a distributed, RESTful search engine optimized for speed and relevance on production-scale workloads.

# A chart can be either an 'application' or a 'library' chart.
#
Expand Down
2 changes: 1 addition & 1 deletion addons/greptimedb/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: greptimedb
description: GreptimeDB Cluster Helm Chart for KubeBlocks.
description: An open-source, cloud-native, distributed time-series database with PromQL/SQL/Python supported.

# This is the chart version
version: 0.1.0-beta.1
Expand Down
3 changes: 1 addition & 2 deletions addons/kafka/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
apiVersion: v2
name: kafka
description: Apache Kafka is a distributed streaming platform designed to build real-time pipelines and can be used as a message
broker or as a replacement for a log aggregation solution for big data applications. This chart provides KubeBlocks'
ClusterDefinition API manifests.
broker or as a replacement for a log aggregation solution for big data applications.

annotations:
category: Infrastructure
Expand Down
2 changes: 1 addition & 1 deletion addons/llm/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: llm
description: A Helm chart for Kubernetes
description: Large language models.

# A chart can be either an 'application' or a 'library' chart.
#
Expand Down
2 changes: 1 addition & 1 deletion addons/mariadb/templates/clusterversion.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: apps.kubeblocks.io/v1alpha1
kind: ClusterVersion
metadata:
name: mariadb
name: mariadb-{{ default .Chart.AppVersion .Values.clusterVersionOverride }}
spec:
clusterDefinitionRef: mariadb
componentVersions:
Expand Down
2 changes: 1 addition & 1 deletion addons/milvus/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: milvus
description: .
description: A cloud-native vector database, storage for next generation AI applications.

type: application

Expand Down
2 changes: 1 addition & 1 deletion addons/nebula/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: nebula
description: Nebula Graph Cluster Helm Chart for KubeBlocks.
description: NebulaGraph is a popular open-source graph database that can handle large volumes of data with milliseconds of latency, scale up quickly, and have the ability to perform fast graph analytics.
version: 0.5.1-beta.0
appVersion: "v3.5.0"
home: https://nebula-graph.io
Expand Down
2 changes: 1 addition & 1 deletion addons/neon/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: neon
description: Neon Helm Chart for KubeBlocks.
description: Neon is a serverless open-source alternative to AWS Aurora Postgres. It separates storage and compute and substitutes the PostgreSQL storage layer by redistributing data across a cluster of nodes.
type: application
version: 0.6.0-alpha.21
appVersion: "pg14-1.0.0"
Expand Down
2 changes: 1 addition & 1 deletion addons/opensearch/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: opensearch
description: A Helm chart for OpenSearch
description: Open source distributed and RESTful search engine.

# A chart can be either an 'application' or a 'library' chart.
#
Expand Down
3 changes: 1 addition & 2 deletions addons/orioledb/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
apiVersion: v2
name: orioledb
description: A Helm chart for Kubernetes

description: OrioleDB is a new storage engine for PostgreSQL, bringing a modern approach to database capacity, capabilities and performance to the world's most-loved database platform.

type: application

Expand Down
2 changes: 1 addition & 1 deletion addons/polardbx/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: polardbx
description: PolarDB-X Cluster Helm Chart for KubeBlocks.
description: PolarDB-X is a cloud native distributed SQL Database designed for high concurrency, massive storage, complex querying scenarios.

type: application
version: 0.1.0
Expand Down
2 changes: 1 addition & 1 deletion addons/redis/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: redis
description: A Redis cluster definition Helm chart for Kubernetes
description: "Redis is an in-memory database that persists on disk. The data model is key-value, but many different kind of values are supported: Strings, Lists, Sets, Sorted Sets, Hashes, Streams, HyperLogLogs, Bitmaps."

type: application

Expand Down
2 changes: 1 addition & 1 deletion addons/risingwave/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: risingwave
description: A RisingWave Helm chart for KubeBlocks.
description: RisingWave is a distributed SQL streaming database that enables cost-efficient and reliable processing of streaming data.

annotations:
category: Database
Expand Down
2 changes: 1 addition & 1 deletion addons/starrocks/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: starrocks
description: A Helm chart for Kubernetes
description: A Linux Foundation project, is the next-generation data platform designed to make data-intensive real-time analytics fast and easy.

# A chart can be either an 'application' or a 'library' chart.
#
Expand Down
2 changes: 1 addition & 1 deletion addons/xinference/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: xinference
description: A Helm chart for Kubernetes
description: Xorbits Inference(Xinference) is a powerful and versatile library designed to serve language, speech recognition, and multimodal models.

# A chart can be either an 'application' or a 'library' chart.
#
Expand Down
2 changes: 1 addition & 1 deletion addons/xinference/templates/clusterversion.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: apps.kubeblocks.io/v1alpha1
kind: ClusterVersion
metadata:
name: xinference-latest
name: xinference-{{ default .Chart.AppVersion }}
labels:
{{- include "xinference.labels" . | nindent 4 }}
annotations:
Expand Down
18 changes: 0 additions & 18 deletions hack/gen-addons.sh

This file was deleted.

31 changes: 31 additions & 0 deletions hack/get-addons.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/bin/bash

# Initialize table header
echo "| NAME | APP-VERSION | DESCRIPTION |"
echo "| ---- | --------- | ----------- |"

# Traverse and sort directories
for d in $(find . -type d ! -name "*cluster" -not -name "common" -not -name "kblib" -not -name "neonvm" | sort); do
# Check if Chart.yaml file exists
if [[ -f "$d/Chart.yaml" ]]; then
# Use yq to read fields
name=$(yq e '.name' $d/Chart.yaml)
description=$(yq e '.description' $d/Chart.yaml)

dir_name=$(basename $d)
helm dependency build addons/$dir_name --skip-refresh > /dev/null 2>&1
version_lines=$(helm template addon addons/$dir_name | grep -A 5 'kind: ClusterVersion' | grep ' name:' | awk '{print $2}' | cut -d '-' -f 2- | sort)
versions=""
while IFS= read -r line
do
if [[ $line == v* ]]; then
line=${line:1}
fi
versions+="${line}<br>"
done <<<"$version_lines"
versions=${versions%<br>}

# Output as Markdown table row
echo "| $name | $versions | $description"
fi
done

0 comments on commit b21facb

Please sign in to comment.