diff --git a/doc/sphinx-guides/source/container/app-image.rst b/doc/sphinx-guides/source/container/app-image.rst index 47055bd3786..13133a9760f 100644 --- a/doc/sphinx-guides/source/container/app-image.rst +++ b/doc/sphinx-guides/source/container/app-image.rst @@ -17,11 +17,6 @@ Within the main repository, you may find the application image's files at ```_ to build and ship the image within a special Maven profile. -**NOTE: This image is created, maintained and supported by the Dataverse community on a best-effort basis.** -IQSS will not offer you support how to deploy or run it, please reach out to the community for help on using it. -You might be interested in taking a look at :doc:`../developers/containers`, linking you to some (community-based) -efforts. - .. _app-image-supported-tags: Supported Image Tags diff --git a/doc/sphinx-guides/source/container/base-image.rst b/doc/sphinx-guides/source/container/base-image.rst index 4adc6bb6fb1..8b8079c7b6e 100644 --- a/doc/sphinx-guides/source/container/base-image.rst +++ b/doc/sphinx-guides/source/container/base-image.rst @@ -16,11 +16,6 @@ Within the main repository, you may find the base image's files at ``/ This Maven module uses the `Maven Docker Plugin `_ 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. -**NOTE: This image is created, maintained and supported by the Dataverse community on a best-effort basis.** -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. -You might be interested in taking a look at :doc:`../developers/containers`, linking you to some (community-based) -efforts. - .. _base-image-supported-tags: Supported Image Tags diff --git a/doc/sphinx-guides/source/container/dev-usage.rst b/doc/sphinx-guides/source/container/dev-usage.rst index c02c1d4010f..518e1c7eef0 100644 --- a/doc/sphinx-guides/source/container/dev-usage.rst +++ b/doc/sphinx-guides/source/container/dev-usage.rst @@ -1,7 +1,7 @@ Development Usage ================= -Please note! This Docker setup is not for production! +Please note! This Docker setup is not for :doc:`production `! .. contents:: |toctitle| :local: diff --git a/doc/sphinx-guides/source/container/intro.rst b/doc/sphinx-guides/source/container/intro.rst index 5099531dcc9..77187f2b40b 100644 --- a/doc/sphinx-guides/source/container/intro.rst +++ b/doc/sphinx-guides/source/container/intro.rst @@ -9,7 +9,7 @@ Dataverse in containers! Intended Audience ----------------- -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. +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. .. _getting-help-containers: diff --git a/doc/sphinx-guides/source/container/running/production.rst b/doc/sphinx-guides/source/container/running/production.rst index 4fe16447d7e..723e4d31298 100644 --- a/doc/sphinx-guides/source/container/running/production.rst +++ b/doc/sphinx-guides/source/container/running/production.rst @@ -1,5 +1,5 @@ -Production (Future) -=================== +Production +========== .. contents:: |toctitle| :local: @@ -7,21 +7,15 @@ Production (Future) Status ------ -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 ` and :ref:`Config Baker ` images.) For now, please see :doc:`demo`. +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 `), we feel that the images described in this guide are ready for production use. Enjoy! -We'd like to make the following improvements: +The images and the documentation is not perfect, of course. -- More docs on setting up additional features +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`. - - How to set up Rserve. +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 `_. Etc., etc. -- Go through all the features in docs and check what needs to be done differently with containers - - - Check ports, for example. - -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 - -You are also very welcome to join our meetings. See "how to help" below. +To talk about your ideas for making the images and docs better for production, please feel free to join the `containers for production `_ topic or join a working group meeting (see :ref:`helping-containers`). Limitations ----------- @@ -31,9 +25,9 @@ Limitations How to Help ----------- -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`). +Please try the images (see :doc:`demo`) and give feedback (see :ref:`helping-containers`)! ❤️ Alternatives ------------ -Until the images are ready for production, please use the traditional installation method described in the :doc:`/installation/index`. +The traditional (non-Docker) installation method is described in the :doc:`/installation/index`. \ No newline at end of file diff --git a/doc/sphinx-guides/source/installation/intro.rst b/doc/sphinx-guides/source/installation/intro.rst index 1c239863e98..e13c22824b7 100644 --- a/doc/sphinx-guides/source/installation/intro.rst +++ b/doc/sphinx-guides/source/installation/intro.rst @@ -17,16 +17,18 @@ Jump ahead to :doc:`config` or :doc:`upgrading` for an existing Dataverse instal Intended Audience ----------------- -This guide is intended primarily for sysadmins who are installing, configuring, and upgrading a Dataverse installation. +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`. Sysadmins are expected to be comfortable using standard Linux commands, issuing ``curl`` commands, and running SQL scripts. Related Guides -------------- +See the :doc:`/container/index` if you want to run Dataverse in Docker. + 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. -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`! +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`! .. _support: diff --git a/doc/sphinx-guides/source/installation/prep.rst b/doc/sphinx-guides/source/installation/prep.rst index 33b1aa3c7b5..748400827be 100644 --- a/doc/sphinx-guides/source/installation/prep.rst +++ b/doc/sphinx-guides/source/installation/prep.rst @@ -19,6 +19,13 @@ Standard Installation 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. +.. _docker-installation: + +Docker Installation ++++++++++++++++++++ + +See the :doc:`/container/index`, especially :doc:`/container/running/index` and :doc:`/container/running/production`. + .. _advanced: Advanced Installation @@ -32,7 +39,7 @@ There are some community-lead projects to use configuration management tools suc (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.) -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. +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. 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.) diff --git a/modules/container-base/README.md b/modules/container-base/README.md index 7a39457b766..bfe3da3d08e 100644 --- a/modules/container-base/README.md +++ b/modules/container-base/README.md @@ -13,10 +13,6 @@ this image for other purposes than the Dataverse application. ## Quick Reference -**Maintained by:** - -This image is created, maintained and supported by the Dataverse community on a best-effort basis. - **Where to find documentation:** The [Dataverse Container Guide - Base Image](https://guides.dataverse.org/en/latest/container/base-image.html) @@ -24,7 +20,6 @@ provides in-depth information about content, building, tuning and so on for this **Where to get help and ask questions:** -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 at https://chat.dataverse.org and https://groups.google.com/g/dataverse-community to ask for help and guidance. diff --git a/modules/container-configbaker/README.md b/modules/container-configbaker/README.md index 8b68e3db692..d05fa2103ff 100644 --- a/modules/container-configbaker/README.md +++ b/modules/container-configbaker/README.md @@ -7,10 +7,6 @@ You may use this image as is, base your own derivative image on it or use bind m ## Quick Reference -**Maintained by:** - -This image is created, maintained and supported by the Dataverse community on a best-effort basis. - **Where to find documentation:** The [Dataverse Container Guide - Config Baker Image](https://guides.dataverse.org/en/latest/container/configbaker-image.html) @@ -18,7 +14,6 @@ provides information about this image. **Where to get help and ask questions:** -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 at https://chat.dataverse.org and https://groups.google.com/g/dataverse-community to ask for help and guidance.