12311 auto memory docs #819
Conversation
Now that the default memory configuration need not be modified by default, it's less critical that the info be embedded in the main installation page. Also, this text will need to grow substantially in order to make the usage clear, and repeating that between unix and windows seems error prone.
| ^^^^^^^^^^^ | ||
|
|
||
| A number of configuration properties starting with ``omero.mem`` | ||
| control how OMERO calculate how much memory to allocate to each |
|
All noted and appreciated. I'll correct tomorrow morning. There's a lot more verbiage needed, though. So if you and/or other people who shall remain nameless want to hold off on the review, I'll do multiple readings myself before signing off. |
|
Talked with @joshmoore. Excluding to let #826 in. |
|
The docs mention blitz, indexer, pixeldata, but the generated config also has repository. Worth a mention even if it's of lesser importance? The installation docs now just say "To increase the performance of your system, you may want to tune the JVM". Is it worth emphasizing this a bit more? |
|
All noted. Once the code PR is finalized, I'll update this with the suggestions. |
|
Now #826 has been merged, this will need |
|
Conflicting PR. Removed from build OMERO-5.0-merge-docs#731. See the console output for more details. |
|
Excluded until the code PR is merged. |
Conflicts: omero/sysadmins/server-advanced-configuration.txt
|
|
|
That's all I notice on a brief read-through anyway. (-: |
|
I think it might be easier to do the re-organisation on another PR - I would like to spend a bit of time planning out new section divisions for the sysadmin docs this week. Given that, it may be better to leave the cross-links until then. Don't know if you want to add a table on this PR or later @joshmoore ? |
| Configuration properties can either be applied to all three service | ||
| types at the same time by omitting the service type (e.g. | ||
| :term:`omero.mem.strategy`) or to each individually by including it | ||
| (e.g. `omero.mem.blitz.strategy`). |
There was a problem hiding this comment.
No idea how messy this would look but Sphinx allows to define multiple terms in glossary e.g.
.. glossary::
omero.mem.strategy
omero.mem.blitz.strategy
omero.mem.indexer.strategy
omero.mem.pixeldata.strategy
Selects which memory strategy to use.
|
#844 is merged now @joshmoore so you can merge dev_5_0 into this and continue working - just put the new subdivided configuration pages in the 'Optimizing Server Configuration' section with nice clear explanatory titles. |
|
My tendency would be to merge this as close to it as and then handle restructuring with search, etc. |
|
Sorry, I'm not clear - do you want me to merge this now as is? Or are you doing some more work on it first? |
|
|
||
| :: | ||
|
|
||
| $ bin/omero config set omero.mem.strategy adaptive |
|
In general, this looks OK. Still some minor details to iron out. Once this is fully in-line with what the code does, this is good to merge. |
| http://www.openmicroscopy.org/community/viewtopic.php?f=4&t=7400 | ||
| Forum thread on PixelData JVM memory settings | ||
|
|
||
| :ref:`gridconfiguration` |
There was a problem hiding this comment.
Having a highlighted box with See also referring to the section immediately below looks a bit strange. Not a blocker for merging.
There was a problem hiding this comment.
Let's see if that goes away in the re-working.
|
Another round of fixes pushed. |
|
👍 |
|
--rebased-to #869 |
Documentation PR for ome/openmicroscopy#2595
This PR should initially be used for a clarification of the code in 2595, but should remain open for the likely numerous adjustments which will be necessary in the code. Built documentation should be visible under:
Both the sections:
have been updated to point to adv. configuration.