chore(release): v2.0.2

Author: MisterTimn

community-solid-server/Chart.yaml

@@ -15,7 +15,7 @@ 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.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.0.1
+version: 2.0.2
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
@@ -33,5 +33,3 @@ maintainers:
     name: jveessen
 sources:
   - https://github.com/solid/community-server
-
-

community-solid-server/README.md

@@ -1,21 +1,27 @@
 # Deploying Community Solid Server
+
 ## TL;DR
-```
+
+```bash
 helm repo add community-solid-server https://communitysolidserver.github.io/css-helm-chart/charts/
 helm install my-css community-solid-server/community-solid-server
 ```
+
 ## Introduction
+
 This chart bootstraps a [Community Solid Server](https://github.com/CommunitySolidServer/CommunitySolidServer) deployment on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
 
 ## Prerequisites
+
 - Kubernetes 1.19+
 - Helm 3.2.0+
 - PV provisioner support in the underlying infrastructure if you want to use Persistence functionality.
 
 ## Installing the Chart
+
 To install the chart with the release name my-css:
 
-```
+```bash
 helm repo add idlab-gent https://communitysolidserver.github.io/css-helm-chart/charts/
 helm install my-css community-solid-server/community-solid-server
 ```
@@ -25,9 +31,10 @@ These commands deploy Community Solid Server on the Kubernetes cluster in the de
 > Tip: List all releases using `helm list`
 
 ## Uninstalling the Chart
+
 To uninstall/delete the my-css deployment:
 
-```
+```bash
 helm delete my-css
 ```
 
@@ -45,15 +52,13 @@ The command removes all the Kubernetes components associated with the chart and
 | `image.pullPolicy`  | CSS image pull policy                            | `IfNotPresent`                  |
 | `image.pullSecrets` | Specify docker-registry secret names as an array | `[]`                            |
 
-
 ### Common parameters
 
 | Name               | Description                               | Value |
 | ------------------ | ----------------------------------------- | ----- |
 | `nameOverride`     | String to partially override css.fullname | `""`  |
 | `fullnameOverride` | String to fully override css.fullname     | `""`  |
 
-
 ### Community Solid Server parameters
 
 | Name                   | Description                                                                                                                                                         | Value     |
@@ -67,7 +72,6 @@ The command removes all the Kubernetes components associated with the chart and
 | `baseUrlOverride`      | From the helm config, an appropriate --baseUrl value will be passed to the community server. If however you wish to override this set this parameter appropriately. | `""`      |
 | `customParameters`     | An array of `flag` `value` pairs to be added to the CSS cli command for custom parameters/overwrites.                                                               | `[]`      |
 
-
 ### Persistence parameters
 
 | Name                           | Description                                                                         | Value   |
@@ -79,7 +83,6 @@ The command removes all the Kubernetes components associated with the chart and
 | `persistence.size`             | CSS persistent volume size                                                          | `128Mi` |
 | `persistence.selector`         | Selector to match an existing Persistent Volume                                     | `{}`    |
 
-
 ### Kubernetes Service parameters
 
 | Name               | Description                                                                     | Value       |
@@ -88,7 +91,6 @@ The command removes all the Kubernetes components associated with the chart and
 | `service.port`     | CSS Kubernetes service port                                                     | `80`        |
 | `service.nodePort` | CSS Kubernetes service node port, only relevant when service.type == `NodePort` | `""`        |
 
-
 ### Ingress resource parameters
 
 | Name                       | Description                                                                                                                      | Value       |
@@ -98,8 +100,7 @@ The command removes all the Kubernetes components associated with the chart and
 | `ingress.path`             | Default path for the ingress resource                                                                                            | `/`         |
 | `ingress.annotations`      | Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations. | `{}`        |
 | `ingress.tls`              | TLS Configuration                                                                                                                | `[]`        |
-| `ingress.className` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)                                                    | `""`        |
-
+| `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)                                                    | `""`        |
 
 ### Infrastructure parameters
 
@@ -114,33 +115,12 @@ The command removes all the Kubernetes components associated with the chart and
 | `tolerations`        | Tolerations for pod assignment             | `[]`  |
 | `affinity`           | Affinity for pod assignment                | `{}`  |
 
-
-Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
-```
-helm install my-css \
-  --set config.bundled=file \
-  idlab-gent/css
-```
-The above command deploys Community Solid Server with the bundled `file` config.
-
-Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
-
-```
-helm install my-css -f values.yaml idlab-gent/css
-```
-> Tip: You can use the default values.yaml
-
-You can even mix these two modes to override values from your YAML file with the `--set` argument. For example,
-
-```
-helm install my-css -f values.yaml --set config.bundled=file idlab-gent/css
-```
-> This can be useful when trying out config changes or to enable debug logging for temporarily.
-
 # Configuration and Installation details
 
 ## Using a bundled config
+
 To use any of the bundled configs of CSS, specify which config to use by overriding `config.bundled` with any of the following values:
+
 - default (default)
 - dynamic
 - example-https-file
@@ -154,19 +134,23 @@ To use any of the bundled configs of CSS, specify which config to use by overrid
 - sparql-file-storage
 
 ## Using a custom config
+
 To use a custom config, the `config.configMapName` and `config.configMapKey` variables are used.
 
 First create a configmap resource to hold your config on the cluster. For example when you have a json file called `my-config.json`:
+
 ```
 kubectl create configmap my-configmap --from-file my-config.json
 ```
 
 Alternatively when you have multiple configs in a directory called `my-configs`, you can bundle a whole directory into one configmap like so:
+
 ```
 kubectl create configmap my-configmap --from-file my-configs/
 ```
 
 Then override this name and key values accordingly (key of the config will be the same as the filename), for example:
+
 ```yaml
 config:
     configMapName: my-configmap