Development guide, in general helps any opensource enthusiast to do his/her contribution for project development artifacts. This guide helps for contributing to kahu project development.
Follow below steps to get started with. Assuming that kahu project is forked by developer using github account
git clone https://github.com/<developer-github-id>/kahu.git cd kahu/ git checkout <contribution-branch>
Updated APIs can be checked at the location: config/crd under respective version directory.
Kahu has grpc interfaces for below inter module communications.
Controller Service <-> Metadata Service: proto file is providerframework/metaservice/proto/metaservice.proto
Volume Service <-> Volume Provider: proto file is providers/proto/providerservice.proto
In case of changes needed to any of these interfaces, respective proto file needs to be updated and below command to be executed to regenerate the protobuf files.
Build supports configuration of version number (VERSION) and architecture types( PLATFORM = X86/ARM) By default, architecture selected is X86 and builde version is v0.1.0. This can be updated and built as follows
make release-images VERSION=v1.1.1 PLATFORM=ARM
docker load -i <image-tar-file>
Kahu has end to end testcases which can help to quickly verify that basic usecases are working fine post modifications. It is based on Ginkgo which is a testing framework for Go designed to help you write expressive tests. ginkgo needs to be installed on the environment to run these test cases.
Execute below command and verify the test execution result.
cd test/e2e ginkgo
Please refer User Guide to know more about kahu usecase executions.