diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 45ba95fe9..dabfaf398 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -48,12 +48,30 @@ Devspace will now do a few things: ## Notes +- 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 `. 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. This appears to be a minikube bug. + - 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`. - 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. - If you find that you have images built but Devspace is having a hard time getting them and/or is producing errors that don't seem to make sense, you can try `rm -rf .devspace` to remove any potentially wrong state. +# Helm Charts + +## Creating Charts + +The `version` in Chart.yaml should be `0.0.0`. This is what is stored in version control. The CI will update the version on release and store in our Helm chart repo. + +Chart.yaml does not require an `appVersion`. So we are not using it as it doesn't make sense in our context being that our application is currently a monorepo and every component version is bumped as one. The `version` field is sufficient. + +Regarding chart dependencies, Chart.yaml should not specify a dependency version for another _local_ chart. + +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). + +## Notes + +If you use `helm install|upgrade` (instead of devspace) for local charts, make sure you `helm dependency update ` to get the latest local dependency chart changes that you've made packaged into the parent chart. + # Creating Docker Images Currently, we are placing all docker images in the the root level directory. The name of the folder is treated as the name of the image being created. @@ -76,13 +94,6 @@ Here is an example of the flow for creating new images and how they are publishe context: ./chain-initiator ``` -# Creating Helm Charts -The `version` in Chart.yaml should be `0.0.0`. This is what is stored in version control. The CI will update the version on release and store in our Helm chart repo. - -Chart.yaml does not require an `appVersion`. So we are not using it as it doesn't make sense in our context being that our application is currently a monorepo and every component version is bumped as one. The `version` field is sufficient. - -Regarding chart dependencies, Chart.yaml also doesn't require a dependency version for a _local_ chart. Being that all components are bumped to the same version, the parent chart will be getting the latest version of the dependency by default (which is the same as its own version). - # Releases Upon release, every component of the tezos-k8s repo will be bumped to that version. This is regardless if there were changes or not to that particular component. This is because tezos-k8s is a monorepo and we'd like to keep the versions consistent across the different components. diff --git a/devspace.yaml b/devspace.yaml index a487bf096..6da3f8b81 100755 --- a/devspace.yaml +++ b/devspace.yaml @@ -40,7 +40,7 @@ images: dev: ports: - labelSelector: - app: tezos-bootstrap-node + app: tezos-baking-node forward: - port: 8732 remotePort: 8732 diff --git a/rpc-auth/README.md b/rpc-auth/README.md index 3639856e0..046535c89 100644 --- a/rpc-auth/README.md +++ b/rpc-auth/README.md @@ -78,5 +78,7 @@ helm upgrade $CHAIN_NAME tqtezos/tezos-chain \ 5. Client can then make RPC requests: - `curl http://192.168.64.51/tezos-node-rpc/ffff3eb3d7dd4f6bbff3f2fd096722ae/chains/main/chain_id` - - Bug in tezos client v8, so as of version `tezos/tezos:master_08d3405e_20201113152010`: - - `tezos-client --endpoint http://192.168.64.51/tezos-node-rpc/ffff3eb3d7dd4f6bbff3f2fd096722ae/ rpc get chains/main/chain_id` + - As of docker image `tezos/tezos:v8-release`: + ```shell + tezos-client --endpoint http://192.168.64.51/tezos-node-rpc/ffff3eb3d7dd4f6bbff3f2fd096722ae/ rpc get chains/main/chain_id + ```