Skip to content

Commit

Permalink
add docs IQSS#9573
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin committed May 25, 2023
1 parent 36a43ac commit 920770a
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/release-notes/9573-configbaker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A container has been added called "configbaker" that configures Dataverse while running in containers.
25 changes: 25 additions & 0 deletions doc/sphinx-guides/source/container/configbaker-image.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
ConfigBaker Image
=================

The ConfigBaker image is designed to run shortly after the Dataverse software has been installed and configures it.

.. contents:: |toctitle|
:local:

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-configbaker>`_
happens there (again, by the community). Community-supported image tags are based on the two most important
upstream branches:

- The ``unstable`` tag corresponds to the ``develop`` branch, where pull requests are merged.
(`Dockerfile <https://github.com/IQSS/dataverse/tree/develop/modules/container-configbaker/src/main/docker/Dockerfile>`__)
- The ``alpha`` tag corresponds to the ``master`` branch, where releases are cut from.
(`Dockerfile <https://github.com/IQSS/dataverse/tree/master/modules/container-configbaker/src/main/docker/Dockerfile>`__)

Image Contents
++++++++++++++

- Scripts for bootstrapping Dataverse
1 change: 1 addition & 0 deletions doc/sphinx-guides/source/container/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ develop and extend them further are provided.
dev-usage
base-image
app-image
configbaker-image
42 changes: 41 additions & 1 deletion modules/container-configbaker/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# ConfigBaker

This is a placeholder. Needs more info about it.
The ConfigBaker image is designed to run shortly after the Dataverse software has been installed and configures it.

## 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 - ConfigBaker Image](https://guides.dataverse.org/en/latest/container/configbaker-image.html)
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 on Matrix at https://chat.dataverse.org and https://groups.google.com/g/dataverse-community
to ask for help and guidance.

## Supported Image Tags

This image is sourced within 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-configbaker)
happens there (again, by the community). Community-supported image tags are based on the two most important branches:

- The `unstable` tag corresponds to the `develop` branch, where pull requests are merged.
([`Dockerfile`](https://github.com/IQSS/dataverse/tree/develop/modules/container-configbaker/src/main/docker/Dockerfile))
- The `alpha` tag corresponds to the `master` branch, where releases are cut from.
([`Dockerfile`](https://github.com/IQSS/dataverse/tree/master/modules/container-configbaker/src/main/docker/Dockerfile))

## License

Image content created by the community is licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0),
like the [main Dataverse project](https://github.com/IQSS/dataverse/blob/develop/LICENSE.md).

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies
with any relevant licenses for all software contained within.

0 comments on commit 920770a

Please sign in to comment.