Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 279 lines (228 sloc) 11.307 kb
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
1 ==================================================
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
2 Ocean Observatories Initiative Cyberinfrastructure
aabfe74 @mmeisinger Included magnet modules into ion.core packages and removed dependency on...
mmeisinger authored
3 Integrated Observatory Network (ION)
4 ioncore-python - Capability Container and Core Modules
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
5 ==================================================
db03ff6 @mmeisinger Bootstrap class and core service structure
mmeisinger authored
6
aabfe74 @mmeisinger Included magnet modules into ion.core packages and removed dependency on...
mmeisinger authored
7 April 2010 - September 2010 (C) UCSD Regents
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
8
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
9 This project provides a service framework with auxilliary functions for running
ea45e76 @mmeisinger removed rm_pyc.sh in favor of ant target; updated README with dependenci...
mmeisinger authored
10 architecturally complete versions of all the services of the OOI release 1
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
11 system with their full architectural dependencies in Python.
12 Functionally it provides a data distribution network based on pub-sub messaging
13 as well as instrument integration, with underlying infrastructure services
14 (security, persistence) and provisioning.
b2b045b @mmeisinger README updated with dependencies
mmeisinger authored
15
16 The "core" part of LCAarch provides base classes and a framework for spawnable,
17 message communicating processes, for services with defined names, for
ea45e76 @mmeisinger removed rm_pyc.sh in favor of ant target; updated README with dependenci...
mmeisinger authored
18 bootstrapping the system, for managing logging and configuration etc. This
19 is an early implementation of the OOI Python Capability Container.
b2b045b @mmeisinger README updated with dependencies
mmeisinger authored
20
ad37c05 @mmeisinger PEP8 compliance
mmeisinger authored
21 For more information, please see:
fa52725 @mmeisinger Added Python version check
mmeisinger authored
22 http://www.oceanobservatories.org/spaces/display/syseng/CIAD+COI+SV+Python+Capability+Container
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
23
b2b045b @mmeisinger README updated with dependencies
mmeisinger authored
24 Get LCAarch with
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
25 ::
26 git clone git@amoeba.ucsd.edu:lcaarch.git
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
27 cd lcaarch
28
29
30 Dependencies
31 ============
32
33 LCAarch is compatible with Python 2.5 and higher, but not Python 3.x
34 This project has several dependencies on libraries and packages. Most of these
35 dependencies are resolved automatically using the provided setup script.
36
37 Step 1: Virtual env
38 Create a Python virtual environment using virtualenv. This ensures that all
39 libraries and dependencies are installed separately from the Python
40 system libraries.
41 ::
42 mkvirtualenv lcaarch
43 workon lcaarch
44
45 Step 2: Core libraries (you can skip this step)
46 Install some core libraries first. Sometimes the automatic installer
47 produces errors, if these libraries are not present beforehand.
48 ::
49 easy_install twisted numpy
50
51 Step 3: Run the setup script
52 ::
fa52725 @mmeisinger Added Python version check
mmeisinger authored
53 ant install # This is equivalent to python setup.py install
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
54
55 This should download and install all the dependencies and will run for a while.
56 Check the trace output that there are no substantial errors. You are now ready
57 to run.
58
59 Current dependencies include:
aabfe74 @mmeisinger Included magnet modules into ion.core packages and removed dependency on...
mmeisinger authored
60 twisted, carrot, numpy, txamqp, msgpack-python, httplib2, pycassa, simplejson,
d6bfb7e Added dependency for gviz_api
David Stuebe authored
61 pydap, pydap.handlers.netcdf, pydap.responses.netcdf, pydap.handlers.nca,
3928f4b @timf Adding dependencies to lcaarch/ion: nimboss, txrabbitmq (both are packag...
timf authored
62 gviz_api.py, nimboss, txrabbitmq
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
63
64 NOTE: As the project evolves and new code is added, dependencies might change.
65 Run the setup script once in a while and when you get errors
66
4715758 @mmeisinger removed test from boostrap, changed datastore for new msg format
mmeisinger authored
67
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
68 Usage
69 =====
4715758 @mmeisinger removed test from boostrap, changed datastore for new msg format
mmeisinger authored
70
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
71 (all subsequent steps assume you are in the lcaarch/ root dir)
d9eb8b7 @mmeisinger package init, ts test
mmeisinger authored
72
aabfe74 @mmeisinger Included magnet modules into ion.core packages and removed dependency on...
mmeisinger authored
73 Start empty Python Capability Container shell with:
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
74 ::
fa52725 @mmeisinger Added Python version check
mmeisinger authored
75 bin/start-cc -h amoeba.ucsd.edu
76 bin/start-cc # to run with localhost
3a84fde @mmeisinger Bootstrap improvements, procutils, datastore test
mmeisinger authored
77
aabfe74 @mmeisinger Included magnet modules into ion.core packages and removed dependency on...
mmeisinger authored
78 (to end a capability container shell, press Ctrl-D Ctrl-C)
e710e44 @mmeisinger CC agent with announcement on identification request; can spawn a proces...
mmeisinger authored
79
3a84fde @mmeisinger Bootstrap improvements, procutils, datastore test
mmeisinger authored
80 Start system by executing within the CC shell:
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
81 ><>
82 from ion.core import bootstrap
83 bootstrap.start()
84
84c4757 @mmeisinger Added simple mock Java integration service for LCA and ant target to sta...
mmeisinger authored
85 Alternatively (better) from UNIX shell executing a script:
d9eb8b7 @mmeisinger package init, ts test
mmeisinger authored
86 ::
fa52725 @mmeisinger Added Python version check
mmeisinger authored
87 bin/start-cc -h amoeba.ucsd.edu res/scripts/bootstrap.py
88 bin/start-cc -h amoeba.ucsd.edu res/scripts/newcc.py
89 bin/start-cc -h amoeba.ucsd.edu -a nproducers=25 res/scripts/pubsub.py
dcae3c7 Fixed order of consumer names in pubsub script
David Stuebe authored
90
d9eb8b7 @mmeisinger package init, ts test
mmeisinger authored
91
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
92 Testing
93 =======
94
b78736b @mmeisinger changed readme; make sure to update and install latest magnet
mmeisinger authored
95 Run trial test cases (recursively)
d9eb8b7 @mmeisinger package init, ts test
mmeisinger authored
96 ::
e710e44 @mmeisinger CC agent with announcement on identification request; can spawn a proces...
mmeisinger authored
97 trial ion
b78736b @mmeisinger changed readme; make sure to update and install latest magnet
mmeisinger authored
98 trial ion.core
99 trial ion.services.coi.test.test_resource_registry
d9eb8b7 @mmeisinger package init, ts test
mmeisinger authored
100
cad868a @mmeisinger Updated README to correct magnet dependency: now master
mmeisinger authored
101 A good learning example is the HelloService
102 ::
103 trial ion.play.test.test_hello
104
105 Or in the CC shell:
106 ><>
107 from ion.play import hello_service
108 spawn(hello_service)
109 send(1, {'op':'hello','content':'Hello you there!'})
110
111 from ion.play.hello_service import HelloServiceClient
342829f @mmeisinger Local configuration override in ionlocal.config. Unit tests get broker h...
mmeisinger authored
112 hc = HelloServiceClient()
cad868a @mmeisinger Updated README to correct magnet dependency: now master
mmeisinger authored
113 hc.hello()
114
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
115
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
116 Build and Packaging using Ant
117 =============================
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
118
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
119 LCAarch provides ANT support (see http://ant.apache.org/).
120 To check that ant is installed properly, run
121 :: ant
ab3d9bb @mmeisinger base service and process, service startup
mmeisinger authored
122
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
123 To clean your working directories, run
124 :: ant clean
7d23793 @mmeisinger Added ant build file; supports clean and start of CC
mmeisinger authored
125
fa52725 @mmeisinger Added Python version check
mmeisinger authored
126 To install all Python dependencies, run
127 :: ant install
128
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
129 To compile all code to see if there are Python compile errors anywhere:
130 :: ant compile
c43dc6c @mmeisinger Readme appended with last changes, OTP functions in base_process
mmeisinger authored
131
132
133 ---------------------------------------------------------------------------
134 Change log:
135 ===========
136
41492d8 @mmeisinger Receiver refactoring; removed/modified Receiver imports
mmeisinger authored
137 2010-10-04:
138 - MASSIVE REFACTORING IN BASE CLASSES
ccdf027 @mmeisinger Fixed one more test
mmeisinger authored
139 - Refactored the former magnet code into more object oriented style.
140 - Requires Carrot 0.10.10. Carrot before does not handle all deferred
141 operations correctly.
142 - Refactored the Receiver use. There are now subclasses for Receivers that
143 manage and declare the specific types of AMQP resources, such as worker and
144 fanout. No more declare_messaging necessary.
145 - Refactoried the capability container classes.
41492d8 @mmeisinger Receiver refactoring; removed/modified Receiver imports
mmeisinger authored
146 - Added a FSM based StateObject. Many manager/controller level objects now make
147 use of states. States and operations INIT -> initialize() -> READY ->
148 activate() -> READY -> terminate() -> TERMINATED
149 - BaseProcess (and subclasses), Receiver, ProcessDesc, Container etc are all
150 BasicLifecyleObjects.
151 - Massively enhanced the capability container API. Delegated the actual
152 implementation to manager classes: proc, exchange, app manager
153 - Refactored the way processes are spawned
154 - Message headers now contain status code for every message. 'OK is the default
155 and 'ERROR' is set on error
d70646e @mmeisinger Refactored RPC error reply into ReceivedError; fixed code and tests
mmeisinger authored
156 - BaseProcess.rpc_send now raises a ReceivedError in case the RPC comes back
157 with status='ERROR'
41492d8 @mmeisinger Receiver refactoring; removed/modified Receiver imports
mmeisinger authored
158 - Changed reply_ok and reply_err: a dict content value will not be modified
159 - Fixed imports and tests throughout the code base
ccdf027 @mmeisinger Fixed one more test
mmeisinger authored
160 - Added OTP style apps and app files as primary way to start up processes
161 in the container. See res/apps/*.app files and ion.core.pack
41492d8 @mmeisinger Receiver refactoring; removed/modified Receiver imports
mmeisinger authored
162
aabfe74 @mmeisinger Included magnet modules into ion.core packages and removed dependency on...
mmeisinger authored
163 2010-09-20:
fa52725 @mmeisinger Added Python version check
mmeisinger authored
164 - Added start scripts in bin/
2ce7fde @mmeisinger Updated README
mmeisinger authored
165 - Use ant install to install Python dependencies (calls python setup.py install)
aabfe74 @mmeisinger Included magnet modules into ion.core packages and removed dependency on...
mmeisinger authored
166 - Removed dependency on magnet. Included all relevant magnet code in ion.core
167 packages cc and messaging.
168 Start with: twistd -n cc
169 - Included all CEI services and base classes in code base
170
4a5d195 @mmeisinger Initial container class
mmeisinger authored
171 2010-08-29:
172 - Changed all logging instances for loggers to log, to avoid name clashes.
173
ba80634 @mmeisinger BaseProcess refactoring; added second receiver for backend interactions;...
mmeisinger authored
174 2010-08-14:
175 - BaseProcess: added backend receiver, used for sending out any messages
176 from self.send and self.rpc_send. This keeps the message queue for the process
177 frontend separate from the process backend, e.g. for RPC during a message
178 processing.
179 - Changed BaseProcess logging to make message send and receive easier to spot.
180
911af58 @mmeisinger Fixed BaseProcess: states, message dispatching, error handling
mmeisinger authored
181 2010-08-06:
182 - BaseProcess.spawn() now calls init() automatically. No need to call init()
183 on a process anymore manually. For testing only. Note: The correct way to
184 spawn a process is through a parent process with spawn_child()
185 - Modified and fixed the BaseProcess states, when receiving messages
186 - MAJOR update to BaseProcess message dispatching and subsequent error handling.
187 On error, reply_err messages are sent back, if reply-to header set.
188
7d23793 @mmeisinger Added ant build file; supports clean and start of CC
mmeisinger authored
189 2010-08-03:
190 - Added ant build.xml file to LCAarch root dir. Start with ant.
191 Supports ant clean, which removes all *.pyc from ion path.
192
b93d956 Fixing trial errors and adding comments
David Stuebe authored
193 2010-07-23:
194 - Refactored the Registry Services to inherit from a common base class. This
195 will allow easier implementation of the many registries in the OOICI. The
196 Resource Registry and Service Registry now have basic registration of resource
197 descriptions and services.
198 - The Ion message is now encoded usig the MsgPack library to allow for binary
199 transport of message content. The JSON library was mangleing string content.
200 This is a temporary fix for a wider problem with the encoding structure which
201 needs to be addressed in construction.
202
dfe8bf2 @mmeisinger fixed problems with logging change; added log level configuration based ...
mmeisinger authored
203 2010-06-07:
204 - Redefined logging import to set as module level logger. Each module has now
205 a different logger that can be configured separately. Don't configure
206 manually though.
207 - Added possibility to modify logging levels by module/package, with support
208 for package hierarchy. See res/logging/loglevels.cfg for standard entries.
209 Do not modify. Add file res/logging/loglevelslocal.cfg for local override.
08d0190 @mmeisinger fixed some errors related to logging changes
mmeisinger authored
210 Default logging level for all ion code: WARNING
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
211
f92eeba @mmeisinger Added process shutdown support to BaseProcess; refactored BaseProcess me...
mmeisinger authored
212 2010-06-02:
213 - BaseProcess self members renamed to conform to PEP8
214 - Added process shutdown to BaseProcess
982030b @mmeisinger Refactoring in BaseProcess to support an onspawn hook
mmeisinger authored
215 - Added container UNIX shell argument -a processes=<path to filename> used
216 by newcc.py script, with a list of processes to startup in standard format
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
217
3f881c9 @mmeisinger Changed IStore delete to remove; parameterizable cassandra backend
mmeisinger authored
218 2010-05-25:
219 - Made Cassandra backend parameterizable with keyspace/colfamily and added
220 SuperColumn support.
f2ff6a5 @mmeisinger Refactored IStore interface and modified backends, object store, coi dat...
mmeisinger authored
221 - Modified the IStore interface to support a create_store factory method. This
222 method can yield and return a deferred. Modified and fixed IStore impls.
3f881c9 @mmeisinger Changed IStore delete to remove; parameterizable cassandra backend
mmeisinger authored
223 Changed delete to remove to be more compliant with standard collections.
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
224
241d1d0 @mmeisinger BaseProcess.reply_ok and reply_err added and service operations changed;...
mmeisinger authored
225 2010-05-22:
226 - Added timeout to BaseProcess.rpc_send. Use with kwarg timeout=<secs>
227 - CC-Agent detects missing known containers and removes them from the list
228 - Enhanced CC-Agent operations and CC shell helpers
229 - Added sequence numbers for messages
230 - Added glue functions BaseProcess.reply_ok and reply_err and changes some
231 RPC style service operations.
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
232
342829f @mmeisinger Local configuration override in ionlocal.config. Unit tests get broker h...
mmeisinger authored
233 2010-05-20:
234 - The system now looks for a local config file ionlocal.config and if exists,
235 overrides entries in ion.config.
236 - Test cases use the config file to determine the broker host to use. If local
70573b4 @mmeisinger added BaseProcessClient and changed all BaseServiceClient subclasses and...
mmeisinger authored
237 config override exists, a different broker (e.g. localhost) can be given.
238 - Added BaseProcessClient and changed BaseServiceClient and all clients and
239 all test cases (again).
3827a32 @mmeisinger shell helper functions
mmeisinger authored
240 - Added container shell helpers under 'cc', such as cc.spawn('hello')
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
241
e710e44 @mmeisinger CC agent with announcement on identification request; can spawn a proces...
mmeisinger authored
242 2010-05-16:
243 - Removed support for BaseProcess.send_message and reply_message. Always use
244 send, reply and rpc_send now.
245 - Any BaseProcess instance can now spawn_child() other processes.
246 - Removed RpcClient class, because every process can do rpc_send()
247 - Service processes now also listen to their service name's queue. The service
248 name is determined from the service declaration. Two processes will listen
249 to the same queue and take messages round robin from the queue.
250 - Startup arguments evaluated, for instance to start with system name set:
251 twistd -n magnet -a sysname=mysys
252 twistd -n magnet -a "{'sysname':'mysys'}"
253 - Added capability container agent process. Start with:
254 twistd -n magnet res/scripts/newcc.py
255 Agents announce themselves to others in the same system and can spawn procs.
256 - Name scope 'local' for messaging names means now really local to one container.
257 Use scope 'system' for names unique for each bootstrapped system. Do not use
258 global names, because they will clash.
259 - Less verbose trace output for process init messages and changes to other
260 trace output as well.
bc50a38 @mmeisinger Changed BaseServiceClient __init__ args and all client impls; takes now ...
mmeisinger authored
261 - Changed BaseServiceClient and tests. Initializer arguments different.
cad868a @mmeisinger Updated README to correct magnet dependency: now master
mmeisinger authored
262 - Using master branch of magnet now
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
263
7a9f54a @mmeisinger python 2.5 compatibility: changed .format to % and json import
mmeisinger authored
264 2010-05-10:
265 - Based on entries in config files, service process modules are sought and
266 loaded in order to collect the service process declarations. This enables
267 a registration of services with versions and dependencies on startup
07a06bb @mmeisinger Revised README file to reflect automatic setup and ant build
mmeisinger authored
268
c43dc6c @mmeisinger Readme appended with last changes, OTP functions in base_process
mmeisinger authored
269 2010-05-06:
270 - Refactored the BaseProcess class.
271 - You can now do RPC directly from the process, via self.rpc_send without
5ea10a7 @mmeisinger made IonTestCase and all tests PEP8 compliant
mmeisinger authored
272 the need for an RpcClient. Works even with other messages coming in at the
273 same time (using the conv-id)
c43dc6c @mmeisinger Readme appended with last changes, OTP functions in base_process
mmeisinger authored
274 - Added aliases: self.send, self.reply (use these now)
275 - Process instance can be spawned via self.spawn()
276 - Provided an easier to use BaseServiceClient, which uses a default service
277 name lookup. Accepts BaseProcess instance as argument to use for sending/
278 receiving service calls.
Something went wrong with that request. Please try again.