Skip to content

Commit

Permalink
docs(ct-base): incorporate review suggestions #8932
Browse files Browse the repository at this point in the history
  • Loading branch information
poikilotherm committed Nov 10, 2022
1 parent 4a79dcb commit f1a64a8
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
2 changes: 2 additions & 0 deletions doc/sphinx-guides/source/container/base-image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ A "base image" offers you a pre-installed and pre-tuned application server to de
Adding basic functionality like executing scripts at container boot, monitoring, memory tweaks etc is all done
at this layer, to make the application image focus on the app itself.

**NOTE: The base image does not contain the Dataverse application itself.**

Within the main repository, you may find the base image's files at ``<git root>/modules/container-base``.
This Maven module uses the `Maven Docker Plugin <https://dmp.fabric8.io>`_ to build and ship the image.
You may use, extend, or alter this image to your liking and/or host in some different registry if you want to.
Expand Down
8 changes: 4 additions & 4 deletions doc/sphinx-guides/source/container/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Container Guide

base-image

Running Dataverse software in containers is quite different than in a :doc:`classic installation <../installation/prep>`.
Running Dataverse software in containers is quite different than in a :doc:`standard installation <../installation/prep>`.

Both approaches have pros and cons. These days, containers are very often used for development and testing,
but there is an ever rising move for running applications in the cloud using container technology.
but there is an ever rising move toward running applications in the cloud using container technology.

**NOTE:**
**As the Institute for Quantitative Social Sciences (IQSS) at Harvard is running their installations in the classic
Expand All @@ -22,5 +22,5 @@ solutions to run containers in production. There is the `Dataverse on K8s projec
purpose.

This guide focuses on describing the container images managed from the main Dataverse repository (again: by the
community, not IQSS), their features and limitations. Instructions on how to build the images yourself, how to
extend them and how to use them for development purposes may be found in respective subpages.
community, not IQSS), their features and limitations. Instructions on how to build the images yourself and how to
develop and extend them further may be found in respective subpages.
13 changes: 9 additions & 4 deletions modules/container-base/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Dataverse Base Container Image

A "base image" offers you a pre-installed and pre-tuned application server to deploy Dataverse software to.
The Dataverse Base Container Image contains primarily a pre-installed and pre-tuned application server with the
necessary software dependencies for deploying and launching a Dataverse repository installation.

Adding basic functionality like executing scripts at container boot, monitoring, memory tweaks, etc., is all done
at this layer, to make the application image focus on the app itself.
at this layer. Application images building from this very base focus on adding deployable Dataverse code and
actual scripts.

*Note:* Currently, there is no application image. Please watch https://github.com/IQSS/dataverse/issues/8934

## Quick Reference

Expand All @@ -17,7 +22,7 @@ provides in-depth information about content, building, tuning and so on for this

**Where to get help and ask questions:**

IQSS will not offer you support how to deploy or run it. Please reach out to the community for help on using it.
IQSS will not offer support on how to deploy or run it. Please reach out to the community for help on using it.
You can join the Community Chat on Matrix at https://chat.dataverse.org or the Community Slack at
https://dataversecommunity.slack.com to ask for help and guidance.

Expand All @@ -33,7 +38,7 @@ most important branches:
([`Dockerfile`](https://github.com/IQSS/dataverse/tree/master/modules/container-base/src/main/docker/Dockerfile))

Within the main repository, you may find the base image files at `<git root>/modules/container-base`.
This Maven module uses the `Maven Docker Plugin <https://dmp.fabric8.io>`_ to build and ship the image.
This Maven module uses the [Maven Docker Plugin](https://dmp.fabric8.io) to build and ship the image.
You may use, extend, or alter this image to your liking and/or host in some different registry if you want to.

**Supported architectures:** This image is created as a "multi-arch image", supporting the most common architectures
Expand Down

0 comments on commit f1a64a8

Please sign in to comment.