Skip to content

Commit

Permalink
Merge pull request #176 from tqtezos/update-readme
Browse files Browse the repository at this point in the history
Add detail for development readme
  • Loading branch information
orcutt989 authored Mar 30, 2021
2 parents c24fb6f + c517566 commit 6711c69
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
- [Prerequisites](#prerequisites)
- [Helm Chart Development](#helm-chart-development)
- [Prerequisites](#prerequisites)
- [Using devspace](#using-devspace)
- [Notes](#notes)
- [Helm Charts](#helm-charts)
- [Creating Charts](#creating-charts)
- [Run local development chart](#run-local-development-chart)
- [Notes](#notes-1)
- [Creating Docker Images](#creating-docker-images)
- [Releases](#releases)
Expand Down Expand Up @@ -59,7 +61,7 @@ Devspace will now do a few things:

- Devspace recommends to run [devspace purge](https://devspace.sh/cli/docs/commands/devspace_purge) to delete deployments. Keep in mind though that it currently does not delete persistent volumes and claims. They currently don't mention this in their docs. If you want to delete all resources including persistent volumes and claims, run `kubectl delete namespace <NAMESPACE>`. Even with this command, there are times where PV's/PVC's do not get deleted. This is important to know because you may be spinning up nodes that get old volumes attached with old state, and you may encounter Tezos pod errors. I have experienced this in situations where I left my cluster running for a long time, say overnight, and I shut my laptop and/or it went to sleep. After logging back in and deleting the namespace, the PV's/PVC's are still there and need to be manually deleted.

- If you would like to build all of our images without using Devspace to deploy (you might want to do a `helm install` instead), you can run `devspace build -t dev`.
- If you would like to build all of our images without using Devspace to deploy (you might want to do a `helm install` instead), you can run `devspace build -t dev --skip-push`.

- Due to a current limitation of devspace, multiple profiles cannot be used at one time. Therefore, devspace will watch `zerotier` files even if tezos nodes are not configured to use it via `mkchain`. Preferably `zerotier` would also be a profile in addition to `rpc-auth` being one.

Expand All @@ -77,6 +79,14 @@ Regarding chart dependencies, Chart.yaml should not specify a dependency version

Being that all charts are bumped to the same version on release, the parent chart will get the latest version of the dependency by default (which is the same as its own version) when installing via our Helm chart [repo](https://github.com/tqtezos/tezos-helm-charts).

## Run local development chart

Instructions as per README install the latest release of tezos-k8s helm chart from a helm repository. To install a development version of a tezos chart in the charts/tezos directory instead, run:

```
helm install tezos-mainnet charts/tezos --namespace tqtezos --create-namespace
```

## Notes

If you use `helm install|upgrade` (instead of devspace) for local charts, make sure you `helm dependency update <chart>` to get the latest local dependency chart changes that you've made packaged into the parent chart.
Expand Down

0 comments on commit 6711c69

Please sign in to comment.