0
Fork 0
mirror of https://github.com/penpot/penpot-helm.git synced 2024-12-22 05:32:59 -05:00
penpot-helm/devel/README.md
2024-11-15 20:46:32 +01:00

74 lines
2.1 KiB
Markdown

# Penpot Helm Chart: Devel doc
### Requirements:
- [docker](https://docs.docker.com/engine/install/)
- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
- [helm](https://helm.sh/docs/intro/install/)
- [helm-doc](https://github.com/norwoodj/helm-docs/tree/master)
- [pre-commit](https://pre-commit.com/)
### Set the environment:
```shell
# Enable precommit in the repository
pre-commit install --install-hooks -f
```
### Usage:
- Create the cluster `penpot-cluster` with a namespace `penpot`:
```shell
./scripts/cluster_create.sh
```
- Download dependencies (only the first time or for an upgrade).
```shell
helm repo add bitnami https://charts.bitnami.com/bitnami
helm dependency build ./charts/penpot
```
- Create a local copy of the custom settings file.
```shell
cp devel/penpot.values.yaml local.penpot.values.yaml
```
You can edit and customize your copy as your wish.
- Install the chart.
```shell
helm install penpot ./charts/penpot -f local.penpot.values.yaml
```
Use `upgrade` to install a new version or applay changes in the settings file.
- Check status.
```shell
kubectl get all,pvc,ingress,pdb -o wide
```
- Access to [http://penpot.example.com/](http://penpot.example.com/).
> [!NOTE]
> You need to add `127.0.1.1 penpot.example.com` to `/etc/hosts`
> [!TIP]
> if you disable ingress, you can exposing the app in the port 8888 with:
> ```shell
> kubectl port-forward service/penpot 8888:80
> ```
- Stop and delete cluster.
```shell
./scripts/cluster_delete.sh
```
### Troubleshooting:
- ```
Error: INSTALLATION FAILED: 1 error occurred:
* Internal error occurred: failed calling webhook "validate.nginx.ingress.kubernetes.io": failed to call webhook: Post "https://ingress-nginx-controller-admission.ingress-nginx.svc:443/networking/v1/ingresses?timeout=10s": dial tcp 10.96.81.208:443: connect: connection refused
```
This error appears after install penpot helm. To ignore it, run:
```
kubectl delete ValidatingWebhookCOnfiguration ingress-nginx-admission
```