Merge pull request #201 from hhyasdf/doc/update-charts

doc: update docs about helm charts

.github/workflows/helm.yml

@@ -0,0 +1,33 @@
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      - name: Install Helm
+        uses: azure/setup-helm@v1
+        with:
+          version: v3.7.1
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        with:
+          charts_dir: charts
+          config: charts/chart-release-config.yaml
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

README.md

@@ -3,8 +3,9 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/alibaba/hybridnet)](https://goreportcard.com/report/github.com/alibaba/hybridnet)
 [![Github All Releases](https://img.shields.io/docker/pulls/hybridnetdev/hybridnet.svg)](https://hub.docker.com/r/hybridnetdev/hybridnet/tags)
 [![Version](https://img.shields.io/github/v/release/alibaba/hybridnet)](https://github.com/alibaba/hybridnet/releases)
-[![codecov](https://codecov.io/gh/alibaba/hybridnet/branch/main/graphs/badge.svg)](https://codecov.io/gh/alibaba/hybridnet)
+[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/hybridnet)](https://artifacthub.io/packages/search?repo=hybridnet)
 [![License](https://img.shields.io/github/license/alibaba/hybridnet)](https://www.apache.org/licenses/LICENSE-2.0.html)
+[![codecov](https://codecov.io/gh/alibaba/hybridnet/branch/main/graphs/badge.svg)](https://codecov.io/gh/alibaba/hybridnet)
 ![workflow check](https://github.com/alibaba/hybridnet/actions/workflows/check.yml/badge.svg)
 ![workflow build](https://github.com/alibaba/hybridnet/actions/workflows/build.yml/badge.svg)
 
@@ -30,7 +31,7 @@ Hybridnet focus on productive large-scale, user friendliness and heterogeneous i
 
 ## How-To-Use
 
-Directions is maintained on [wiki](https://github.com/alibaba/hybridnet/wiki).
+See documents on [wiki](https://github.com/alibaba/hybridnet/wiki).
 
 ## Contributing
 

charts/chart-release-config.yaml

@@ -0,0 +1 @@
+release-name-template: helm-chart-{{ .Version }}

charts/hybridnet/Chart.yaml

@@ -2,15 +2,17 @@ apiVersion: v2
 name: hybridnet
 # When the version is modified, make sure the artifacthub.io/changes list is updated
 # Also update CHANGELOG.md
-version: 0.1.0
-appVersion: 0.4.1
+version: 0.1.1
+appVersion: 0.4.2
 home: https://github.com/alibaba/hybridnet
 description: A container networking solution aiming at hybrid clouds.
 keywords:
-  - containernetworking
+  - network
   - vlan
   - bgp
   - vxlan
+  - cni
+  - kubernetes
 sources:
   - https://github.com/alibaba/hybridnet
 type: application

charts/hybridnet/README.md

@@ -1 +1,59 @@
-# hybridnet
+# hybridnet
+
+hybridnet is an open source container networking solution designed for hybrid clouds.
+
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-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)
+
+## Prerequisites
+
+- Kubernetes v1.16+
+
+## Get Repo Info
+
+```shell
+helm repo add hybridnet https://alibaba.github.io/hybridnet/
+helm repo update
+```
+
+## Install Chart
+
+**Important:** only helm3 is supported
+
+```shell
+helm install hybridnet hybridnet/hybridnet -n kube-system
+```
+The command deploys hybridnet on the Kubernetes cluster in the default configuration.
+
+_See [configuration](#configuration) below._
+
+_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
+
+## Upgrade Chart
+
+```shell
+helm upgrade hybridnet hybridnet/hybridnet -n kube-system
+```
+
+_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
+
+## Configuration
+
+To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml),
+or run these configuration commands:
+
+```shell
+helm show values hybridnet/hybridnet
+```
+
+### Change default network type
+
+After deploying hybridnet with the default configuration, you can change the default network type any 
+time with these commands:
+
+```shell
+# Change default network type to Underlay
+helm upgrade hybridnet hybridnet/hybridnet -n kube-system --set advancedSettings.defualtNetworkType=Underlay
+```
+
+Of course, if you want to change your container network to use Underlay as default network type, you should
+apply some Underlay _Network/Subnet_ CR resources firstly.

charts/hybridnet/values.yaml

@@ -1,7 +1,7 @@
 images:
   hybridnet:
     image: hybridnetdev/hybridnet
-    tag: v0.4.1
+    tag: v0.4.2
   registryURL: "docker.io"
 
 # -- It's always encouraged to use an overlay network to finish some general jobs in hybridnet. This