Skip to content

Commit

Permalink
detail some key configs, set up linting
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosrodfern committed Jul 13, 2024
1 parent 1c1dce8 commit c312ee9
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 3 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/lint-test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Lint and Test Charts

on: pull_request

jobs:
lint-test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set up Helm
uses: azure/[email protected]
with:
version: v3.14.4

- uses: actions/setup-python@v5
with:
python-version: '3.x'
check-latest: true

- name: Set up chart-testing
uses: helm/[email protected]

- name: Run chart-testing (list-changed)
id: list-changed
run: |
changed=$(ct list-changed --target-branch ${{ github.event.repository.default_branch }})
if [[ -n "$changed" ]]; then
echo "changed=true" >> "$GITHUB_OUTPUT"
fi
- name: Run chart-testing (lint)
if: steps.list-changed.outputs.changed == 'true'
run: ct lint --target-branch ${{ github.event.repository.default_branch }}

- name: Create kind cluster
if: steps.list-changed.outputs.changed == 'true'
uses: helm/[email protected]

- name: Run chart-testing (install)
if: steps.list-changed.outputs.changed == 'true'
run: ct install --target-branch ${{ github.event.repository.default_branch }}
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ helm repo add viseron https://carlosrodfern.github.io/viseron-helm-chart
```

If you had already added this repo earlier, run `helm repo update` to retrieve
the latest versions of the packages. You can then run `helm search repo
viseron` to see the charts.
the latest versions of the package. You can then run `helm search repo
viseron -l` to see the different versions of the chart.

To install the viseron chart:

Expand All @@ -23,4 +23,31 @@ To uninstall the chart:

```sh
helm delete my-viseron
```
```

## Configurations

There are key parts in your `values.yaml` file that you will want to define.

For example, if you want to use [VAAPI](https://viseron.netlify.app/docs/documentation/installation#running-viseron), your `values.yaml` will need to define the `dri` mount point.

```yaml
volumes:
- name: dev-dri
hostPath:
path: /dev/dri

volumeMounts:
- name: dev-dri
mountPath: /dev/dri
```
Another important one is storage with the `storage` tag. For example, setting `50Mi` for the config storage, and `200Gi` for the recordings:

```yaml
storage:
config:
size: 50Mi
data:
size: 200Gi
```

0 comments on commit c312ee9

Please sign in to comment.