Remove documentation of building container images with jib (#4430)

This is not inline with the official container image.
This commit is contained in:
Thomas Schroeter 2018-12-18 12:27:33 +00:00 committed by GitHub
parent 5a601de584
commit 17e7a3ad7c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 1 additions and 56 deletions

View File

@ -1,54 +0,0 @@
=========================
Building container images
=========================
To build a container image of Corda you can use the Jib gradle tasks. See the `documentation of the Jib gradle plugin <https://github.com/GoogleContainerTools/jib/tree/master/jib-gradle-plugin>`_ for details.
Building the image
==================
To build an image locally you can use the following command. Note that you do not require Docker.
.. sourcecode:: shell
./gradlew node:jib --image <registry>/<image>:<tag>
If you prefer building to a Docker deamon you can use
.. sourcecode:: shell
./gradlew node:jibDockerBuild --image <registry>/<image>:<tag>
Running the image
=================
The Corda application expects its config file in ``/config/node.conf``, make
sure you mount the config file to that location. You might also want to mount
``/credentials`` and ``/persistence.mv.db`` (if you're using H2) in order to
preserve the credentials and node data between container restarts.
The JVM options are currently hardcoded in ``node/build.gradle`` in the
``jib.container`` section.
Below is an example directory layout and command to run your image with Docker.
Make sure to run ``touch persistence.mv.db`` befor starting the container,
otherwise a new directory will be created by Docker.
::
.
├── additional-node-infos
├── certificates
├── config
│   └── node.conf
├── network-parameters
└── persistence.mv.db
.. sourcecode:: shell
docker run --rm -it -v ${PWD}/certificates:/certificates \
-v ${PWD}/config:/config \
-v ${PWD}/network-parameters:/network-parameters \
-v ${PWD}/persistence.mv.db:/persistence.mv.db \
-v ${PWD}/additional-node-infos:/additional-node-infos \
<registry>/<image>:<tag>

View File

@ -52,7 +52,6 @@ We look forward to seeing what you can do with Corda!
azure-vm.rst
aws-vm.rst
loadtesting.rst
building-container-images.rst
cli-application-shell-extensions.rst
.. Documentation is not included in the pdf unless it is included in a toctree somewhere
@ -105,4 +104,4 @@ We look forward to seeing what you can do with Corda!
corda-network/index.md
corda-network/governance-structure.md
corda-network/governance-guidelines.md
corda-network/joining-corda-network.md
corda-network/joining-corda-network.md