Skip to content

Commit

Permalink
Added helm repo push to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
sergeyberezansky committed Jan 21, 2021
1 parent 0629a3f commit a6b0b14
Show file tree
Hide file tree
Showing 13 changed files with 319 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
# limitations under the License.

CMDS=wekafsplugin
all: build container push
all: build container push helm

include release-tools/build.make
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ This repository hosts the CSI WekaFS driver and all of its build and dependent c
- Weka system pre-configured and Weka client installed and registered in cluster for each Kubernetes node

## Deployment
- [Helm public repo](https://artifacthub.io/packages/helm/csi-wekafs/csi-wekafsplugin) (recommended)
- [Script-based deployment](docs/deploy.md)
- [Helm-based deployment](deploy/helm/csi-wekafsplugin/Readme.md)
- [Helm-based local deployment](deploy/helm/csi-wekafsplugin/LOCAL.md)

## Usage
- [Deploy an Example application](docs/usage.md)
Expand All @@ -24,3 +25,27 @@ If you want to build the driver yourself, you can do so with the following comma
```shell
make build
```

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controllerPluginTolerations[0].effect | string | `"NoSchedule"` | |
| controllerPluginTolerations[0].key | string | `"node-role.kubernetes.io/master"` | |
| controllerPluginTolerations[0].operator | string | `"Exists"` | |
| csiDriverName | string | `"csi.weka.io"` | |
| csiDriverVersion | string | `"0.6.3"` | |
| dynamicProvisionPath | string | `"csi-volumes"` | |
| globalPluginTolerations[0].effect | string | `"NoSchedule"` | |
| globalPluginTolerations[0].key | string | `"node-role.kubernetes.io/master"` | |
| globalPluginTolerations[0].operator | string | `"Exists"` | |
| images.attachersidecar | string | `"quay.io/k8scsi/csi-attacher:v3.0.0-rc1"` | |
| images.csidriver | string | `"quay.io/weka.io/csi-wekafs"` | |
| images.csidriverTag | string | `"0.6.3"` | |
| images.livenessprobesidecar | string | `"quay.io/k8scsi/livenessprobe:v1.1.0"` | |
| images.provisionersidecar | string | `"quay.io/k8scsi/csi-provisioner:v1.6.0"` | |
| images.registrarsidecar | string | `"quay.io/k8scsi/csi-node-driver-registrar:v1.3.0"` | |
| images.resizersidecar | string | `"quay.io/k8scsi/csi-resizer:v0.5.0"` | |
| nodePluginTolerations[0].effect | string | `"NoSchedule"` | |
| nodePluginTolerations[0].key | string | `"node-role.kubernetes.io/master"` | |
| nodePluginTolerations[0].operator | string | `"Exists"` | |
14 changes: 13 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Release 0.6.3
## New Features
- Deployment supported via Helm public repo
- Repository listed on ArtifactHub

## Improvements
- Fixed version strings SymVer2 compatibility
- Added values.schema.json
- Added post-installation notes
- Added documentation on values

# Release 0.6.2
## New Features
- Separation of controller and node plugin components for increased performance and stability
Expand All @@ -23,8 +34,9 @@ the previous version has to be uninstalled first:
```

Then, a new version can be deployed, by following either one of the procedures below:
- [helm public repo](https://artifacthub.io/packages/helm/csi-wekafs/csi-wekafsplugin) (recommended)
- [deploy script](./README.md)
- [helm chart](./deploy/helm/csi-wekafsplugin/Readme.md)
- [helm local installation](deploy/helm/csi-wekafsplugin/LOCAL.md)


# Release 0.5.0
Expand Down
11 changes: 7 additions & 4 deletions deploy/helm/csi-wekafsplugin/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
apiVersion: v2
name: csi-wekafsplugin
description: A Helm chart for Deploy Weka wekafs CSI plugin
icon: https://www.weka.io/wp-content/themes/wekaio/templates/assets/images/navigation/new-logo.png
description: Helm chart for Deployment of WekaIO Container Storage Interface (CSI) plugin for WekaFS - the world fastests filesystem
sources:
- https://github.com/weka/csi-wekafs/tree/v0.6.3/deploy/helm/csi-wekafsplugin
home: https://github.com/weka/csi-wekafs
icon: https://weka.github.io/csi-wekafs/logo.png

# A chart can be either an 'application' or a 'library' chart.
#
Expand All @@ -15,8 +18,8 @@ type: application

# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
version: "v0.6.2"
version: "0.6.3"

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application.
appVersion: "0.6.2-0"
appVersion: "0.6.3"
File renamed without changes.
23 changes: 23 additions & 0 deletions deploy/helm/csi-wekafsplugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/csi-wekafs)](https://artifacthub.io/packages/search?repo=csi-wekafs)
# CSI WekaFS Driver

This repository hosts the CSI WekaFS driver and all of its build and dependent configuration files to deploy the driver.

## Pre-requisite
- Kubernetes cluster of version 1.18 and up, 1.19 and up recommended, 1.13 and up should work but were not tested.
- Helm v3 must be installed and configured properly
- Weka system pre-configured and Weka client installed and registered in cluster for each Kubernetes node

## Deployment
```shell
helm repo add csi-wekafs https://weka.github.io/csi-wekafs
helm install csi-wekafs csi-wekafs/csi-wekafsplugin --namespace csi-wekafsplugin --create-namespace
```

## Usage
- [Deploy an Example application](https://github.com/weka/csi-wekafs/blob/master/docs/usage.md)

## Additional Documentation
- [Official Weka CSI Plugin documentation](https://docs.weka.io/appendix/weka-csi-plugin)

10 changes: 10 additions & 0 deletions deploy/helm/csi-wekafsplugin/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Thank you for installing {{ .Chart.Name }}.

Your release is named {{ .Release.Name }}.

To learn more about the release, try:

$ helm status {{ .Release.Name }}
$ helm get all {{ .Release.Name }}

Official Weka CSI Plugin documentation can be found here: https://docs.weka.io/appendix/weka-csi-plugin
104 changes: 104 additions & 0 deletions deploy/helm/csi-wekafsplugin/values.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"controllerPluginTolerations": {
"type": "array",
"description": "CSI Controller component tolerations",
"items": {
"type": "object",
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"csiDriverName": {
"type": "string",
"description": "Override name of CSI driver"
},
"csiDriverVersion": {
"type": "string"
},
"dynamicProvisionPath": {
"type": "string",
"description": "Root path of dynamic volumes (relative to filesystem root)"
},
"globalPluginTolerations": {
"type": "array",
"description": "Global tolerations for all plugin components",
"items": {
"type": "object",
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"images": {
"type": "object",
"properties": {
"attachersidecar": {
"type": "string",
"description": "Path to Docker image of attachersidecar container"
},
"csidriver": {
"type": "string",
"description": "Path to Docker image of csidriver container"
},
"csidriverTag": {
"type": "string",
"description": "Path to Docker image of csidriverTag container"
},
"livenessprobesidecar": {
"type": "string",
"description": "Path to Docker image of livenessprobesidecar container"
},
"provisionersidecar": {
"type": "string",
"description": "Path to Docker image of provisionersidecar container"
},
"registrarsidecar": {
"type": "string",
"description": "Path to Docker image of registrarsidecar container"
},
"resizersidecar": {
"type": "string",
"description": "Path to Docker image of resizersidecar container"
}
}
},
"nodePluginTolerations": {
"type": "array",
"description": "CSI Node component tolerations",
"items": {
"type": "object",
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
}
}
}
2 changes: 1 addition & 1 deletion deploy/helm/csi-wekafsplugin/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ dynamicProvisionPath: "csi-volumes"
# name of the driver
# note same name will be used for provisioner name
csiDriverName : "csi.weka.io"
csiDriverVersion : &csiDriverVersion "0.6.2-0"
csiDriverVersion : &csiDriverVersion "0.6.3"

# Image paths
images:
Expand Down
4 changes: 2 additions & 2 deletions deploy/kubernetes-1.18/wekafs/csi-wekafs-plugin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ spec:
serviceAccountName: csi-wekafsplugin-controller
containers:
- name: wekafs
image: quay.io/weka.io/csi-wekafs:v0.6.2-0
image: quay.io/weka.io/csi-wekafs:v0.6.3
imagePullPolicy: Always
args:
- "--drivername=csi.weka.io"
Expand Down Expand Up @@ -347,7 +347,7 @@ spec:
name: csi-data-dir

- name: wekafs
image: quay.io/weka.io/csi-wekafs:v0.6.2-0
image: quay.io/weka.io/csi-wekafs:v0.6.3
imagePullPolicy: Always
args:
- "--drivername=csi.weka.io"
Expand Down
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ require (
github.com/google/uuid v1.1.1
github.com/kubernetes-csi/csi-lib-utils v0.7.0
github.com/kubernetes-csi/docs v0.0.0-20200714231321-af397c0c87a7 // indirect
github.com/norwoodj/helm-docs v1.5.0 // indirect
github.com/pkg/xattr v0.4.1
golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553
google.golang.org/grpc v1.26.0
Expand Down
Loading

0 comments on commit a6b0b14

Please sign in to comment.