Add content to Docker page for review. #114
Conversation
There was a problem hiding this comment.
There are two use-cases that are probably worth considering, and the context of each sets up the semantics.
- Integrating
cardano-nodeinto an existing Docker application (a collection of services, each in their own container). This scope covers development, testing, and production environments, - Deployment of a Cardano stack using a container runtime
I would suggest reworking the structure to reflect this, and I can then provide more feedback.
|
|
||
| Read first: [Running a Cardano node](../cardano-node.md) | ||
|
|
||
| Read next: [Configuring a Cardano node using a config.yaml file](node-config-yaml.md) |
There was a problem hiding this comment.
cardano-node developers will be the best contacts for assistance with this page. The Docker image simply defines a mount point for the user to pass configuration in at runtime if not wishing to use the IOHK-managed config.
|
|
||
| Read next: [Configuring a Cardano node using a config.yaml file](node-config-yaml.md) | ||
|
|
||
| You can use Docker to quickly set up and run a Cardano node. Multiple Docker images are available, each preconfigured to connect to a specific public Cardano network. There is also a base image available, which runs an unconfigured Cardano node that can be provided with a custom `config.yaml` file. All of the preconfigured Docker images contain this base image with an additional configuration layer. |
There was a problem hiding this comment.
Multiple Docker images are available, each preconfigured to connect to a specific public Cardano network
Tags suitable for development and production dependency pinning are pushed to the Dockerhub registry, with default configuration for joining public supported networks available by setting the NETWORK environment variable at runtime
There is also a base image available, which runs an unconfigured Cardano node that can be provided with a custom
config.yamlfile
There's been a late change to the design that condenses the base and network variants to a single image. At runtime the user can elect to use the IOHK-managed configuration for each public, or omit the NETWORK and simply mount config into the container.
|
|
||
| You can use Docker to quickly set up and run a Cardano node. Multiple Docker images are available, each preconfigured to connect to a specific public Cardano network. There is also a base image available, which runs an unconfigured Cardano node that can be provided with a custom `config.yaml` file. All of the preconfigured Docker images contain this base image with an additional configuration layer. | ||
|
|
||
| For a full list of the available Docker images, see the official [Cardano node Docker Hub](link to Cardano node docker Hub) page. <!-- Do we need to define the PIN format here too?--> |
There was a problem hiding this comment.
| For a full list of the available Docker images, see the official [Cardano node Docker Hub](link to Cardano node docker Hub) page. <!-- Do we need to define the PIN format here too?--> | |
| See the IOHK [Cardano node Docker Hub repository](https://hub.docker.com/repository/docker/inputoutput/cardano-node) for the available tags. |
| For a full list of the available Docker images, see the official [Cardano node Docker Hub](link to Cardano node docker Hub) page. <!-- Do we need to define the PIN format here too?--> | ||
|
|
||
| ## Prerequisites | ||
| You need to have Docker installed and configured on your machine. See the [Docker documentation](https://docs.docker.com/install/) for more information. |
There was a problem hiding this comment.
This can be refined when the use-cases are separated
| ## Prerequisites | ||
| You need to have Docker installed and configured on your machine. See the [Docker documentation](https://docs.docker.com/install/) for more information. | ||
|
|
||
| ## Steps |
There was a problem hiding this comment.
I can also refine this later, as it's dependent on the context
No description provided.