From 9cec056c4179dd2849da79c2535b0c32042e6474 Mon Sep 17 00:00:00 2001 From: Edward Date: Fri, 13 Sep 2019 11:54:58 +1000 Subject: [PATCH 01/11] Add a DCO checker (#1) Signed-off-by: Edward Evans Signed-off-by: Nicolas MASSART --- .circleci/config.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 3af43c8719d..1b0ad1f446a 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -7,7 +7,33 @@ executors: node_executor: docker: - image: circleci/node:12.9.0-stretch + shell_executor: + docker: + - image: circleci/buildpack-deps:buster-scm jobs: + dco: + executor: shell_executor + steps: + - checkout + - run: + name: check + command: | + status=0 + while IFS= read -r -a line; do + my_array+=( "$line" ) + done < <( git branch -r | grep -v origin/HEAD ) + for branch in "${my_array[@]}" + do + branch=$(echo "$branch" | xargs) + echo "Checking commits in branch $branch for commits missing DCO..." + while read -r results; do + status=1 + commit_hash="$(echo "$results" | cut -d' ' -f1)" + >&2 echo "$commit_hash is missing Signed-off-by line." + done < <(git log "$branch" --no-merges --pretty="%H %ae" --grep 'Signed-off-by' --invert-grep -- ) + done + exit $status + build: executor: python_executor steps: @@ -95,6 +121,7 @@ workflows: version: 2 default: jobs: + - dco - build - vale - markdownlint From 28452ef153c25c14530bae85851f33c88d6e2150 Mon Sep 17 00:00:00 2001 From: Edward Date: Mon, 16 Sep 2019 07:47:07 +1000 Subject: [PATCH 02/11] Update our contributions to reference DCO rather than CLA (#2) Signed-off-by: Edward Evans Signed-off-by: Nicolas MASSART --- CLA.md | 19 ------------------- CONTRIBUTING.md | 6 +++--- DCO.md | 9 +++++++++ 3 files changed, 12 insertions(+), 22 deletions(-) delete mode 100644 CLA.md create mode 100644 DCO.md diff --git a/CLA.md b/CLA.md deleted file mode 100644 index 31b0c98dbd9..00000000000 --- a/CLA.md +++ /dev/null @@ -1,19 +0,0 @@ -Sign the CLA -============= - -This page is the step-by-step guide to signing the Consensys AG -Individual Contributor License Agreement. - -1. First and foremost, read [the current version of the CLA]. - It is written to be as close to plain English as possible. - -2. Make an account on [GitHub] if you don't already have one. - -3. After creating your first pull request, you will see a merge - pre-requisite requiring to you read and sign the CLA. - -If you have any questions, you can reach us on [Besu chat]. - -[Besu chat]: https://chat.hyperledger.org/channel/besu -[GitHub]: https://github.com/ -[the current version of the CLA]: https://gist.github.com/rojotek/978b48a5e8b68836856a8961d6887992 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cca2c813dd1..1c4c080e26b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -182,7 +182,7 @@ The process described here has several goals: Please follow these steps to have your contribution considered by the approvers: -1. Complete the CLA, as described in [CLA.md]. +1. Ensure all commits have a Sign-off for DCO, as described in [DCO.md]. 2. Follow all instructions in [PULL-REQUEST-TEMPLATE.md](.github/pull_request_template.md). 4. Follow the [Style Guides](#documentation-style-guide). 5. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) @@ -219,6 +219,6 @@ in this guide. [Hyperledger Besu chat]: https://chat.hyperledger.org/channel/besu [Hyperledger Besu documentation]: https://besu.hyperledger.org/ -[CLA.md]: ./CLA.md +[DCO.md]: ./DCO.md [Code Reviews]: ./docs/community/code-reviews.md -[MkDocs]: https://www.mkdocs.org/ \ No newline at end of file +[MkDocs]: https://www.mkdocs.org/ diff --git a/DCO.md b/DCO.md new file mode 100644 index 00000000000..a10deeec06a --- /dev/null +++ b/DCO.md @@ -0,0 +1,9 @@ +DCO +=== + +As per section 13.a of the [Hyperledger Charter](https://www.hyperledger.org/about/charter) all code submitted to the Hyperledger Foundation needs to have a [Developer Certificate of Origin](http://developercertificate.org/) (DCO) sign-off. + +The sign off needs to be using your legal name, not a pseudonym. Git has a built-in mechanism to allow this with the `-s` or `--signoff` argument to `git commit` command, providing your `user.name` and `user.email` have been setup correctly. + +If you have any questions, you can reach us on [Besu chat]. +[Besu chat]: https://chat.hyperledger.org/channel/besu From e2a7b592784a71198dc87e68df6176505c143590 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Wed, 18 Sep 2019 16:27:13 +0200 Subject: [PATCH 03/11] fix links after migration to HLF (#5) Signed-off-by: Nicolas Signed-off-by: Nicolas MASSART --- MKDOCS-MARKDOWN-GUIDE.md | 2 +- docs/Concepts/Privacy/Privacy-Overview.md | 5 ++++- docs/HowTo/Interact/APIs/GraphQL.md | 2 +- docs/Reference/API-Methods.md | 2 +- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/MKDOCS-MARKDOWN-GUIDE.md b/MKDOCS-MARKDOWN-GUIDE.md index 209070b7a54..c998d70ee8d 100644 --- a/MKDOCS-MARKDOWN-GUIDE.md +++ b/MKDOCS-MARKDOWN-GUIDE.md @@ -333,7 +333,7 @@ enables displaying a list as a checklist. For writing code examples inside the documentation, refer to the developer style guides: -- Java : refer to Hyperledger Besu [coding convention](https://github.com/hyperledger/besus/blob/master/CODING-CONVENTIONS.md). +- Java : refer to Hyperledger Besu [coding convention](https://github.com/hyperledger/besu/blob/master/CODING-CONVENTIONS.md). - JSON : use https://jsonformatter.curiousconcept.com/ to format your JSON code. - TOML : we follow version 0.5.0 language definition. - JavaScript : see [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html). diff --git a/docs/Concepts/Privacy/Privacy-Overview.md b/docs/Concepts/Privacy/Privacy-Overview.md index 7e29bc9b93d..3ac6ad33bf4 100644 --- a/docs/Concepts/Privacy/Privacy-Overview.md +++ b/docs/Concepts/Privacy/Privacy-Overview.md @@ -8,7 +8,10 @@ Other participants cannot access the transaction content or list of participants !!! important For production systems requiring private transactions, we recommend using a network - with a consensus mechanism supporting transaction finality. For example, [IBFT 2.0](../../HowTo/Configure-Besu/Consensus-Protocols/IBFT.md). All private transaction participants must be online for a private transaction to be successfully distributed. If any participants are offline when the private transaction is submitted, the transaction is not attempted and must be resubmitted. + with a consensus mechanism supporting transaction finality. For example, [IBFT 2.0](../../HowTo/Configure/Consensus-Protocols/IBFT.md). + All private transaction participants must be online for a private transaction to be successfully distributed. + If any participants are offline when the private transaction is submitted, the transaction is + not attempted and must be resubmitted. ## Private Transaction Manager diff --git a/docs/HowTo/Interact/APIs/GraphQL.md b/docs/HowTo/Interact/APIs/GraphQL.md index 6b2e0cc721f..dece88da28b 100644 --- a/docs/HowTo/Interact/APIs/GraphQL.md +++ b/docs/HowTo/Interact/APIs/GraphQL.md @@ -6,7 +6,7 @@ description: How to access the Hyperledger Besu API using GraphQL GraphQL can reduce the overhead needed for common queries. For example, instead of querying each receipt in a block, GraphQL can obtain the same result with a single query for the entire block. -The GraphQL implementation for Ethereum is described in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/graphql/src/main/resources/schema.graphqls). +The GraphQL implementation for Ethereum is described in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/api/src/main/resources/schema.graphqls). The GraphQL service is enabled using the [command line options](API.md#enabling-api-access). !!! note diff --git a/docs/Reference/API-Methods.md b/docs/Reference/API-Methods.md index 8f6c5819b46..56ca02fa106 100644 --- a/docs/Reference/API-Methods.md +++ b/docs/Reference/API-Methods.md @@ -479,7 +479,7 @@ None !!! note Methods with an equivalent [GraphQL](../HowTo/Interact/APIs/GraphQL.md) query include a GraphQL request and result in the method example. - The parameter and result descriptions apply to the JSON-RPC requests. The GraphQL specification is defined in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/graphql/src/main/resources/schema.graphqls). + The parameter and result descriptions apply to the JSON-RPC requests. The GraphQL specification is defined in the [schema](https://github.com/hyperledger/besu/blob/master/ethereum/api/src/main/resources/schema.graphqls). ### eth_syncing From 69b129a0da464a759d06af4ffcd0e66ac8f6dbf4 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Wed, 18 Sep 2019 17:52:57 +0200 Subject: [PATCH 04/11] update favicon to Besu icon (#8) Signed-off-by: Nicolas MASSART --- docs/custom_theme/favicon.ico | Bin 32988 -> 3233 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/docs/custom_theme/favicon.ico b/docs/custom_theme/favicon.ico index f2883bad61b7ef7218098b0111c7e3c48e536b24..d8116ecae371e0ace5fdc48fd8dcbffbfe831794 100644 GIT binary patch literal 3233 zcmV;S3|{kzP)520(;<27kW8ZV=?X$<`%*e* z`Tr(33jpxLiwg+0t*8rjj4_|0!%+Zcm6jPGe~|r6@(|(v%qCKgAGP9uPAht&(FKrH zD*(WyRwe3!&Ev+Zh;TXteq-_f0hnk46OI4#0dVvtI38GHS?=@7UZh1-$(0{}r?t8| zH4!`}Bm*jUGTo)pKB#T`-&36@k1mKs7EA<}2?;kBLL?zI`45pU&~~}TjsuX=qn|G3Th?@Zkk|>4oPIw#XK!EF+&F90 zj)sAv3<2-HeI9Q#^0l;1#R06$TT$eTy-7RnwamY|xus=NF}RKU5b#^(UHss^qY(YL zK*|7sX|GBh$dL_w+2y_8}KyE=_ z-$8Fv!}dkHo30*K?;K#vGT`2p7Uj1h52n&RacBubM1cf}J(Ln(ygu~k%MU!z3-sM3 zfCm5wY`@q}Yjt%h9tdqMbzk9AWHSKW&vSK8Pde_8M%FE{tTB6m8JC(cT$)gO&iIpuyiIF4i{11@}9^*3*uqf_=1TJ&9mr94T<*W>l!r!KZp+0x=k zo;kU+zux{gs;heo`8{d`-v;n0e=KsJwq*+-vmoNvkQcm7=8s$+*V^_~4~|%w8b&JF z1Fx#o@_YU!(Q5XE~63g0q zPLdC6!Phc&s?f|5R`fDwDa(mzia z#`~AESc+8o32&2`0A;URDXXn6*a6T0WjzEZ3fUSh2)zCM>gs~3wZnsv z(p4neh8XW6`G6v>LrKZ?r1~rs){^QefX4D&{DshSzmxWkWpQ7uak1F;&-)$J#{;2gzPc5$h~E}{Cxl-Xkwq7h!}~&I ze*CJdqfVB=%W`UJ_^JTA`hWJKe}z%Xb!&&Q=4Vc9IDQcl?HYIq5XH;NS8a8{j<^xt z8V`i7^SD$ch;1agfsFV8t)D#IdFnmC6ezcb6GkwKPt2W5g@-_9c71|dv~9oXx6CJ(Sk~lRCVbl) zD=5iV0GR~7 z_D3VjhPL-bBcGPEenSKq$&B2+!U)!mmRGR@0AyzC0VHZ_PRHxR^=_BzMv{jzb!Co* zyjT%4ZwCNxEK&o}KLO-Q03g|r2!!q*i__`iiK2pjjgL8(zP8#2-<~;d;fpI~u*-Ci6vT-IQJ9sZ`8UKJC_IS{7@hTYuU1?hBPI zjb&rSt7yw0fu78#ToQmKmgV+a4c|zn^Ige=lWM&eS+f!%k z*SyWmQ%6OpA4MDjnE(t~4FCYXXv5uSb?T_r*bI@(L`m+Dva9CDjqpAIXkWFe8=kV8 zNgn98u^6fIuZ)FCT+FkjgZJ$E^Y>?zX1?%wX_MkA9KF9RsYvtR9xKAKAMLy~DIMx?ZCZif+m z)XDZZQB{?iT0Z>?Bwx*x$g;CYJvmZZ<9b7+qN(W`8|f9I)LWz+6Faj6rgdtT%Z2AC zC0mXffy8j_zENG>Tk&*cx&4tG6u~vn64YcF3a_x2U>N5DoRj^oZ1Lr*=Z`il(!yn= z+>=K77KlK>-k^kgvpJ*{u8G%$_6(oyAlmK^cKTwC%W2zh3g8jZUmbiZUSwpvf^eh= z&5K6v)S|ziJ<Lr$C-}gU{Y) z1Yg}mYH!r+g2)sRR66nN1RmEFPb78E1pyGiO<)Uvu?YZx%ir1{0l_g)4pI0fA^TSZ zf^TJaYn$pb8YqD_0d9g|p+mm~Ve4c?u5tlq+}qNk3Ms?RWO2${ki4?^Gwv(6w(b64 z=g`7U_2FD~{|&%RAS#yb+BGS2T0AmTwltRYozWX?+g_LJIYq`!7I(SaYYChlQZ&@? zO1nq5`>jabraX6l21o(_3S`~|PNdHjl)v)9Z$-Y6>a^n;^2or@yg(b^e?h4=PHZ`r z#r>8w6_TuiV2X>LAK9+dbVf@;N}65GDGSIC2p=i zx;l95;x@jhd0a$hfP6g>2z|0mx#B zWlcFN$&CcVBI536*h|6IDa!NMLBr_D*7Y@+PYdKL05nR=rX^}>PUo|`bl0v)$9uci zfwDoQe-lM&K%%AY$$#0pdUa>MwoWl7dcZ-$=t=~_>s5)Xa>!<7l0g2VOOowA%Um(& zQNB0eJ9$3ul{sIu;qK$f?xO0V)$d`=fsw83o!JA z_;nY#)?GgBo#dHQ{|U&|1UkMH2+bcVZdO?4!nBAvbk!mFJ{8tGz4R~~j7tE3jL30L z`obEr5h7DE-Ux~`L#ecAT?b&`?>7}sN6PIUy;;b*>`hXF-6S{b*>nCrQB^fAx5>vX z09kmOo2Mdm{xOKuU~tIkA>TprfC&6q*&8GP>@K0_;iHCeayu-xl zu8Y!xgvbLF33b$m9c^Yti=qV}3x6!KQs=oEU+CCBj3P_6q!^lI zrE}(tX6DYl_kY~~b^m`%rVp7uViE)s&XY`E!+E;NWSTT-`1&l9$%lKN|NQXv$4sWh zHR4wLC?cn8f)H8^-b|I1?_kAXY}PGJmu=oFsYgiWoy{PNSicJn!N z6!WEC*?PTCvE4YwQ+TnaK}=`)v)fG{Mt`5Gsi`?F(^u;@xz37q+RrfBSIXx9@G1pA zu2Reky^3|7PqccyviVk@t5EhULa|r2%(QV~IP7;@4+T~0JARjNkcZDDyq)UcGrgV1dMKa@M~2@=e}Xo*tVmlh z`)cjZIn%X}$94?x_69w|0|9r@WnS^he>CQi&AG;Y$r-?-yHYN=HfpzjIMa8-ed>b^ zTb=)&*d921)2|8|@HldS=9+#eIA?p{UGM;5)#jH^)dFs-7Am!E1)djIsg@fm?7}A! z$ItdZc?Gclw8B|1muo50_g8ExzA@Ub{H?WLotpR#cyhN-v1*l)Ip>48Bg_F8=v`W* zpF!t=>QZ5uPc8U6_U%e6+$X;B z&>H(WiSK0te+6*FgShgkR-L~|XZ>*7_E$O0y*{_F%zL8a?@+fPUtd zO_f5bWv5>$Y;o1RyMD*(eNlAs#~QoD$l8N*wAPrsyk^~ra~cc&5qM?53m!4na|kpB zy^jT5wgKSb$tuXufMT5)ES>zB@#d55^RnWrzCN$CXxW0>uGajrEhR&8&C%+3A_YgL~FtYv)SgT8Iy8H^di?m9)@F;jM7W5RYhMfNq)}QE= zY~P|BPVRFeuFD<5XT7S;SM9O(-(7Ky=2xsOo*N22nN8m-Hj3YCiOFw0`WLqr?vY+? zSbxi<$?s#G9)Ld5c{tz}j(ZjJkxH>}ANZoj>$W@&-hK${tzx#rQZz>@_-eLuNFHyz zYsj=SeQt{io$@Eni+aQ7G_R--vXh$)o9$PGW6~?p0YzK&l1q#9iK`OzzA+E4RJhb9 zT9#1%2V6E!5c;?ha)$VqWu4bDwk?c4b2(QkSDX!9;Rv`azYnUy;rZp$w0Y1UpvTYc zlPAN=&HT6G8Rx~(0r~k=FT1tIZBA`vzkF=PmJ(m)J-mM{AUJuV&NFd)>CuZN3ch z9od9$NlYts@B{sX?2?&T0M@HxL(mIKDX#Odsgxz+wqgzm)a+P27bad zK3TXwR4P2}mo10s2he^nXia+4zMvg756`@+bxnnA`Fe6+nOwJYI`4?~OUGIa*s<=x z^U(RK*3#uH&7_Z$Z1bU@QgpswwcSE_?U&8ZgT8yo&pZfYD*KviJp?}sa_=X(_<)>q zQ@3+2Y}>=(UU`V_fW2;0iPlcod!&vBpPqHzNy0Yjb*?q?^=!p_MaXUQc}43g_$1rG z*Kfnu(bu#;fxi=B*ZCd30%;ylgdLFaDh9~Ne@&i9W2aaRoAxMWeBCDSJYeV11lhN8 z&~?0Six^0LC)evT@yaj2{xMg{h2?;GY0zce0Nddp*K#%2GiXd-F_FI$;Wqf4I!<2; zs<8UDl7jE#IG@uX>uzrwkdL(Xy-Rn(&b3dzhwZcJp>^UHa_OIbr60B)Vj4GL-gkhf z!y%XT&!Fj^q4^Kli}d-DVN7>TywEp<&fDd4Sr>}A`u?!DA?xmG+pZo-+YH!$p-S1hyh=1b2U#^3RBiip`f?qE#;{38WH$LY9juA> zfkR!Vb6vo`dlG#YWHPT*Z5BoCA8YEB7DWfuy<2fAfpZuR_G~RPScmC++rLg5uQx{6F>f8*&gr+FQc#dxyE~li^UzzPs6sU zUkO`Y*KrB!-QfG?E(!WxdZ($=aZM`xrMg$8nhy|e!a3I3%@l67Gk6{JK7?3cGh&37 zr5ZcadywaoAmdg)vcs*>rqT6#BHj6avr~KYFCN-HOYPCjV`5|Z|JlIIw#1>%Lqj^? z_f;wypPKFt>Uk{^SB}(gb71E)yI-#G({>}D>oyK# z2K<=KRaoP5ju3O&$RRC>os>uOGo!K{+(Rl zr=F)S8TTMnx<9T8e}ygdYsAOAA!X`U z#_KQJ=PNp#7lY4#8AXf=d_3k_H|XC48;^EQ<2LcWY{yG(kA1qm^h>edrNawb1+iZ9 zZpiS}jKOe^EjWR+P8`3vSG+mgCvRoErWr6%j~OtgJcH*M&*S<)OzW2u;n!oY?v0Q~ z*juTZJH0M*W1!UHsgSSw`gVIlmo_%MES)(qZ`KWAnM8--geWhqV77>z`b|!&vXpn6i4=`Wtf6@tMwbBHJzh;|-r|jVr}1 zee&~+L&84QVa|l#4W6f*C*9Fc+lr@8+_#;`xlUwX++W3><8@f$zea54IAPag@kz8D zi~htB^}FuV#HFQ+e{)^d`5_YtQ>J}IV&e2jkK7KQ<-j9|!^4KpNWLZGf_5EjfkTMh z-V1z=#kkN30PPo9|maqO|q2ovt@@|%?F*lPvcnXPdHcG8^sZ54by_`82;>KMIO z{eHqV-dIbXz4>#ky~@o|#3jPL;^Fq~fE)35?m1<;#uH(u{lm469F_IUI~|4NjsN$0 zj{U{2v~F_-S8i8+&)6&JZR|H0@ML?YY{YTAxyw;syTN|p-wU>M<3_Q6)Yhj=YuqN) zM*5Y$l>O--p?D*Wk4S9q#*ZF-=e!00@ytO9!ZeCuxxx8QZxtChE!T!y*0d+3s z`7CtMe#X^FtC1KSU@+jx^lYpR=m+|5$I$O%OFROdOi+ZjA z_tI#uP=6V`nhU&qhkfYzC&1^*0r?ng|36@__D06{PIlfC^?rSa^X)dsGtP5p&e^Z& zWc=uOgB~OwJp%m@8BjW!`xI~U`k6W9yG|6Wsrsqk zU9civazU!GPlbCY3%{{Os1p#+7|J<_OL55ch09+!wQ`P9;X7COb+~muMbiBg$n&GE zebN@h?0-<(shn~)Oe)xUFKhUz^TFe^1L)6(WAfXG#jS1Xa?WAyS-Npf)%)YZKWyVL z2E+YT+CbD}tv&LNNWW`o{Z{F^#w~JIIk~42E>giy-sVA=X#+5aly(sE$M?1Lh)=;k zt3o{M%YY-Nyp>ZD{$ZG@%Z%6qW3!OqdmFptKO&~g9KY1mOKXX7#JG^{7%3m90HE~cLIQfiT#~+N7>YK z1E_Tfxh?bo)7ndR)O4mA8Zjw7R#2&0e~mr)HOM7L?SRmX{n~oulKv8Tg{U#KE(<8u zIe01apzWw1( zZCI-WKl(S}PRAvDRv{MdWnKpJaCl}u3Uf4=gXEJfZvh9)&;2p-OsAHYk6#;!I=1Pc z$>Yf3DoP%k*WqsYzgl~xEygqCF}}mGs>H&B$on0@9G*me#D4}$g_3OYLO{1k$o*c1 zJk!?#X~stUNq&6aZH%igFvj zH@nIhWBy&LHsjr6Jz}u5=n9N^FLM!@zce5G`2*CGfj^?<_GzC=)kh?zei3;%1B~@D zZq?G`yfIa~RQLQ?;~~{{1J>Tpu=YBP{2`7_p259i0k>_0mdSkp=NBP2pl2w)E)(`m z#=1{#TZ5XYpl8~}{B{7=_5D~6YmuM6i{luz$E@XKPNrVh?zV0VxKr~u`;LIdhBYnyq z?zJ*b%lJNG8HXA=Oa8@ZlX%8>dYx?YxSSVpF`O&*La0nAPJA!bfB2IAwto3=V(kKR zmyx%AN2>O`mpuLmj{#eIw8`D@hJarw<~uQK6#y{&Qg1=zRy1@L-=Yb!B6&pGg3+o1Y7=a&xNT<(*G z!0E!aK6xi$Mt0(LXCmQEo(Jf>mvLZ@ zNm~JN;5VQ{BZv#ndSd5$AOCLXbnZt^)XR`*&22G7iuNiKvWAo4On2SfqZaVnN$H+{ z(C;%&fKLvZzK!GmN}OP>JpJQiFgBsK0cS_%Qg6pMVx ztJBu1%yrwYL@oBCu(56)?p8lN{Jj11P2JL8Tedl8@CNMf0DNB6?-2@F^PSi>)qlc) z7(^pt0lVNYpU^k)K|R*6P283IU7l2Z8TWL$x^4I-nRONGr~%vVpe&54B}RR8%i4n# zsFxJ)Hr`ElUQjvp?2yZLEqug>fx~{%XCdMlLDcz_r-+?E{w-PkdMR|Q^8ofoM&)D& z%FXA&Uz&=VnFW~VZ^2Km>oE(|O_A=v#WCO}<-FK8_1LdquOOFpQR1B8hdqpXtLIT~ z{wDn$!yacXGJPXn1K)oPc&wvpf*4alu4W5u0{R}%)4QTE_X*#FV*LyK$V4BD{SwbX z)!JW;+CF}7A#qOp-?TwG4?OtahJDZZw{%HLay!G1;e7SlIgEuh)eZg#rmK%_i;D%Y zU;1h5P|q_@lC(|ko7d!j#-re)?)JMZ?bT(rSzd4YZ>T_r&4cfKi1rM9P>un9-w0f# z{7xBYi5OFnopHTX;~V$d2b4>Z`|%|4K)XcuZ=p9~E5uUqi}Bug=a!e8pGMvLeefaQ zq8_FlLY#2k^y6FloEMMRN2=$K!8e3G>uc!~2lYAYb+#qCji=|J_esw*K1N$1w z55XWFUb$UriVTeJkEVmcuoF3N!oc~$W_lHT{?J6&rOa=7>@|;uZ>sGNqZX%qP*ERw zW#aNaAnz8pp-<#NUziTYQ~5saBpQj6aJ-jx5^M}7bc@5Uns0$EV&`{6_$`uvr^p*n zZP(3Di0AX$S~d2e++yh5GsD>1rtJMU?@a9u#O)csf}JpcTDV&3K*;+MI~Q@Z>k)go zqGtG8OprSZ8}d-q#LoF~4OHU+vh2z|O5HJS$&R?X03%s!`u`6>FZsjK8V z*7vnB&J9`b34At z#~7kh))+~s^Cs-5^vgJ9{5&m_*1|Iy|QteX(#{3d1BuU_>~EA=yIVR za~tIa<&*Be_etTpL08(C7j+zAZ0U8zI38oEx_s=D_d~Y(lINFrjXjQMSSO;7H~gNS zhtjWvn|h>izf}f(dYtg-bv8ZHe%J?1?T9fZjxpB%#;uN55Vu(u8Bn~r$Qs~_?oj@h z$3Pwfc?{$+kjFqC19=SOF_6bV9s_v{ Date: Thu, 19 Sep 2019 10:42:44 -0400 Subject: [PATCH 05/11] [PAN-2896] Add space requirement for Prometheus (#6) Signed-off-by: Steven Gregg Signed-off-by: Nicolas MASSART --- docs/HowTo/Deploy/Monitoring-Performance.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/HowTo/Deploy/Monitoring-Performance.md b/docs/HowTo/Deploy/Monitoring-Performance.md index 3de7442059a..36dbcf257eb 100644 --- a/docs/HowTo/Deploy/Monitoring-Performance.md +++ b/docs/HowTo/Deploy/Monitoring-Performance.md @@ -18,6 +18,8 @@ To specify the host and port on which Prometheus accesses Besu, use the [`--metr [`--metrics-port`](../../Reference/CLI/CLI-Syntax.md#metrics-port) options. The default host and port are 127.0.0.1 and 9545. +Prometheus requires 3MB of space per node per hour for metrics, with a `scrape_interval` of 15s. + To use Prometheus with Besu, install the [prometheus main component](https://prometheus.io/download/). On MacOS, install with [Homebrew](https://formulae.brew.sh/formula/prometheus): ``` From d8245ccc8543b12c6f0fc2650b1ecd183be0bbe3 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Fri, 20 Sep 2019 15:52:03 +0200 Subject: [PATCH 06/11] remove version variables and update docker note Signed-off-by: Nicolas MASSART --- docs/HowTo/Get-Started/Run-Docker-Image.md | 10 +++++----- docs/Reference/API-Methods.md | 2 +- docs/Tutorials/Quickstarts/Privacy-Quickstart.md | 11 +++++------ .../Quickstarts/Private-Network-Quickstart.md | 11 +++++++---- mkdocs.yml | 3 --- 5 files changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/HowTo/Get-Started/Run-Docker-Image.md b/docs/HowTo/Get-Started/Run-Docker-Image.md index e9093ca9170..cd4300465d3 100644 --- a/docs/HowTo/Get-Started/Run-Docker-Image.md +++ b/docs/HowTo/Get-Started/Run-Docker-Image.md @@ -24,12 +24,12 @@ To run a Besu node in a container connected to the Ethereum mainnet: docker run hyperledger/besu:latest ``` -```bash tab="{{ versions.stable }}" -docker run hyperledger/besu:{{ versions.stable }} -``` - !!! note - `latest` runs the latest cached version. To pull the latest version, use `docker pull hyperledger/besu:latest`. + Other tags are available for the image, see https://hub.docker.com/r/hyperledger/besu/tags + + Docker runs the cached version if you already pulled `latest`. + + Pull the `latest` version again using `docker pull hyperledger/besu:latest` to make sure your image is up to date. ## Exposing Ports diff --git a/docs/Reference/API-Methods.md b/docs/Reference/API-Methods.md index 56ca02fa106..380a2fcecad 100644 --- a/docs/Reference/API-Methods.md +++ b/docs/Reference/API-Methods.md @@ -268,7 +268,7 @@ None { "jsonrpc" : "2.0", "id" : 53, - "result" : "besu/{{ versions.stable }}" + "result" : "besu/" } ``` diff --git a/docs/Tutorials/Quickstarts/Privacy-Quickstart.md b/docs/Tutorials/Quickstarts/Privacy-Quickstart.md index fece3898226..8a7eebbbbb3 100644 --- a/docs/Tutorials/Quickstarts/Privacy-Quickstart.md +++ b/docs/Tutorials/Quickstarts/Privacy-Quickstart.md @@ -37,15 +37,14 @@ To run this tutorial, you must have the following installed: ## Clone Besu Quickstart Source Code -Clone the repository from the `besu-quickstart` repository where `` is replaced with the latest version (`{{ versions.quickstart }}`). +Clone the repository from the `besu-quickstart` repository. -```bash tab="Command" -git clone --branch https://github.com/PegaSysEng/besu-quickstart.git +```bash tab="Linux/MacOS" +git clone https://github.com/PegaSysEng/besu-quickstart.git ``` -```bash tab="Example" -git clone --branch {{ versions.quickstart }} https://github.com/PegaSysEng/besu-quickstart.git -``` +!!!note + You can download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases ## Clone EEAJS Libraries diff --git a/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md b/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md index c9a6ca9d3c6..b504a2bf9f8 100644 --- a/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md +++ b/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md @@ -32,12 +32,15 @@ the MetaMask plug-in installed. This tutorial uses screenshots from Brave. ## Clone Besu Quickstart Source Code -Clone the repository from the `besu-quickstart` with the version matching Besu version, currently `{{ versions.quickstart }}`: +Clone the repository from the `besu-quickstart` repository: ```bash tab="Linux/MacOS" -git clone --branch {{ versions.quickstart }} https://github.com/PegaSysEng/besu-quickstart.git +git clone https://github.com/PegaSysEng/besu-quickstart.git ``` +!!!note + You can download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases + ## Build Docker Images and Start Services and Network This tutorial uses [Docker Compose](https://docs.docker.com/compose/) to assemble the images and @@ -55,7 +58,7 @@ When the process ends, it lists the running services: !!! example "Docker-compose services list example" ```log ************************************* - Besu Quickstart {{ versions.quickstart }} + Besu Quickstart ************************************* List endpoints and services ---------------------------------- @@ -166,7 +169,7 @@ The result specifies the client version: { "jsonrpc" : "2.0", "id" : 1, - "result" : "besu/{{ versions.stable }}" + "result" : "besu/" } ``` Here we simply query the version of the Besu node, which confirms the node is running. diff --git a/mkdocs.yml b/mkdocs.yml index 28a1bfa7328..4f09c6d6dcc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,9 +20,6 @@ copyright: Hyperledger Besu and its documentation are licensed under Apache 2.0 #extra project info and template customisation extra: doc_site_edit_url: https://github.com/hyperledger/besu-docs/ - versions: - stable: &stable_version 1.3.0 - quickstart: *stable_version latest_version_warning: url_contains: /latest/ text: 'You are reading Hyperledger Besu development version documentation and From d36c2b381cdc4d39d58f21f1a24c114ca431a7e2 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Mon, 23 Sep 2019 09:16:02 +0200 Subject: [PATCH 07/11] Update docs/HowTo/Get-Started/Run-Docker-Image.md Signed-off-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Signed-off-by: Nicolas MASSART --- docs/HowTo/Get-Started/Run-Docker-Image.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HowTo/Get-Started/Run-Docker-Image.md b/docs/HowTo/Get-Started/Run-Docker-Image.md index cd4300465d3..77c3c925b81 100644 --- a/docs/HowTo/Get-Started/Run-Docker-Image.md +++ b/docs/HowTo/Get-Started/Run-Docker-Image.md @@ -25,7 +25,7 @@ docker run hyperledger/besu:latest ``` !!! note - Other tags are available for the image, see https://hub.docker.com/r/hyperledger/besu/tags + Available tags for the image are listed at https://hub.docker.com/r/hyperledger/besu/tags. Docker runs the cached version if you already pulled `latest`. From 09688babd34aa19c7e3782ecd3d605cab4034bb0 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Mon, 23 Sep 2019 09:16:18 +0200 Subject: [PATCH 08/11] Update docs/HowTo/Get-Started/Run-Docker-Image.md Signed-off-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Signed-off-by: Nicolas MASSART --- docs/HowTo/Get-Started/Run-Docker-Image.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HowTo/Get-Started/Run-Docker-Image.md b/docs/HowTo/Get-Started/Run-Docker-Image.md index 77c3c925b81..b200efce4ea 100644 --- a/docs/HowTo/Get-Started/Run-Docker-Image.md +++ b/docs/HowTo/Get-Started/Run-Docker-Image.md @@ -27,7 +27,7 @@ docker run hyperledger/besu:latest !!! note Available tags for the image are listed at https://hub.docker.com/r/hyperledger/besu/tags. - Docker runs the cached version if you already pulled `latest`. + If you previously pulled `latest`, Docker runs the cached version. Pull the `latest` version again using `docker pull hyperledger/besu:latest` to make sure your image is up to date. From c7e90d04700be20d58f5066e6d9058749925ddfc Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Mon, 23 Sep 2019 09:34:26 +0200 Subject: [PATCH 09/11] Update docs/HowTo/Get-Started/Run-Docker-Image.md Signed-off-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Signed-off-by: Nicolas MASSART --- docs/HowTo/Get-Started/Run-Docker-Image.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/HowTo/Get-Started/Run-Docker-Image.md b/docs/HowTo/Get-Started/Run-Docker-Image.md index b200efce4ea..755bdaee326 100644 --- a/docs/HowTo/Get-Started/Run-Docker-Image.md +++ b/docs/HowTo/Get-Started/Run-Docker-Image.md @@ -29,7 +29,7 @@ docker run hyperledger/besu:latest If you previously pulled `latest`, Docker runs the cached version. - Pull the `latest` version again using `docker pull hyperledger/besu:latest` to make sure your image is up to date. + To ensure your image is up to date, pull the `latest` version again using `docker pull hyperledger/besu:latest`. ## Exposing Ports From 960c19aa2b411282f84c4e1e2f930904ec932603 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Mon, 23 Sep 2019 09:16:49 +0200 Subject: [PATCH 10/11] Update docs/Tutorials/Quickstarts/Privacy-Quickstart.md Signed-off-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Signed-off-by: Nicolas MASSART --- docs/Tutorials/Quickstarts/Privacy-Quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Tutorials/Quickstarts/Privacy-Quickstart.md b/docs/Tutorials/Quickstarts/Privacy-Quickstart.md index 8a7eebbbbb3..cffff67de42 100644 --- a/docs/Tutorials/Quickstarts/Privacy-Quickstart.md +++ b/docs/Tutorials/Quickstarts/Privacy-Quickstart.md @@ -44,7 +44,7 @@ git clone https://github.com/PegaSysEng/besu-quickstart.git ``` !!!note - You can download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases + Download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases. ## Clone EEAJS Libraries From c99bf7a1816e6b1e063a4cd5339cb5a798269b07 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Mon, 23 Sep 2019 09:16:57 +0200 Subject: [PATCH 11/11] Update docs/Tutorials/Quickstarts/Private-Network-Quickstart.md Signed-off-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Signed-off-by: Nicolas MASSART --- docs/Tutorials/Quickstarts/Private-Network-Quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md b/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md index b504a2bf9f8..7c414c76a1f 100644 --- a/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md +++ b/docs/Tutorials/Quickstarts/Private-Network-Quickstart.md @@ -39,7 +39,7 @@ git clone https://github.com/PegaSysEng/besu-quickstart.git ``` !!!note - You can download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases + Download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases. ## Build Docker Images and Start Services and Network