search

hyperledger / fabric

Hyperledger Fabric is an enterprise-grade permissioned distributed ledger framework for developing solutions and applications. Its modular and versatile design satisfies a broad range of industry use cases. It offers a unique approach to consensus that enables performance at scale while preserving privacy.
https://wiki.hyperledger.org/display/fabric
Apache License 2.0
15.76k stars 8.86k forks source link

Setting up the development environment documentation is out of date #2960

Closed davidkel closed 3 years ago

davidkel commented 3 years ago

In devenv.rst the pre-reqs are

Setting up the development environment
--------------------------------------

Prerequisites
~~~~~~~~~~~~~

-  `Git client <https://git-scm.com/downloads>`__
-  `Go <https://golang.org/dl/>`__ version 1.15.x
-  `Docker <https://docs.docker.com/get-docker/>`__ version 18.03 or later
-  (macOS) `Xcode Command Line Tools <https://developer.apple.com/downloads/>`__
-  `SoftHSM <https://github.com/opendnssec/SoftHSMv2>`__
-  `jq <https://stedolan.github.io/jq/download/>`__

For Go we need to update this to 1.16.7 across main/2.2/2.3 but also mention that building tagged versions may require an older version of Go.

The versions of docker vary between windows/mac/linux (windows/mac have docker desktop versioning) so would need to provide more context here really.

For Mac, using brew to install pre-reqs could be an issue (I don't know I'm not a mac user) but in the docs it says

brew install git go jq softhsm

How do you know what version of go or softhsm you are going to install.

We should restrict people to softhsm 2.5 for now as there are known problems with softhsm 2.6

davidkel commented 3 years ago

As a further assistance it might be helpful to also give a ubuntu example of setting the PKCS11 environment variables in order for the build to run

denyeart commented 3 years ago

@davidkel I added some clarifications around Go and brew: https://github.com/hyperledger/fabric/pull/2973.

Go ahead with the hsm updates since you've got the most information in that area.

justin-themedium commented 3 years ago

@davidkel Thank you for the information about known issues with softhsm2 v2.6. I tried it with v2.6.1 (by brew install) and suffered on macOS for a while. Once I installed v2.5, I passed the pkcs11 test during the build.

denyeart commented 3 years ago

HSM clarifications added in https://github.com/hyperledger/fabric/pull/2977/ , closing. Thanks @davidkel

sousoul commented 2 years ago

@davidkel Thank you for the information about known issues with softhsm2 v2.6. I tried it with v2.6.1 (by brew install) and suffered on macOS for a while. Once I installed v2.5, I passed the pkcs11 test during the build.

I have installed softhsm v2.5 on macOS, however, I cannot pass e2e test and lifecycle test during build. 

There were failures detected in the following suites:
          e2e ./integration/e2e
    lifecycle ./integration/lifecycle

Ginkgo ran 16 suites in 47m37.809114611s
Test Suite Failed
make: *** [integration-test] Error 1

Have you met the same error?