diff --git a/charts/bee/Chart.yaml b/charts/bee/Chart.yaml index 154c036..b9ec2fa 100644 --- a/charts/bee/Chart.yaml +++ b/charts/bee/Chart.yaml @@ -1,23 +1,19 @@ apiVersion: v1 +appVersion: latest name: bee +version: 0.1.1 description: Ethereum Swarm Bee Helm chart for Kubernetes - -# A chart can be either an 'application' or a 'library' chart. -# -# Application charts are a collection of templates that can be packaged into versioned archives -# to be deployed. -# -# Library charts provide useful utilities or functions for the chart developer. They're included as -# a dependency of application charts to inject those utilities and functions into the rendering -# pipeline. Library charts do not define any templates and therefore cannot be deployed. +home: https://swarm.ethereum.org +icon: https://swarm-guide.readthedocs.io/en/latest/_images/swarm.png +keywords: + - blockchain + - ethereum + - storage + - swarm + - web3 +maintainers: + - name: svetomir + email: svetomir@ethereum.org +sources: + - https://github.com/ethersphere/bee 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: 0.1.0 - -# 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: latest - -# TODO: check and add keywords, home, sources, maintainers, icon diff --git a/charts/bee/README.md b/charts/bee/README.md new file mode 100644 index 0000000..5ddf132 --- /dev/null +++ b/charts/bee/README.md @@ -0,0 +1,104 @@ +# Bee Helm Chart + +[Ethereum Swarm Bee](https://github.com/ethersphere/bee) is an experiment to abstract libp2p as underlay networking for Ethereum Swarm. + +## QuickStart + +```bash +$ helm install --generate-name ethersphere/bee +``` + +## Introduction + +This chart deploys a [Ethereum Swarm Bee](https://github.com/ethersphere/bee) onto a Kubernetes cluster using the Helm package manager. It creates ConfigMap, Deployment and Service Kubernetes objects, while Ingress and ServiceAccount are optional. + +## Prerequisites + +* Kubernetes 1.15 +* Helm 3.0 + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```bash +$ helm install --name my-release ethersphere/bee +``` + +The command deploys Bee on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```bash +$ helm delete my-release +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration + +The default configuration values for this chart are listed in **values.yaml**. + +Bee specific configuration parameters can be configured in **beeConfig** section. + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```bash +$ helm install --name my-release \ + --set serviceAccount.create=true \ + ethersphere/bee +``` + +The above command creates ServiceAccount for the deployment. + +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, + +```bash +$ helm install --name my-release -f values.yaml ethersphere/bee +``` + +## Helmsman Usage + +### Prerequisites + +* Kubernetes 1.15 +* Helm 3.0 +* Helmsman 3.0 + +### Installing + +Create bee.yaml file as shown bellow: + +```yaml +namespaces: + bee: + +helmRepos: + ethersphere: "https://ethersphere.github.io/helm" + +apps: + bee: + name: bee + namespace: bee + description: "Ethereum Swarm Bee" + chart: "ethersphere/bee" + version: "0.1.1" + enabled: true + wait: true + timeout: 120 + +``` + +Execute following command: +```bash +$ helmsman -apply -f bee.yaml +``` + +### Uninstalling + +Execute following command: +```bash +$ helmsman -destroy -f bee.yaml +``` diff --git a/charts/bee/templates/deployment.yaml b/charts/bee/templates/deployment.yaml index 981f4a1..6693c96 100644 --- a/charts/bee/templates/deployment.yaml +++ b/charts/bee/templates/deployment.yaml @@ -39,7 +39,7 @@ spec: {{- end }} containers: - name: {{ .Chart.Name }} - image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}" + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" imagePullPolicy: {{ .Values.image.pullPolicy }} command: - bee diff --git a/charts/bee/values.yaml b/charts/bee/values.yaml index 9833cf2..19a8dd9 100644 --- a/charts/bee/values.yaml +++ b/charts/bee/values.yaml @@ -4,6 +4,7 @@ image: repository: ethersphere/bee + tag: latest pullPolicy: IfNotPresent imagePullSecrets: []