0
Fork 0
mirror of https://github.com/penpot/penpot-helm.git synced 2024-12-22 05:32:59 -05:00

docs: improve development documentation

This commit is contained in:
David Barragán Merino 2024-11-15 20:46:32 +01:00
parent b04d6c1ed2
commit e15aad59b4
3 changed files with 21 additions and 12 deletions

2
.gitignore vendored
View file

@ -12,3 +12,5 @@
.vscode/ .vscode/
# Dependencies # Dependencies
charts/*.tgz charts/*.tgz
# Local values files
local.*.values.yaml

View file

@ -23,28 +23,31 @@ pre-commit install --install-hooks -f
./scripts/cluster_create.sh ./scripts/cluster_create.sh
``` ```
- Download dependencies - Download dependencies (only the first time or for an upgrade).
```shell ```shell
helm repo add bitnami https://charts.bitnami.com/bitnami helm repo add bitnami https://charts.bitnami.com/bitnami
helm dependency build ./charts/penpot helm dependency build ./charts/penpot
``` ```
- Install the chart - Create a local copy of the custom settings file.
```shell ```shell
helm install penpot ./charts/penpot -f devel/penpot.values.yaml cp devel/penpot.values.yaml local.penpot.values.yaml
``` ```
You can edit and customize your copy as your wish.
- Check status - 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 ```shell
kubectl get all,pvc,ingress,pdb -o wide kubectl get all,pvc,ingress,pdb -o wide
``` ```
- Stop and delete cluster - Access to [http://penpot.example.com/](http://penpot.example.com/).
```shell
./scripts/cluster_delete.sh
```
- Access to [http://penpot.example.com/](http://penpot.example.com/) (
> [!NOTE] > [!NOTE]
> You need to add `127.0.1.1 penpot.example.com` to `/etc/hosts` > You need to add `127.0.1.1 penpot.example.com` to `/etc/hosts`
@ -54,13 +57,18 @@ pre-commit install --install-hooks -f
> kubectl port-forward service/penpot 8888:80 > kubectl port-forward service/penpot 8888:80
> ``` > ```
- Stop and delete cluster.
```shell
./scripts/cluster_delete.sh
```
### Troubleshooting: ### Troubleshooting:
- ``` - ```
Error: INSTALLATION FAILED: 1 error occurred: 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 * 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. Tu ignore it, run: This error appears after install penpot helm. To ignore it, run:
``` ```
kubectl delete ValidatingWebhookCOnfiguration ingress-nginx-admission kubectl delete ValidatingWebhookCOnfiguration ingress-nginx-admission
``` ```

View file

@ -6,8 +6,7 @@ global:
config: config:
publicUri: "http://penpot.example.com" publicUri: "http://penpot.example.com"
apiSecretKey: "my-secret-key" apiSecretKey: "my-secret-key"
flags: "enable-registration enable-login-with-password disable-email-verification enable-smtp disable-secure-session-cookies" flags: "enable-registration enable-login-with-password disable-email-verification enable-smtp disable-secure-session-cookies disable-onboarding"
#backend: #backend:
# replicaCount: 2 # replicaCount: 2