Skip to content

Commit

Permalink
tweak docs #8932
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin committed Dec 16, 2022
1 parent aa7b8ee commit 5122515
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 15 deletions.
8 changes: 4 additions & 4 deletions doc/sphinx-guides/source/container/base-image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Supported Image Tags
++++++++++++++++++++

This image is sourced from the main upstream code `repository of the Dataverse software <https://github.com/IQSS/dataverse>`_.
Development and maintenance of the `image's code <https://github.com/IQSS/dataverse/tree/develop/modules/container-base>`
Development and maintenance of the `image's code <https://github.com/IQSS/dataverse/tree/develop/modules/container-base>`_
happens there (again, by the community). Community-supported image tags are based on the two most important
upstream branches:

Expand All @@ -49,7 +49,7 @@ The base image provides:

This image is created as a "multi-arch image", see :ref:`below <base-multiarch>`.

It inherits being built on an Ubuntu environment from the upstream
It inherits (is built on) an Ubuntu environment from the upstream
`base image of Eclipse Temurin <https://hub.docker.com/_/eclipse-temurin>`_.
You are free to change the JRE/JDK image to your liking (see below).

Expand All @@ -75,7 +75,7 @@ Some additional notes, using Maven parameters to change the build and use ...:
| *Note:* default is ``develop``
- | ... a different image name and tag: add ``-Dbase.image=name:tag``.
| *Note:* default is ``gdcc/base:${base.image.tag}``
- ... a different image registry than *Docker Hub*: add ``-Ddocker.registry=registry.example.org`` (see also
- ... a different image registry than Docker Hub: add ``-Ddocker.registry=registry.example.org`` (see also
`DMP docs on registries <https://dmp.fabric8.io/#registry>`__)
- ... a different Payara version: add ``-Dpayara.version=V.YYYY.R``.
- | ... a different Temurin JRE version ``A``: add ``-Dtarget.java.version=A`` (i.e. ``11``, ``17``, ...).
Expand Down Expand Up @@ -351,4 +351,4 @@ from `run-java-sh recommendations`_.

.. _Pre/postboot script docs: https://docs.payara.fish/community/docs/Technical%20Documentation/Payara%20Micro%20Documentation/Payara%20Micro%20Configuration%20and%20Management/Micro%20Management/Asadmin%20Commands/Pre%20and%20Post%20Boot%20Commands.html
.. _MicroProfile Config Sources: https://docs.payara.fish/community/docs/Technical%20Documentation/MicroProfile/Config/Overview.html
.. _run-java-sh recommendations: https://github.com/fabric8io-images/run-java-sh/blob/master/TUNING.md#recommandations
.. _run-java-sh recommendations: https://github.com/fabric8io-images/run-java-sh/blob/master/TUNING.md#recommandations
23 changes: 12 additions & 11 deletions doc/sphinx-guides/source/container/index.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
Container Guide
===============

**Contents:**

.. toctree::

base-image

Running Dataverse software in containers is quite different than in a :doc:`standard installation <../installation/prep>`.
Running the 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 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
deployment way, the container support is mostly created and maintained by the Dataverse community on a best-effort
**As the Institute for Quantitative Social Sciences (IQSS) at Harvard is running a standard, non-containerized installation,
container support described in this guide is mostly created and maintained by the Dataverse community on a best-effort
basis.**

This guide is *not* about installation on technology like Docker Swarm, Kubernetes, Rancher or other
solutions to run containers in production. There is the `Dataverse on K8s project <https://k8s-docs.gdcc.io>`_ for this
purpose.
purpose, as mentioned in the :doc:`/developers/containers` section of the Developer Guide.

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 and how to
develop and extend them further may be found in respective subpages.
develop and extend them further are provided.

**Contents:**

.. toctree::

base-image

2 changes: 2 additions & 0 deletions doc/sphinx-guides/source/developers/containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ The Dataverse Community is exploring the use of Docker, Kubernetes, and other co

The :doc:`testing` section mentions using Docker for integration tests.

See also the :doc:`/container/index`.

.. contents:: |toctitle|
:local:

Expand Down

0 comments on commit 5122515

Please sign in to comment.