Skip to content

Commit

Permalink
refactor: bump karpor version to 0.4.3, update readme (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
elliotxx authored Jul 25, 2024
1 parent bafd579 commit acb44c7
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 21 deletions.
4 changes: 2 additions & 2 deletions charts/karpor/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
apiVersion: v2
name: karpor
# The Chart Version
version: 0.5.2
version: 0.5.3
type: application
# The Application Version in the Chart
appVersion: 0.4.2
appVersion: 0.4.3
description: A Helm chart for Karpor, a modern kubernetes visualization tool.
home: https://github.com/KusionStack/karpor
icon: https://kusionstack.io/karpor/assets/logo/logo.svg
Expand Down
27 changes: 17 additions & 10 deletions charts/karpor/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Karpor Chart

![Version: 0.5.2](https://img.shields.io/badge/Version-0.5.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.2](https://img.shields.io/badge/AppVersion-0.4.2-informational?style=flat-square)
![Version: 0.5.3](https://img.shields.io/badge/Version-0.5.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.3](https://img.shields.io/badge/AppVersion-0.4.3-informational?style=flat-square)

A Helm chart for Karpor, a modern kubernetes visualization tool.

Expand All @@ -19,24 +19,31 @@ A Helm chart for Karpor, a modern kubernetes visualization tool.

## Prerequisites

- Helm v3.5.0+
- Helm v3+

## Installing the Chart

To install the chart with the release name `my-release`:
First, add the karpor chart repo to your local repository.

```bash
$ helm repo add kusionstack https://kusionstack.github.io/charts
$ helm repo update
$ helm install karpor kusionstack/karpor
```shell
helm repo add kusionstack https://kusionstack.github.io/charts
helm repo update
```

Then you can use the following command to install the latest version of Karpor.

```shell
helm install karpor-release kusionstack/karpor
```

**Note** that installing this chart directly means it will use the [default template values](./values.yaml) for Karpor.

You may have to set your specific configurations if it is deployed into a production cluster, or you want to custom configure `resources`, `replicas`, `port` etc.
You may have to set your specific configurations if it is deployed into a production cluster, or you want to customize the chart configuration, such as `resources`, `replicas`, `port` etc.

All configurable parameters of the Karpor chart are detailed [here](#chart-parameters).

```bash
$ helm install my-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
```shell
helm install karpor-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
```

## Chart Parameters
Expand Down
25 changes: 16 additions & 9 deletions charts/karpor/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,31 @@

## Prerequisites

- Helm v3.5.0+
- Helm v3+

## Installing the Chart

To install the chart with the release name `my-release`:
First, add the karpor chart repo to your local repository.

```bash
$ helm repo add kusionstack https://kusionstack.github.io/charts
$ helm repo update
$ helm install karpor kusionstack/karpor
```shell
helm repo add kusionstack https://kusionstack.github.io/charts
helm repo update
```

Then you can use the following command to install the latest version of Karpor.

```shell
helm install karpor-release kusionstack/karpor
```

**Note** that installing this chart directly means it will use the [default template values](./values.yaml) for Karpor.

You may have to set your specific configurations if it is deployed into a production cluster, or you want to custom configure `resources`, `replicas`, `port` etc.
You may have to set your specific configurations if it is deployed into a production cluster, or you want to customize the chart configuration, such as `resources`, `replicas`, `port` etc.

All configurable parameters of the Karpor chart are detailed [here](#chart-parameters).

```bash
$ helm install my-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
```shell
helm install karpor-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
```

## Chart Parameters
Expand Down

0 comments on commit acb44c7

Please sign in to comment.