Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review server upgrade and password provider pages #576

Merged
merged 13 commits into from Dec 12, 2013
Merged

Review server upgrade and password provider pages #576

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d4ced5e
Remove upgrade note from the server upgrade page
sbesson Dec 5, 2013
257f7a9
Differentiate DB upgrade step between 4.4.x and 5.0.0-beta1 servers
sbesson Dec 5, 2013
4816906
Add section about JCM memory settings
sbesson Dec 5, 2013
d5dd9f2
Remove temporary server-migration-fs page
sbesson Dec 5, 2013
d95e99b
Add documentation for password provider changes to support salting
sbesson Dec 6, 2013
640a4c3
Fix the DB upgrade command for 5.0.0-beta1
sbesson Dec 6, 2013
6e81cfa
Rewrite optimization lines to include quotes as tested in the job
sbesson Dec 6, 2013
b56f7ec
Try to improve the sentence about reverting salting
sbesson Dec 6, 2013
11bf288
Minor fixes to the server upgrade page
sbesson Dec 9, 2013
bbc0502
Fix dot in password provider page
sbesson Dec 9, 2013
e3c90b1
Remove duplicated links from the sysadmin index page
sbesson Dec 9, 2013
4ace45e
Merge remote-tracking branch 'origin/develop' into 11787_server_upgrade
sbesson Dec 11, 2013
fe4df44
Add note to What's new page about password salting
sbesson Dec 11, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion omero/developers/Server/PasswordProvider.txt
View file
Open in desktop
Expand Up @@ -8,7 +8,7 @@ Several implementations exist currently:

- :source:`ome.security.auth.JdbcPasswordProvider <components/server/src/ome/security/auth/JdbcPasswordProvider.java>`
is the most common provider, and uses the "password" table for
storing MD5 encrypted passwords per user.
storing passwords hashed using MD5 and salt per user.
- :source:`ome.security.auth.FilePasswordProvider <components/server/src/ome/security/auth/FilePasswordProvider.java>`
is rarely used, but in some scenarios may be useful since it permits
setting usernames and passwords in a plain text file.
Expand Down
1 change: 0 additions & 1 deletion omero/sysadmins/index.txt
View file
Open in desktop
Expand Up @@ -79,7 +79,6 @@ Server Maintenance
server-backup-and-restore
server-upgrade
UpgradeCheck
server-migration-fs
command-line-interface


Expand Down
9 changes: 9 additions & 0 deletions omero/sysadmins/server-ldap.txt
View file
Open in desktop
Expand Up @@ -270,6 +270,15 @@ command:
When the LDAP password provider implementation changes, previous versions can
be configured as necessary.

chainedPasswordProviderNoSalt
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``chainedPasswordProviderNoSalt`` uses the version of the JDBC password
provider without password salting support as available in the OMERO 4.4.x
series. To enable it, use::

bin/omero config set omero.security.password_provider chainedPasswordProviderNoSalt

chainedPasswordProvider431
^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
13 changes: 0 additions & 13 deletions omero/sysadmins/server-migration-fs.txt
View file
Open in desktop

This file was deleted.

59 changes: 49 additions & 10 deletions omero/sysadmins/server-upgrade.txt
View file
Open in desktop
Expand Up @@ -19,9 +19,6 @@ to disable this functionality you should do so now as outlined on the
suitable version of PostgreSQL to enable successful upgrading of
the database.

**Also be aware that at present there is no way of directly upgrading
OMERO.server from the 4.x line to the OMERO.fs (5.x) version.**

If you encounter errors during a OMERO upgrade, database upgrade, etc.
you should retain as much log information as possible and notify the
OMERO.server team via the mailing lists available on the
Expand All @@ -37,6 +34,16 @@ below. Please refer to each section for additional details.
:local:
:depth: 1

.. warning::
with 5.0.0-beta2, the default JDBC password provider has been modified to
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sentence could start with a capital letter?

