releases/Anacortes-final: Anacortes 1.2 RELEASE NOTES

File Anacortes 1.2 RELEASE NOTES, 6.3 kB (added by ibaldin, 9 years ago)
Line 
1Orca 1.2 Release Notes
2
3This is mostly a maintenance and bug-fix release. We strived to make changes
4that would not affect published interfaces and core classes. Some more
5significant interface changes (aimed to simplify substrate integration, usage,
6and robustness) are on their way for the upcoming 2.0 release.
7
8The major user-visible changes in the 1.2 release are:
9
101. Modified configuration process
11
12This release introduces the option to separate the core Orca configuration files from the
13Orca web application, so that configuration files are not overwritten after
14redeploying the application. Configuration files reside under ORCA_HOME.
15
16Orca resolves configuration files relative to the ORCA_HOME directory. ORCA_HOME
17can be defined in several ways. The order of resolution is:
18
19 1. The value of the containing JVM's system property called ORCA_HOME.
20 2. The value of the environment variable ORCA_HOME.
21 3. The web application's root directory (when running inside an application server).
22 4. The JVM's working directory (e.g., when invoked from the command line).
23
24At present ORCA_HOME contains two directories:
25 - config
26
27 This is the main configuration directory. Corresponds the the local/ directory
28 in previous Orca releases
29
30 - runtime
31
32 This is the directory that stores actor keystores and axis2 configuration
33 files.
34
35The various Orca configuration files that used to reside under local/ have
36either been merged into ORCA_HOME/config/container.properties or have been
37relocated. container.properties is meant to become the primary configuration
38file, although some configuration is still present in other parts of the
39installation. Future releases are going to complete this transition.
40
41In addition to changing configuration.properties, we also modified the
42actor XML file. The XML file now contains only information needed to automate
43the installation of Orca actors and to define their topology. What used to be
44the global section (the portion enclosed in <global></global>), is no longer
45required to be present in the XML file, and it would be ignored if present.
46Since the global section contained important container-level information, this
47information is now part of the container.properties file.
48
49For more information about the Orca configuration files in the 1.2 release use
50the following documents:
51
52https://geni-orca.renci.org/orca-doc/current/guides/container-configuration/config-files.html
53https://geni-orca.renci.org/orca-doc/current/guides/container-configuration/properties.html
54https://geni-orca.renci.org/orca-doc/current/guides/container-configuration/xml.html
55
56
572. Standard usage of log4j.
58
59Starting from this release orca.util.LoggingTool no longer exists. Instead, all
60logging should be done through an instance of org.apache.log4j.Logger. The log4j
61settings used by Orca are stored in container.properties.
62
63Orca-based code has two options to log a message:
64
65  1. Use orca.shirako.container.Globals.Log
66 
67  All messages logged using this approach would come from a logger called "orca"
68 
69  2. Make your own logger by calling  orca.shirako.container.Globals.getLogger(string)
70
71  All messages logged using this approach would come from a logger called "orca.string"
72
73Simply replacing all instances of orca.util.LoggingTool with an instance of
74orca.apache.log4j.Logger should be sufficient to port your code. However, the
75old logger offered an exception(string, e) method, which would have to be
76converted to error(string, e).
77
78Orca now configures log4j early in the boot process, so it should have
79predictable log names. The default log file is WORKING_DIRECTORY/logs/orca.log.
80
813. Consolidated the Container manager hierarchy.
82
83The ContainerManager class is gone and it has been replaced by
84orca.shirako.container.Globals and orca.shirako.container.OrcaContainer.
85
86The Globals class manages the bootstrap of the Orca container. It attempts to
87load container.properties, initializes the logging facility, and attempts to
88instantiate the container implementation (OrcaContainer). To get a reference to
89the orca container use Globals.getContainer(). Globals now also stores the
90container configuration, which you can obtain using Globals.getConfiguration().
91
92OrcaContainer now contains all code that used to be split between multiple
93container implementation classes. Our goal is to keep this class as the single
94container implementation. OrcaContainer is responsible for bootstrapping the
95container and for providing access to core subsystems, e.g., package manager,
96portal plugin manager, management objects manager, etc. The interfaces exposed
97by this class are likely to experience some transformations in future releases.
98
99If you had code that looked like this:
100
101((Manager)ContainerManager.getInstance()).getContainerManagerObject()
102
103it should be converted to read:
104
105Globals.getContainer().getContainerManagerObject();
106
1074. Recovery is triggered automatically on boot
108
109If your container is recovery from a crash or after a stop, it would now attempt
110to recover automatically, without requiring an explicit call to trigger
111recovery.
112
1135. Experimental support for Node Agent DEB and RPM packages.
114
115In an attempt to simplify Node Agent installation and upgrade, we have started
116work on providing DEB and RPM packages. These packages are at an early stage of
117their development and should be considered experimental. Our web site is going
118to provide more information about how to build and use the packages.
119
1206. Experimental support for an Orca DEB package.
121
122We have an early prototype of a DEB package that install the Orca web
123application and all of its dependencies. This is our initial attempt to automate
124the Orca installation, by packaging a stripped down-version of tomcat. The
125current version does not allow some of the default settings to be changed, e.g.,
126database configuration, but we are making progress to simplify this process.
127
128The Orca web site is going to contain information about building and using the
129Orca DEB package.
130
1317. Bug fixes
132
133We fixed a number of bugs and, unfortunately, may have introduced new ones.
134Please let us know when you encounter a problem.
135
1368. Documentation and website improvements
137
138We are investing a lot of time in documenting Orca to make it easier to use and
139understand. The Orca web side contains some important guides to get you started
140on installing and using Orca. More guides and documents are in the works and
141will be posted soon.
142
143https://geni-orca.renci.org/orca-doc
144