Skip to content

Latest commit

 

History

History
147 lines (100 loc) · 5.06 KB

CONTRIBUTING.md

File metadata and controls

147 lines (100 loc) · 5.06 KB
Raw

How to contribute

There are lots of ways to contribute, and we ❤️ them all!

Questions

If you have any suggestions, questions about the project, or are interested in contributing, you can find us in the fabric-kubernetes channel on Discord.

Issues

All issues are tracked in our issues tab in GitHub. If you find a bug which we don't already know about, you can help us by creating a new issue describing the problem. Please include as much detail as possible to help us track down the cause.

Fixes

If you want to begin contributing code, looking through our open issues is a good way to start. Try looking for recent issues with detailed descriptions first.

Enhancements

Open an issue to make sure your contibution is likely to be accepted before investing a lot of effort in larger changes.

Pull Requests

We use pull requests to deliver changes to the code. Follow these steps to deliver your first pull request:

  1. Fork the repository and create a new branch from main.
  2. If you've added code that should be tested, add tests!
  3. If you've added any new features or made breaking changes, update the documentation.
  4. Ensure all the tests pass, using go test -v ./....
  5. Include a descriptive message, and the Developer Certificate of Origin (DCO) sign-off on all commit messages.
  6. Issue a pull request!
  7. GitHub Actions builds must succeed before the pull request can be reviewed and merged.

Coding Style

Please to try to be consistent with the rest of the code and conform to linting rules where they are provided.

To run the linter, use the following command.

golangci-lint run ./...

Development environment

There is a Visual Studio Code Dev Container which should help develop and test the k8s builder in a consistent development environment. It includes a preconfigured nano Fabric test network and kind, which can be used to run end to end tests.

Create a Kubernetes cluster.

kind create cluster --name fabric-builder-k8s-dev

Allow chaincode pods to reach peers. (Make sure the gateway IP is correct! See Is it possible accessing host machine ports from Kind pods? for background.)

kubectl apply -f - <<EOF
---
apiVersion: v1
kind: Endpoints
metadata:
  name: dockerhost
subsets:
- addresses:
  - ip: 172.18.0.1 # this is the gateway IP in the "bridge" docker network
---
apiVersion: v1
kind: Service
metadata:
  name: dockerhost
spec:
  clusterIP: None
EOF

Build your latest k8s builder changes.

GOBIN="${PWD}"/.fabric/builders/k8s_builder/bin go install ./cmd/...

Configure kubernetes permissions and export the kubeconfig path.

export KUBECONFIG_PATH="${HOME}/.kube/config"

Start the Fabric test network in the .fabric/test-network-nano-bash directory.

./network.sh start

In a new shell in the .fabric/test-network-nano-bash directory.

curl -fsSL \
  https://github.com/hyperledger-labs/fabric-builder-k8s/releases/download/v0.7.2/go-contract-v0.7.2.tgz \
  -o go-contract-v0.7.2.tgz

Set up the environment for running peer commands and check everything is working.

. ./peer1admin.sh
peer channel list

Deploy the chaincode package as usual, starting by installing the k8s chaincode package.

peer lifecycle chaincode install go-contract-v0.7.2.tgz

Export a PACKAGE_ID environment variable for use in the following commands.

export PACKAGE_ID=$(peer lifecycle chaincode calculatepackageid go-contract-v0.7.2.tgz) && echo $PACKAGE_ID

Note: the PACKAGE_ID must match the chaincode code package identifier shown by the peer lifecycle chaincode install command.

Approve the chaincode.

peer lifecycle chaincode approveformyorg -o 127.0.0.1:6050 --channelID mychannel --name sample-contract --version 1 --package-id $PACKAGE_ID --sequence 1 --tls --cafile ${PWD}/crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/tls/ca.crt

Commit the chaincode.

peer lifecycle chaincode commit -o 127.0.0.1:6050 --channelID mychannel --name sample-contract --version 1 --sequence 1 --tls --cafile "${PWD}"/crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/tls/ca.crt

Query the chaincode metadata!

peer chaincode query -C mychannel -n sample-contract -c '{"Args":["org.hyperledger.fabric:GetMetadata"]}'

Debug chaincode!!

Code of Conduct Guidelines

See our Code of Conduct Guidelines.