add password salting support. This implies that once a server has been
upgraded and deployed, passwords will be modified, you will not be able
to easily revert to the configuration without salting. To keep using the
legacy password provider without salting support, you will need to
configure ``omero.security.password_provider`` to use the legacy
``chainedPasswordProviderNoSalt`` as described in the
:ref:`legacy_password_providers` section.

.. warning:: The passwords and logins used here are examples. Please consult
the :ref:`troubleshooting-password` section for explanation. In particular,
make sure to replace the values of **db_user** and **omero_database**
Expand Down Expand Up @@ -92,16 +99,41 @@ Run the upgrade script
^^^^^^^^^^^^^^^^^^^^^^

You **must** use the same username and password you have defined during
:doc:`unix/server-installation`. The |version| upgrade script should execute in a short time.
:doc:`unix/server-installation`. The |version| upgrade script should execute
in a short time.

From a |previousversion|.x server
"""""""""""""""""""""""""""""""""

.. parsed-literal::

$ cd |OMEROserverzip|
$ psql -h localhost -U **db_user** **omero_database** < sql/psql/OMERO\ |version|\_\_0/OMERO |previousversion|\_\_0.sql
$ psql -h localhost -U **db_user** **omero_database** < sql/psql/OMERO\ |version|\_\_0/OMERO\ |previousversion|\_\_0.sql
Password for user **db_user**:
...
...
status
status
---------------------------------------------------------------------
+
+
+
YOU HAVE SUCCESSFULLY UPGRADED YOUR DATABASE TO VERSION OMERO |version|\_\_0+
+
+

(1 row)

From a 5.0.0-beta1 server
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two spaces

""""""""""""""""""""""""""

.. parsed-literal::

$ cd |OMEROserverzip|
$ psql -h localhost -U **db_user** **omero_database** < sql/psql/OMERO\ |version|\_\_0/OMERO\ |version|\DEV\_\_6.sql
Password for user **db_user**:
...
...
status
---------------------------------------------------------------------
+
+
Expand All @@ -120,8 +152,8 @@ database which can both save disk space and speed up access times.

.. parsed-literal::

$ psql -h localhost -U **db_user** **omero_database** -c "REINDEX DATABASE **omero_database** FORCE;"
$ psql -h localhost -U **db_user** **omero_database** -c "VACUUM FULL VERBOSE ANALYZE;"
$ psql -h localhost -U **db_user** **omero_database** -c 'REINDEX DATABASE "**omero_database**" FORCE;'
$ psql -h localhost -U **db_user** **omero_database** -c 'VACUUM FULL VERBOSE ANALYZE;'

.. _upgrademergescript:

Expand All @@ -140,8 +172,8 @@ For further information on managing your scripts, refer to
:doc:`installing-scripts`. If you require help, please contact the OME
developers.

Update your environment variables
---------------------------------
Update your configuration
-------------------------

Environment variables
^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -151,6 +183,13 @@ make sure to update any system environment variables. Before restarting
the server, make sure your PATH and PYTHONPATH system environment
variables are pointing to the new locations.

JVM memory settings
^^^^^^^^^^^^^^^^^^^

If you modified your memory settings, you will need to remodify these settings
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remodify seems a bit odd. update maybe?

for the new server. Refer to the `JVM memory settings` sub-section of the :doc:`installation <unix/server-installation>` section
(:doc:`Windows <windows/server-installation>`) for more information.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe put both hyperlinks inside the parenthesis as (Unix or Windows)?


Changes to OMERO.web URLs
^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
4 changes: 2 additions & 2 deletions omero/sysadmins/whatsnew.txt
View file
Open in desktop
@@ -1,8 +1,8 @@
What's new for OMERO 5
======================

- :doc:`server-migration-fs` has been added and :doc:`server-upgrade` updated
to clarify the position on upgrading from 4.4 to OMERO 5.
- :doc:`server-upgrade` has been updated to explain the server upgrade
process from 4.4 to OMERO 5.

- :doc:`fs-upload-configuration` has been added to explain the server-side FS
workflow for importing files.
Expand Down