mirror of
https://gitlab.com/bramw/baserow.git
synced 2025-04-04 21:25:24 +00:00
Resolve "Test and document community helm chart"
This commit is contained in:
Nigel Gott
parent
4870dddce5
commit
a4e7e5fef1
8 changed files with 74 additions and 5 deletions
|
|
@ -6,8 +6,7 @@
|
|||
|
||||
### Merge Request Checklist
|
||||
|
||||
- [ ] [changelog.md](https://gitlab.com/bramw/baserow/-/blob/develop/changelog.md) has
|
||||
been updated if required.
|
||||
- [ ] A changelog entry has been added to `changelog/entries/unreleased` using `changelog/src/changelog.py`
|
||||
- [ ] New/updated **Premium/Enterprise features** are separated correctly in the premium or enterprise folder
|
||||
- [ ] The latest **Chrome and Firefox** have been used to test any new frontend features
|
||||
- [ ] [Documentation](https://gitlab.com/bramw/baserow/-/tree/develop/docs) has been
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ repository on GitHub, but this is not the official one.
|
|||
* JavaScript code must be compliant with the eslint:recommended rules.
|
||||
* In code documentation is required for every function or class that is not self-evident.
|
||||
* Documentation for every concept that can used by a plugin.
|
||||
* [changelog.md](changelog.md) should be updated with any new features.
|
||||
* A new changelog entry file should be generated using the script found in the changelog folder.
|
||||
* The pipeline must pass.
|
||||
* Try to apply the **rule of 10s**: MRs should aim to have no more than 10 code files with more than 10 lines modified.
|
||||
A code file doesn't include tests/css/text/migrations/translations/configuration/ etc.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"type": "feature",
|
||||
"message": "Add links in docs to new community maintained Baserow helm chart at https://artifacthub.io/packages/helm/christianknell/baserow.",
|
||||
"issue_number": 1549,
|
||||
"bullet_points": [],
|
||||
"created_at": "2023-02-15"
|
||||
}
|
||||
|
|
@ -18,6 +18,8 @@ Baserow by following one the guides below:
|
|||
install Baserow using docker.
|
||||
* [Install with Docker Compose](installation/install-with-docker-compose.md): A
|
||||
step-by-step guide to install Baserow using Docker Compose.
|
||||
* [Install with Helm](installation/install-with-helm.md): A community maintained helm
|
||||
chart for installing Baserow on a K8S cluster easily.
|
||||
* [Install using Standalone images](installation/install-using-standalone-images.md): A
|
||||
general overview on how to run the Baserow standalone service images with your own
|
||||
container orchestration software.
|
||||
|
|
|
|||
|
|
@ -124,7 +124,6 @@ The installation methods referred to in the variable descriptions are:
|
|||
| BASEROW\_MAX\_FILE\_IMPORT\_ERROR\_COUNT | The max number of per row errors than can occur in a file import before an overall failure is declared | 30 |
|
||||
| MINUTES\_UNTIL\_ACTION\_CLEANED\_UP | How long before actions are cleaned up, actions are used to let you undo/redo so this is effectively the max length of time you can undo/redo can action. | 120 |
|
||||
| BASEROW\_DISABLE\_MODEL\_CACHE | When set to any non empty value the model cache used to speed up Baserow will be disabled. Useful to enable when debugging Baserow errors if they are possibly caused by the model cache itself. | | |
|
||||
| BASEROW\_IMPORT\_TOLERATED\_TYPE\_ERROR\_THRESHOLD | The percentage of rows when importing that are allowed to not match the detected column type and be blanked out instead of imported when creating a table. | 0 |
|
||||
| | | |
|
||||
| DJANGO\_SETTINGS\_MODULE | **INTERNAL** The settings python module to load when starting up the Backend django server. You shouldn’t need to set this yourself unless you are customizing the settings manually. | |
|
||||
| | | |
|
||||
|
|
|
|||
52
docs/installation/install-with-helm.md
Normal file
52
docs/installation/install-with-helm.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# Install with Helm
|
||||
|
||||
## Community Maintained Helm Chart
|
||||
|
||||
Find the community
|
||||
Baserow [helm chart here](https://artifacthub.io/packages/helm/christianknell/baserow)
|
||||
maintained
|
||||
by [ Christian Knell](https://github.com/christianknell/).
|
||||
|
||||
We recommend that you:
|
||||
|
||||
1. Run the chart with ingress enabled:
|
||||
2. `backend.ingress.enabled=true`
|
||||
3. `frontend.ingress.enabled=true`
|
||||
4. Make sure you configure two domains, one for the backend api API one for the frontend
|
||||
server.
|
||||
5. Set `config.publicFrontendUrl=https://your-baserow-servers-domain.com`
|
||||
5. Set `config.publicBackendUrl=https://api.your-baserow-servers-domain.com`
|
||||
6. Configure all the relevant `backend.config.aws` variables to upload and serve user
|
||||
files in a S3 compatible service of your own choosing.
|
||||
|
||||
### Deploying Baserow using Helm and K3S
|
||||
|
||||
[K3S](https://k3s.io/) is an easy way of getting a local K8S cluster running locally for
|
||||
testing and development. This guide will walk you through setting it K3S with Baserow
|
||||
using the community helm chart above.
|
||||
|
||||
1. Install [K3S](https://docs.k3s.io/quick-start)
|
||||
2. Install [Helm](https://helm.sh/docs/helm/helm_install/)
|
||||
3. Configure Helm to use your K3S cluster:
|
||||
|
||||
```bash
|
||||
# From https://devops.stackexchange.com/questions/16043/error-error-loading-config-file-etc-rancher-k3s-k3s-yaml-open-etc-rancher
|
||||
export KUBECONFIG=~/.kube/config
|
||||
mkdir ~/.kube 2> /dev/null
|
||||
# Make sure you aren't overriding an existing k8s configuration in ~/.kube/config
|
||||
(set -o noclobber; sudo k3s kubectl config view --raw > "$KUBECONFIG")
|
||||
chmod 600 "$KUBECONFIG"
|
||||
# Check you can access the cluster
|
||||
helm ls --all-namespaces
|
||||
# You should see something like
|
||||
# NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
|
||||
```
|
||||
|
||||
4. Install Baserow using Helm
|
||||
|
||||
```bash
|
||||
helm repo add christianknell https://christianknell.github.io/helm-charts
|
||||
helm repo update
|
||||
helm install 1.5.3 christianknell/baserow
|
||||
# Finally follow the printed instructions.
|
||||
```
|
||||
|
|
@ -1,5 +1,12 @@
|
|||
# Install with K8S
|
||||
|
||||
## Community Maintained Helm Chart
|
||||
|
||||
We recommend you use the [community maintained helm chart](./install-with-helm.md) to
|
||||
install Baserow on K8S.
|
||||
|
||||
## Raw K8S starting point
|
||||
|
||||
See below for a starting point for a K8S configuration file which deploys a production
|
||||
ready Baserow.
|
||||
|
||||
|
|
@ -10,6 +17,9 @@ You will need to also provide a redis and postgres instance configured using the
|
|||
environment variables below. See [Configuring Baserow](./configuration.md) for more
|
||||
details on these variables.
|
||||
|
||||
You should also set up and configure Baserow to use an S3 compatible storage service
|
||||
for uploading and serving user uploaded files.
|
||||
|
||||
## Example baserow.yml
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Software versions are divided into the following groups:
|
|||
|
||||
## Web browsers
|
||||
|
||||
### Baserow 1.10.2
|
||||
### Baserow 1.14.0
|
||||
|
||||
Browser | Supported versions | Recommended versions
|
||||
----------------|--------------------|--------------------
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue