Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 4.8 KB

README.md

File metadata and controls

89 lines (57 loc) · 4.8 KB
Raw

Indy Node Container

Building All Containers

This repository aims to provide easy-to-use containers with minimal dependencies to run instances of Hyperledger Indy Node. The primary goal is to support stewards joining an existing Network, but of course the containers can also be used in a stand alone (local/test/...) network. The initial contributions stem from the Container Working Group of ID Union. The repository was contributed to Hyperledger in 2022-02.

Primary artifact are the container images for

We also provide a few utility scripts, including a docker-compose file to help setting up a run time environment for the containers. See here for instructions how to setup and run the indy node images from this repository.

Images

Currently we are providing the following stable indy node images. All those images use the latest Indy Node 1.12 version. The images differ by base image and are tagged accordingly:

  • Ubuntu 16 ⚠️
    • This image is deprecated. We will soon remove the image build from the CD pipeline. Please change to one of the other stable images.
  • Ubuntu 18
  • Debian Buster 10 ⚠️
    • ⚠️ This image is deprecated. We will soon remove the image build from the CD pipeline. Please change to one of the other stable images.
  • Debian Bullseye 11

Additionally, we build an experimental image for Indy node 1.13 RC testing:

See here for instructions how to setup and run the images.

Building

To build the node image you can use docker from the project root like

docker build -f "build/Dockerfile.ubuntu18" -t indy-node-container/indy_node:ubuntu18 ./build

or you can use make which provides some shortcuts

# make [bullseye|buster|ubuntu16|ubuntu18|ubuntu20|all|controller] (default is ubuntu18), e.g.
make ubuntu18

# make clean removes images
# make [clean|clean_bullseye|clean_buster|clean_ubuntu16|clean_ubuntu18|clean_ubuntu20|clean_controller], e.g. this removes all images
make clean

Please note that make generates different tags than the Github action (see packages vs. Makefile).

If you have trivy installed, you can use the make check_* targets to run a trivy check against the local images:

#make [check_bullseye|check_buster|check_ubuntu16|check_ubuntu18|check_ubuntu20|check_controller], e.g.
make check_ubuntu18

Trivy HTML reports are created in ./trivy-reports.

Contributing

Any contribution is welcome, e.g. documentation, bug reports, feature request, issues, blog posts, tutorials, feature implementations, etc. You can contribute code or documentation through the standard GitHub pull request model.

Please have a look at CONTRIBUTING.md for details, in particular how and why you need to sign off commits.

Code of Conduct

Be excellent to each other!

See CODE_OF_CONDUCT.md for details.

License

Copyright 2020-2022 by all parties listed in the NOTICE file

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.