Skip to content

Commit

Permalink
Start 4.0 release notes (#1014)
Browse files Browse the repository at this point in the history
* mv these items to include files

* start 4.0 release notes
  • Loading branch information
johrstrom authored Nov 19, 2024
1 parent 1185e05 commit 104888e
Show file tree
Hide file tree
Showing 6 changed files with 109 additions and 46 deletions.
1 change: 1 addition & 0 deletions source/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Release Notes
.. toctree::
:maxdepth: 2

release-notes/v4.0-release-notes
release-notes/v3.1-release-notes
release-notes/v3.0-release-notes
release-notes/v2.0-release-notes
Expand Down
12 changes: 12 additions & 0 deletions source/release-notes/allowlist.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
These configurations that have whitelist in the name have been deprecated
in 3.0 and replaced with allowlist or blocklist in 4.0.

The configurations ``maintenance_ip_whitelist`` for configuring maintenance ips
has been replaced by ``maintenance_ip_allowlist``.

The ``WHITELIST_PATH`` environment variable for configuring inaccessible paths
in the file browser has been replaced by ``OOD_ALLOWLIST_PATH``.

ACL configurations in ``cluster.d`` files now use ``allowlist`` and ``blocklist``
instead of ``whitelist`` and ``blacklist``, though sites should just use
Linux FACLs to control these files instead of these configurations.
28 changes: 28 additions & 0 deletions source/release-notes/autoload.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
This comes from the Ruby on Rails framework that Open OnDemand utilizes.
It affects initializers you may have written, for example to :ref:`add-shortcuts-to-files-menu`.

To resolve this, wrap your code in a ``Rails.application.config.after_initialize`` block.

For example, if you have:

.. code-block:: ruby

# /etc/ood/config/apps/dashboard/initializers/ood.rb

OodFilesApp.candidate_favorite_paths.tap do |paths|
# add User project space directory
paths << FavoritePath.new("/fs/project/#{User.new.name}")
end

You will need to modify that file like so:

.. code-block:: ruby

# /etc/ood/config/apps/dashboard/initializers/ood.rb

Rails.application.config.after_initialize do
OodFilesApp.candidate_favorite_paths.tap do |paths|
# add User project space directory
paths << FavoritePath.new("/fs/project/#{User.new.name}")
end
end
7 changes: 7 additions & 0 deletions source/release-notes/navconfig.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
The initializers used to modify the navigation bar and the class
``NavConfig`` is deprecated in 3.0 and will be removed in 4.0.
The 3.x series will continue to support this, but sites should use the
``nav_categories`` property instead.

See :ref:`limit-auto-generated-menu-bars` and the
:ref:`nav_categories configuration property <nav_categories>` for more details.
49 changes: 3 additions & 46 deletions source/release-notes/v3.0-release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,60 +110,17 @@ Deprecations
Autoloading during initialization is deprecated.
************************************************

This comes from the Ruby on Rails framework that Open OnDemand utilizes.
It affects initializers you may have written, for example to :ref:`add-shortcuts-to-files-menu`.

To resolve this, wrap your code in a ``Rails.application.config.after_initialize`` block.

For example, if you have:

.. code-block:: ruby
# /etc/ood/config/apps/dashboard/initializers/ood.rb
OodFilesApp.candidate_favorite_paths.tap do |paths|
# add User project space directory
paths << FavoritePath.new("/fs/project/#{User.new.name}")
end
You will need to modify that file like so:

.. code-block:: ruby
# /etc/ood/config/apps/dashboard/initializers/ood.rb
Rails.application.config.after_initialize do
OodFilesApp.candidate_favorite_paths.tap do |paths|
# add User project space directory
paths << FavoritePath.new("/fs/project/#{User.new.name}")
end
end
.. include:: autoload.inc

NavConfig is deprecated
***********************

The initializers used to modify the navigation bar and the class
``NavConfig`` is deprecated. The 2.x series will continue to support
this, but sites should use the ``nav_categories`` property instead.

See :ref:`limit-auto-generated-menu-bars` and the
:ref:`nav_categories configuration property <nav_categories>` for more details.
.. include:: navconfig.inc

whitelist & blacklist configs are deprecated
********************************************

These configurations that have whitelist in the name have been deprecated
and replaced with allowlist or blocklist.

The configurations ``maintenance_ip_whitelist`` for configuring maintenance ips
has been replaced by ``maintenance_ip_allowlist``.

The ``WHITELIST_PATH`` environment variable for configuring inaccessible paths
in the file browser has been replaced by ``OOD_ALLOWLIST_PATH``.

ACL configurations in ``cluster.d`` files now use ``allowlist`` and ``blocklist``
instead of ``whitelist`` and ``blacklist``, though sites should just use
Linux FACLs to control these files instead of these configurations.
.. include:: allowlist.inc

Dependency updates
..................
Expand Down
58 changes: 58 additions & 0 deletions source/release-notes/v4.0-release-notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
.. _v4.0-release-notes:

v4.0 Release Notes
==================

Administrative changes
----------------------

- `Breaking Changes`_

New Features
------------

Thanks!
-------

We'd like to thank a bunch of folks' for contributing to this release.
As we only know the github username, that's what's being referenced here.



Details of administrative changes
---------------------------------

Breaking Changes
................

Autoloading during initialization has been removed.
***************************************************

.. include:: autoload.inc

NavConfig has been removed.
***************************

.. include:: navconfig.inc

whitelist & blacklist configs have been removed.
************************************************

.. include:: allowlist.inc

Dependency updates
..................



SELinux changes
...............


Upgrade directions
..................



Details of new features
-----------------------

0 comments on commit 104888e

Please sign in to comment.