Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the install-fabric script & docs #3208

Merged
merged 2 commits into from
May 13, 2022

Conversation

mbwhite
Copy link
Member

@mbwhite mbwhite commented Feb 3, 2022

  • Add podman to install-fabric script
  • Add documentation on this script

Signed-off-by: Matthew B White whitemat@uk.ibm.com

@mbwhite mbwhite requested review from a team as code owners February 3, 2022 10:04
@mbwhite mbwhite force-pushed the install-fabric-podman branch 3 times, most recently from 17cbb8e to 37596c3 Compare February 3, 2022 11:22
nikhil550
nikhil550 previously approved these changes Feb 3, 2022
Copy link
Contributor

@nikhil550 nikhil550 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran the commands on my Intel Mac and everything ran fine.


```bash
./install-fabric.sh -h
Usage: ./install-fabric.sh [-f|--fabric-version <arg>] [-c|--ca-version <arg>] <comp-1> [<comp-2>] ... [<comp-n>] ...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only nit I would have is that I found this help text confusing. For example, this line :d[ocker]|b[inary]|s[amples] is very ugly and hard to parse.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about

<comp>: Component to install one or more of  docker | binary | samples | podman. (first letter of component also accepted)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much cleaner

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikhil550 thanks - I've updated the script accordingly

@mbwhite
Copy link
Member Author

mbwhite commented Feb 9, 2022

@hyperledger/fabric-core-maintainers could you review this please? Thankyou

docs/source/install.md Outdated Show resolved Hide resolved
@mbwhite mbwhite force-pushed the install-fabric-podman branch from a975f90 to da024de Compare March 28, 2022 13:21
docs/source/install.md Outdated Show resolved Hide resolved
docs/source/install.md Outdated Show resolved Hide resolved
docs/source/install.md Outdated Show resolved Hide resolved
@mbwhite mbwhite force-pushed the install-fabric-podman branch from da024de to 3a8c199 Compare March 29, 2022 07:55
@mbwhite
Copy link
Member Author

mbwhite commented Apr 19, 2022

@hyperledger/fabric-core-maintainers could you take a look please...

- Add podman to install-fabric script
- Add documentation on this script

Signed-off-by: Matthew B White <whitemat@uk.ibm.com>
@mbwhite mbwhite force-pushed the install-fabric-podman branch from 3a8c199 to e4761c3 Compare May 13, 2022 10:23
Typo-- thanks!!

Co-authored-by: Andrew Coleman <andrew_coleman@uk.ibm.com>

Signed-off-by: Matthew B White <mbwhite@users.noreply.github.com>
@andrew-coleman andrew-coleman merged commit a9ed50b into hyperledger:main May 13, 2022
Copy link
Contributor

@denyeart denyeart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mbwhite Sorry I didn't see this when it was opened/merged, but I'm not able to make sense of this as-is.

printf '\t%s\n' "<comp>: Component to install one or more of d[ocker]|b[inary]|s[amples]. If none specified, all will be installed"
printf '\t%s\n' "-f, --fabric-version: FabricVersion (default: '2.4.3')"
printf '\t%s\n' "-c, --ca-version: Fabric CA Version (default: '1.5.3')"
printf '\t%s\n' "<comp> Component to install, one or more of docker | binary | samples | podman First letter of component also accepted; If none specified docker | binary | samples is assumed"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seeing this too late... but "podman" isn't a component to install, it is HOW to pull the images from docker hub, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes you are correct... see cmt below...

if [[ ${_arg_comp[@]} =~ d(ocker)? ]]; then
if [[ "${_arg_comp[@]}" =~ ^p(odman)? ]]; then
echo
echo "Pull Hyperledger Fabric podman images"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are not "podman images" or "docker images". They are images pulled using either docker command or podman command, right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's correct

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's correct.... so it would be more accurate to say download the container images or not.. and what tool to choose.

Docker has like 'hover' become a generic term for container/image... but is wrong...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants