Skip to content

Commit 50b7a96

Browse files
authored
update docs to suggest using Docker in production (#11862)
1 parent b78060a commit 50b7a96

File tree

9 files changed

+23
-40
lines changed

9 files changed

+23
-40
lines changed

doc/sphinx-guides/source/container/app-image.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ Within the main repository, you may find the application image's files at ``<git
1717
This is the same Maven module providing a Dataverse WAR file for classic installations, and uses the
1818
`Maven Docker Plugin <https://dmp.fabric8.io>`_ to build and ship the image within a special Maven profile.
1919

20-
**NOTE: This image is created, maintained and supported by the Dataverse community on a best-effort basis.**
21-
IQSS will not offer you support how to deploy or run it, please reach out to the community for help on using it.
22-
You might be interested in taking a look at :doc:`../developers/containers`, linking you to some (community-based)
23-
efforts.
24-
2520
.. _app-image-supported-tags:
2621

2722
Supported Image Tags

doc/sphinx-guides/source/container/base-image.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@ Within the main repository, you may find the base image's files at ``<git root>/
1616
This Maven module uses the `Maven Docker Plugin <https://dmp.fabric8.io>`_ to build and ship the image.
1717
You may use, extend, or alter this image to your liking and/or host in some different registry if you want to.
1818

19-
**NOTE: This image is created, maintained and supported by the Dataverse community on a best-effort basis.**
20-
IQSS will not offer you support how to deploy or run it, please reach out to the community (:ref:`support`) for help on using it.
21-
You might be interested in taking a look at :doc:`../developers/containers`, linking you to some (community-based)
22-
efforts.
23-
2419
.. _base-image-supported-tags:
2520

2621
Supported Image Tags

doc/sphinx-guides/source/container/dev-usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Development Usage
22
=================
33

4-
Please note! This Docker setup is not for production!
4+
Please note! This Docker setup is not for :doc:`production <running/production>`!
55

66
.. contents:: |toctitle|
77
:local:

doc/sphinx-guides/source/container/intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Dataverse in containers!
99
Intended Audience
1010
-----------------
1111

12-
This guide is intended for anyone who wants to run Dataverse in containers. This is potentially a wide audience, from sysadmins interested in running Dataverse in production in containers (not recommended yet) to contributors working on a bug fix (encouraged!). See :doc:`running/index` for various scenarios and please let us know if your use case is not covered.
12+
This guide is intended for anyone who wants to run Dataverse in containers. This is potentially a wide audience, from sysadmins interested in running Dataverse in production in containers to contributors working on a bug fix. See :doc:`running/index` for various scenarios and please let us know if your use case is not covered.
1313

1414
.. _getting-help-containers:
1515

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,21 @@
1-
Production (Future)
2-
===================
1+
Production
2+
==========
33

44
.. contents:: |toctitle|
55
:local:
66

77
Status
88
------
99

10-
The images described in this guide are not yet recommended for production usage, but we think we are close. (Tagged releases are done; see the "supported image tags" section for :ref:`Application <app-image-supported-tags>` and :ref:`Config Baker <config-image-supported-tags>` images.) For now, please see :doc:`demo`.
10+
As of Dataverse 6.8, when we introduced image tagging per version (see the :ref:`app-image-supported-tags` section for the :ref:`application image <app-image-supported-tags>`), we feel that the images described in this guide are ready for production use. Enjoy!
1111

12-
We'd like to make the following improvements:
12+
The images and the documentation is not perfect, of course.
1313

14-
- More docs on setting up additional features
14+
For now, we recommend following the :doc:`demo` tutorial. It will help you learn how to configure and secure your installation. Not that instead of "latest" you might want to select a specific version. Again see :ref:`app-image-supported-tags`.
1515

16-
- How to set up Rserve.
16+
The Dataverse guides were originally written with a non-Docker installation in mind so we'd like rewrite them with both Docker and non-Docker in mind. This is a big job, obviously. 😅 We know we'd like to write more about ports. We'd like to explain `how to set up Rserve <https://github.com/IQSS/dataverse/issues/11731>`_. Etc., etc.
1717

18-
- Go through all the features in docs and check what needs to be done differently with containers
19-
20-
- Check ports, for example.
21-
22-
To join the discussion on what else might be needed before declaring images ready for production, please comment on https://dataverse.zulipchat.com/#narrow/stream/375812-containers/topic/containers.20for.20production/near/434979159
23-
24-
You are also very welcome to join our meetings. See "how to help" below.
18+
To talk about your ideas for making the images and docs better for production, please feel free to join the `containers for production <https://dataverse.zulipchat.com/#narrow/channel/375812-containers/topic/containers.20for.20production/with/451611258>`_ topic or join a working group meeting (see :ref:`helping-containers`).
2519

2620
Limitations
2721
-----------
@@ -31,9 +25,9 @@ Limitations
3125
How to Help
3226
-----------
3327

34-
You can help the effort to support these images in production by trying them out (see :doc:`demo`) and giving feedback (see :ref:`helping-containers`).
28+
Please try the images (see :doc:`demo`) and give feedback (see :ref:`helping-containers`)! ❤️
3529

3630
Alternatives
3731
------------
3832

39-
Until the images are ready for production, please use the traditional installation method described in the :doc:`/installation/index`.
33+
The traditional (non-Docker) installation method is described in the :doc:`/installation/index`.

doc/sphinx-guides/source/installation/intro.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,18 @@ Jump ahead to :doc:`config` or :doc:`upgrading` for an existing Dataverse instal
1717
Intended Audience
1818
-----------------
1919

20-
This guide is intended primarily for sysadmins who are installing, configuring, and upgrading a Dataverse installation.
20+
This guide is intended primarily for sysadmins who are installing, configuring, and upgrading a Dataverse installation. This guide was written with non-Docker installation in mind but if you're interested in Docker, see the :doc:`/container/index`.
2121

2222
Sysadmins are expected to be comfortable using standard Linux commands, issuing ``curl`` commands, and running SQL scripts.
2323

2424
Related Guides
2525
--------------
2626

27+
See the :doc:`/container/index` if you want to run Dataverse in Docker.
28+
2729
Many "admin" functions can be performed by Dataverse installation users themselves (non-superusers) as documented in the :doc:`/user/index` and that guide is a good introduction to the features of the Dataverse Software from an end user perspective.
2830

29-
If you are a sysadmin who likes to code, you may find the :doc:`/api/index` useful, and you may want to consider improving the installation script or hacking on the community-lead configuration management options mentioned in the :doc:`prep` section. If you **really** like to code and want to help with the Dataverse Software code, please check out the :doc:`/developers/index`!
31+
If you are a sysadmin who likes to code, you may find the :doc:`/api/index` useful, and you may want to consider improving the installation script or hacking on the community-lead configuration management options mentioned in the :doc:`prep` section. If you **really** like to code and want to help with the Dataverse code or documentation, please check out the :doc:`/contributor/index` and the :doc:`/developers/index`!
3032

3133
.. _support:
3234

doc/sphinx-guides/source/installation/prep.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ Standard Installation
1919

2020
Installing the Dataverse Software involves some system configuration followed by executing an installation script that will guide you through the installation process as described in :doc:`installation-main`, but reading about the :ref:`architecture` of the Dataverse Software is recommended first.
2121

22+
.. _docker-installation:
23+
24+
Docker Installation
25+
+++++++++++++++++++
26+
27+
See the :doc:`/container/index`, especially :doc:`/container/running/index` and :doc:`/container/running/production`.
28+
2229
.. _advanced:
2330

2431
Advanced Installation
@@ -32,7 +39,7 @@ There are some community-lead projects to use configuration management tools suc
3239

3340
(Please note that the "dataverse-ansible" repo is used in a script that allows the Dataverse Software to be installed on Amazon Web Services (AWS) from arbitrary GitHub branches as described in the :doc:`/developers/deployment` section of the Developer Guide.)
3441

35-
The Dataverse Project team is happy to "bless" additional community efforts along these lines (i.e. Docker, Chef, Salt, etc.) by creating a repo under https://github.com/gdcc and managing team access.
42+
The Dataverse Project team is happy to "bless" additional community efforts along these lines (i.e. Chef, Salt, etc.) by creating a repo under https://github.com/gdcc and managing team access.
3643

3744
The Dataverse Software permits a fair amount of flexibility in where you choose to install the various components. The diagram below shows a load balancer, multiple proxies and web servers, redundant database servers, and offloading of potentially resource intensive work to a separate server. (Glassfish is shown rather than Payara.)
3845

modules/container-base/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,13 @@ this image for other purposes than the Dataverse application.
1313

1414
## Quick Reference
1515

16-
**Maintained by:**
17-
18-
This image is created, maintained and supported by the Dataverse community on a best-effort basis.
19-
2016
**Where to find documentation:**
2117

2218
The [Dataverse Container Guide - Base Image](https://guides.dataverse.org/en/latest/container/base-image.html)
2319
provides in-depth information about content, building, tuning and so on for this image.
2420

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

27-
IQSS will not offer support on how to deploy or run it. Please reach out to the community for help on using it.
2823
You can join the Community Chat at https://chat.dataverse.org and https://groups.google.com/g/dataverse-community
2924
to ask for help and guidance.
3025

modules/container-configbaker/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,13 @@ You may use this image as is, base your own derivative image on it or use bind m
77

88
## Quick Reference
99

10-
**Maintained by:**
11-
12-
This image is created, maintained and supported by the Dataverse community on a best-effort basis.
13-
1410
**Where to find documentation:**
1511

1612
The [Dataverse Container Guide - Config Baker Image](https://guides.dataverse.org/en/latest/container/configbaker-image.html)
1713
provides information about this image.
1814

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

21-
IQSS will not offer support on how to deploy or run it. Please reach out to the community for help on using it.
2217
You can join the Community Chat at https://chat.dataverse.org and https://groups.google.com/g/dataverse-community
2318
to ask for help and guidance.
2419

0 commit comments

Comments
 (0)