diff --git a/doc/sphinx-guides/source/container/base-image.rst b/doc/sphinx-guides/source/container/base-image.rst index b03879f83f8..931c722f91b 100644 --- a/doc/sphinx-guides/source/container/base-image.rst +++ b/doc/sphinx-guides/source/container/base-image.rst @@ -23,7 +23,7 @@ Supported Image Tags ++++++++++++++++++++ This image is sourced from the main upstream code `repository of the Dataverse software `_. -Development and maintenance of the `image's code ` +Development and maintenance of the `image's code `_ happens there (again, by the community). Community-supported image tags are based on the two most important upstream branches: @@ -49,7 +49,7 @@ The base image provides: This image is created as a "multi-arch image", see :ref:`below `. -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 `_. You are free to change the JRE/JDK image to your liking (see below). @@ -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 `__) - ... 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``, ...). @@ -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 \ No newline at end of file +.. _run-java-sh recommendations: https://github.com/fabric8io-images/run-java-sh/blob/master/TUNING.md#recommandations diff --git a/doc/sphinx-guides/source/container/index.rst b/doc/sphinx-guides/source/container/index.rst index 25d891016ed..92ac94e2cf2 100644 --- a/doc/sphinx-guides/source/container/index.rst +++ b/doc/sphinx-guides/source/container/index.rst @@ -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 `_ 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. \ No newline at end of file +develop and extend them further are provided. + +**Contents:** + +.. toctree:: + + base-image + diff --git a/doc/sphinx-guides/source/developers/containers.rst b/doc/sphinx-guides/source/developers/containers.rst index 64c7710f0f5..63eff266a4f 100755 --- a/doc/sphinx-guides/source/developers/containers.rst +++ b/doc/sphinx-guides/source/developers/containers.rst @@ -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: