Skip to content

Commit

Permalink
docs(ct): add documentation about changing passwords and some more
Browse files Browse the repository at this point in the history
 Also includes a release note
  • Loading branch information
poikilotherm committed Jul 15, 2024
1 parent c1c6b16 commit 5c7a91c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
12 changes: 12 additions & 0 deletions doc/release-notes/10508-base-image-fixes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Security and Compatibility Fixes to the Container Base Image

- Switch "wait-for" to "wait4x", aligned with the Configbaker Image
- Update "jattach" to v2.2
- Install AMD64 / ARM64 versions of tools as necessary
- Run base image as unprivileged user by default instead of `root` - this was an oversight from OpenShift changes
- Linux User, Payara Admin and Domain Master passwords:
- Print hints about default, public knowledge passwords in place for
- Enable replacing these passwords at container boot time
- Enable building with updates Temurin JRE image based on Ubuntu 24.04 LTS
- Fix entrypoint script troubles with pre- and postboot script files
- Unify location of files at CONFIG_DIR=/opt/payara/config, avoid writing to other places
20 changes: 17 additions & 3 deletions doc/sphinx-guides/source/container/base-image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Some additional notes, using Maven parameters to change the build and use ...:
(See also `Docker Hub search example <https://hub.docker.com/_/eclipse-temurin/tags?page=1&name=11-jre>`_)
- ... a different Java Distribution: add ``-Djava.image="name:tag"`` with precise reference to an
image available local or remote.
- ... a different UID/GID for the ``payara`` user/group: add ``-Dbase.image.uid=1234`` (or ``.gid``)
- ... a different UID/GID for the ``payara`` user/group (default ``1000:1000``): add ``-Dbase.image.uid=1234`` (or ``.gid``)

Automated Builds & Publishing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -151,12 +151,12 @@ provides. These are mostly based on environment variables (very common with cont
- [preboot]_
- Abs. path
- Provide path to file with ``asadmin`` commands to run **before** boot of application server.
See also `Pre/postboot script docs`_.
See also `Pre/postboot script docs`_. Must be writeable by Payara Linux user!
* - ``POSTBOOT_COMMANDS``
- [postboot]_
- Abs. path
- Provide path to file with ``asadmin`` commands to run **after** boot of application server.
See also `Pre/postboot script docs`_.
See also `Pre/postboot script docs`_. Must be writeable by Payara Linux user!
* - ``JVM_ARGS``
- (empty)
- String
Expand Down Expand Up @@ -231,6 +231,18 @@ provides. These are mostly based on environment variables (very common with cont
- See :ref:`:ApplicationServerSettings` ``http.request-timeout-seconds``.

*Note:* can also be set using any other `MicroProfile Config Sources`_ available via ``dataverse.http.timeout``.
* - ``PAYARA_ADMIN_PASSWORD``
- ``admin``
- String
- Set to secret string to change `Payara Admin Console`_ Adminstrator User ("admin") password.
* - ``LINUX_PASSWORD``
- ``payara``
- String
- Set to secret string to change the Payara Linux User ("payara", default UID=1000) password.
* - ``DOMAIN_PASSWORD``
- ``changeit``
- String
- Set to secret string to change the `Domain Master Password`_.


.. [preboot] ``${CONFIG_DIR}/pre-boot-commands.asadmin``
Expand Down Expand Up @@ -374,3 +386,5 @@ 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
.. _Domain Master Password: https://docs.payara.fish/community/docs/Technical%20Documentation/Payara%20Server%20Documentation/Security%20Guide/Administering%20System%20Security.html#to-change-the-master-password
.. _Payara Admin Console: https://docs.payara.fish/community/docs/Technical%20Documentation/Payara%20Server%20Documentation/General%20Administration/Overview.html#administration-console

0 comments on commit 5c7a91c

Please sign in to comment.