Project

General

Profile

Feature #2297

document new directory/P2J configurations and setup

Added by Constantin Asofiei about 12 years ago. Updated over 1 year ago.

Status:
Closed
Priority:
Normal
Assignee:
Constantin Asofiei
Target version:
-
Start date:
Due date:
% Done:

100%

billable:
No
vendor_id:
GCD
case_num:
version_reported:
version_resolved:
reviewer:
production:
No
env_name:
topics:

ca_upd20140509a.zip (53.6 KB) Constantin Asofiei, 05/09/2014 01:27 PM

changed_chapters_20140509a.zip (881 KB) Constantin Asofiei, 05/09/2014 01:27 PM

new_chapters_20140509a.zip (296 KB) Constantin Asofiei, 05/09/2014 01:27 PM

doc_updates_20140511a.zip (420 KB) Constantin Asofiei, 05/11/2014 01:13 PM

ca_upd20140513c.zip (60.1 KB) Constantin Asofiei, 05/13/2014 12:52 PM

History

#1 Updated by Constantin Asofiei about 12 years ago

In the attached documents, all the changes are in the Runtime Installation, Configuration and Administration Guide book. To summarize, this includes:
  • details about how to setup and access the spawner, web clients, batch processes.
  • new chapter with the P2J's built-in cryptography tool
  • new chapter with the scheduler configuration
  • misc changes related to new dependencies related to P2J build, client/server install, etc

I left behind some TODOs/questions. A part I'm not confortable with is that we are duplicating the list of 3rd-party jars in multiple chapters... IMO there should be only one chapter which documents all the 3rd-party libraries (grouped by modules: hibernate, stax, TitanDB, etc), and the goal of each library: runtime, conversion, etc.

Also, I've attached an update with some misc P2J fixes/improvements (my way of documenting fix is always confirm an idea/scenario with how the actual source code works...). If the changes look OK, I will release it (as no testing is required).

Please review. My next steps are:
  1. describe the ant tasks in the build_p2j.odt chapter
  2. document the mandatory ACLs/exports needed to run the server or by the new functionalities (i.e. spawner, etc).

#2 Updated by Constantin Asofiei about 12 years ago

Attached changes are on top of the files on note 1 and documents ACLs and describe the build.xml ant tasks.

#3 Updated by Greg Shah about 12 years ago

Code Review 0509a

I am fine with all the changes.

Please also do the following: remove the GNU Affero Public License text from all files in com/goldencode/compile/ and from com/goldencode/util/LogHelper.java. Those files originally came from the harness project and we never should have checked them in with the GPL text included.

You can check in and distribute the code.

#4 Updated by Greg Shah about 12 years ago

Please do the following:

1. I agree with your point: A part I'm not confortable with is that we are duplicating the list of 3rd-party jars in multiple chapters... IMO there should be only one chapter which documents all the 3rd-party libraries (grouped by modules: hibernate, stax, TitanDB, etc), and the goal of each library: runtime, conversion, etc.. Please do make a single reference for this. Perhaps it should be its own chapter.

2. Add the new chapters to the master document.

3. Check it all in.

I will do further review directly in bzr so that I can edit in place for typos and such.

#5 Updated by Constantin Asofiei about 12 years ago

Greg Shah wrote:

Code Review 0509a
...

Attached version was committed to bzr rev 10531.

#6 Updated by Constantin Asofiei about 12 years ago

Greg Shah wrote:

Please do the following:

All the chapters are in bzr.

#7 Updated by Greg Shah about 12 years ago

I am working my way through the changes. In the build_p2j chapter, I am reworking the content to be more understandable. This has nothing to do with your edits, it just has been a mess for a while.

The dependencies section there is completely out of date. Did you update the dependencies section in any chapter? I plan to move this into a single Software Dependencies chapter. I prefer not to have to rebuild this myself if you have already done it.

#8 Updated by Greg Shah about 12 years ago

Nevermind, I found the chapter. But it does seem quite out of date. I'm working on it.

#9 Updated by Greg Shah about 12 years ago

I don't see any references to libjvm in the build_p2j.odt. I have modified that chapter (and my changes are not done). Can you please provide the suitable content that I can add?

#10 Updated by Constantin Asofiei about 12 years ago

Greg Shah wrote:

I don't see any references to libjvm in the build_p2j.odt. I have modified that chapter (and my changes are not done). Can you please provide the suitable content that I can add?

In the latest bzr version of this file, there is this note in the Java Development Kit (JDK) section:

For the native code to compile, ensure the libvjm.so file (on Linux) and the jvm.lib file (on Windows) are accessible via the user's PATH.  This results in either creating a /usr/lib/libjvm.so symlink to the actual file (on Linux/UNIX) or adding the parent folder of this file to the user's PATH (on both Linux and Windows).

#11 Updated by Greg Shah about 12 years ago

I see it now.

#12 Updated by Greg Shah over 1 year ago

  • Status changed from WIP to Closed
  • % Done changed from 0 to 100

Also available in: Atom PDF