Difference between revisions of "Distributions"

From Krupczak.org
Jump to: navigation, search
(Cartographer Distributions and Source Code)
(Cartographer Distributions and Source Code)
 
(130 intermediate revisions by one user not shown)
Line 1: Line 1:
 
== Cartographer Distributions and Source Code ==
 
== Cartographer Distributions and Source Code ==
  
Some of the Cartographer components are available in binary and source code distributions while others are only available in binary format.  Source code encompasses Java, C, and XML.  Source code that is available is under the [GNU GPL].
+
Some of the Cartographer components are available in binary and source code distributions while others are only available in binary format.  Source code encompasses Java, C, and XML.  Source code that is available is under the  
 +
[http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU GPLv2].
 +
 
 +
Software components not covered by the GPL are covered by the Krupczak.org, LLC license agreement.  Please read [[License_agreement |this license agreement]] before downloading and using those components.
  
 
By downloading from this page, you are accepting the terms and conditions of the corresponding software license and warranty.  Please read the [[warranty]] disclaimer before proceeding.
 
By downloading from this page, you are accepting the terms and conditions of the corresponding software license and warranty.  Please read the [[warranty]] disclaimer before proceeding.
 +
 +
If you download software, please register by emailing a short note to [mailto:info2@krupczak.org info2@krupczak.org].
 +
 +
== What are all the Pieces/Parts? ==
 +
 +
* '''Cartographer GUI''' -- Graphical user interface application, written in Java, which can query Cartographer agents and display dependency relationships.  It communicates with Cartographer agents via the XMP.  The Cartographer GUI is '''not''' available via open source.
 +
 +
* '''XMP Jar''' -- Java support for XMP is encapsulated in this Jar file.  It is available separately, distributed under the GPLv2, for use in the Cartographer GUI, OpenNMS, and various other integration projects.
 +
 +
* '''Cartographer Agent''' -- an agent engine and plugins supporting various MIBs and functionality.  The agent engine is written in C and is available under the GPLv2.  The agent engine is called '''xmpd'''.  The agent engine implements a small core MIB.
 +
 +
* '''MIB2 Plugin''' -- a plugin for '''xmpd''' that implements MIB-2 RFC 1213 plus minor extensions.  The plugin is written in C and is loaded automatically by the agent engine.  The MIB-2 plugin is available under the GPLv2.  Plugins are written as shared libraries which are loaded at run-time by the agent engine or xmpd.
 +
 +
* '''Test Plugin''' -- a simple, example plugin designed to serve as a template for plugin development.  It is written in C and is available under the GPLv2.
 +
 +
* '''Cartographer Plugin''' -- this C plugin is the heart of the Cartographer project and implements the Cartographer MIB and accompanying functionality.  This source to this plugin is '''not''' open-sourced.
 +
 +
The figures below depict the software architectural relationship between the various components.  <span style="color:green">Green</span> denotes an open-source component, covered by the [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GPLv2], while <span style="color:blue">blue</span> denotes those that are traditional or closed-source covered by our [[License_agreement|own license agreement]].
 +
 +
<center>
 +
<graphviz>
 +
digraph A {
 +
  rankdir=LR;
 +
  label = "Big Picture";
 +
  graph[bgcolor="transparent"];
 +
  node [shape=circle, style="bold"];
 +
  edge [style=bold];
 +
  S1 [ color=blue, label = "GUI" ];
 +
  S2 [ color=green, label = "agent" ];
 +
  S3 [ color=green, label = "agent" ];
 +
  S1 -> S2 [color=green, label = "XMP"];
 +
  S2 -> S3 [color=green, label = "XMP"];
 +
  S1 -> S3 [color=green, label = "XMP"];
 +
  S3 -> S1 [color=green];
 +
  S3 -> S2 [color=green];
 +
  S2 -> S1 [color=green];
 +
}
 +
</graphviz>
 +
</center>
 +
 +
<center>
 +
<graphviz>
 +
graph B {
 +
  label="Inside the Cartographer Agent";
 +
  graph[bgcolor="transparent"];
 +
  subgraph cluster_0 {
 +
        color=green;
 +
        label="Agent Engine (Xmpd)";
 +
        mib2 [color=green, label="MIB2 plugin"];
 +
        cartographer [color=blue, label="Cartographer plugin"];
 +
        test [color=green, label="Test plugin"];
 +
  }
 +
}
 +
</graphviz>
 +
</center>
  
 
== XMP Protocol Implementation in Java ==
 
== XMP Protocol Implementation in Java ==
  
* [[media:Xmp.jar|Source code and class Jar file]]
+
* [[media:xmp-1.31.jar|Source code (v1.31) and class Jar file]]
* [http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt License]
+
* GPLv2 [http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt License]
 +
* [[Warranty]]
  
== Binary Agent Engine Plus Plugins (All Platforms) ==
+
== Binary Package: Agent Engine Plus Plugins (All Platforms) ==
  
 +
* [[Cartographer Agent Installation]]
 +
* GPLv2 [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html License] and the Krupczak.org [[License_agreement|license]]
 +
* [[Warranty]]
  
== Agent Engine ==
+
=== Current ===
  
* Source code
+
* [[media:cartographer-1.6-1.zip|Binary package (zip format) v1.6]]
* Binary agent distribution, all platforms
+
* [[media:cartographer-1.6-1.tar.bz2|Binary package (bzip2 tar format) v1.6]]
 +
* [[media:cartographer-1.6-1.exe.zip|Binary package (zip format, Windows installer) v1.6]]
 +
* [[media:cartographer-1.6-1.pkg.bz2|Binary package (Solaris (Sparc,x86) package, bzip2) v1.6]]
 +
* [[media:cartographer-1.6-1.i386.rpm.bz2|Binary package (Linux RPM, bzip2) v1.6]]
 +
* [[media:cartographer-1.6-1.i386.rpm|Binary package (Linux RPM) v1.6]]
  
== MIB-2 Plugin ==
+
=== Old ===
  
* Source code
+
* [[media:cartographer-1.5-1.zip|Binary package (zip format) v1.5]]
 +
* [[media:cartographer-1.5-1.tar.bz2|Binary package (bzip2 tar format) v1.5]]
 +
* [[media:cartographer-1.5-1.exe.zip|Binary package (zip format, Windows installer) v1.5]]
 +
* [[media:cartographer-1.5-1.pkg.bz2|Binary package (Solaris (Sparc,x86) package, bzip2) v1.5]]
 +
* [[media:cartographer-1.5-1.rpm.bz2|Binary package (Linux RPM, bzip2) v1.5]]
 +
* [[media:cartographer-1.5-1.rpm|Binary package (Linux RPM) v1.5]]
 +
 
 +
== Source Code ==
 +
 
 +
Package includes source code to the agent engine, MIB2-plugin, and a test/example plugin.  Source code for the cartographer plugin is '''not''' included.
 +
 
 +
* [[Cartographer Agent Build Instructions|Build Instructions]]
 +
* [[media:Dist-1.5-1.tar.bz2|Source code (bzip2 tar format) v1.5]]
 +
* GPLv2 [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html License]
 +
* [[Warranty]]
  
 
== Cartographer Java GUI ==
 
== Cartographer Java GUI ==
  
* Binary distribution
+
* [[Installing the Cartographer GUI]]
 +
* Krupczak.org [[License_agreement|license]]
 +
* [[Warranty]]
 +
 
 +
 
 +
=== Current ===
 +
 
 +
* [[media:Cartographer-gui-0.60-1.zip|Binary distribution (zip format) (v0.60)]]
 +
* [[media:Cartographer-gui-0.60-1.exe.zip|Binary distribution Windows installer (zip format) (v0.60)]]
 +
* [[media:Cartographer-gui-0.60-1.noarch.rpm.bz2|Binary distribution Linux RPM, bzip2 (v0.60))]]
 +
 
 +
=== Old ===
 +
 
 +
* [[media:Cartographer-gui-0.50-1.zip|Binary distribution zip format(v0.50)]]
 +
* [[media:Cartographer-gui-0.50-1.exe.zip|Binary distribution Windows installer (v0.50)]]
 +
* [[media:Cartographer-gui-0.50-1.noarch.rpm.bz2|Binary distribution Linux RPM, bzip2 (v0.50))]]
 +
 
 +
== Cartographer Tools for Android ==
 +
 
 +
* Android [https://play.google.com/store/apps/details?id=org.krupczak.xmpquery&hl=en XmpQuery] tool in Google Play Store
  
 
== Mailing Lists ==
 
== Mailing Lists ==
Line 33: Line 132:
  
 
* [mailto:cartographer-devel-request@krupczak.org cartographer-devel] is a discussion list for developers and interested users.
 
* [mailto:cartographer-devel-request@krupczak.org cartographer-devel] is a discussion list for developers and interested users.
 +
 +
== Bug Tracking and Source Code Repository ==
 +
 +
We are not yet using any formal bug tracking system (e.g. Bugzilla).  However, we are evaluating different options assuming we find any bugs.  In the interim, please email bugs, nits, and questions to the developers' mailing list. 
 +
 +
The Cartographer project source code is stored in a Subversion repository that is not accessible to the public.  We will consider moving it to Sourceforge or another open-source project hosting provider if/when the need arises.
  
 
== See Also ==
 
== See Also ==
  
 +
* [[Cartographer FAQ|FAQ]]
 +
* [[Cartographer Project Release Notes]]
 
* [[XMP]]
 
* [[XMP]]
 
* [[Cartographer]]
 
* [[Cartographer]]

Latest revision as of 10:19, 23 March 2022

Contents

[edit] Cartographer Distributions and Source Code

Some of the Cartographer components are available in binary and source code distributions while others are only available in binary format. Source code encompasses Java, C, and XML. Source code that is available is under the GNU GPLv2.

Software components not covered by the GPL are covered by the Krupczak.org, LLC license agreement. Please read this license agreement before downloading and using those components.

By downloading from this page, you are accepting the terms and conditions of the corresponding software license and warranty. Please read the warranty disclaimer before proceeding.

If you download software, please register by emailing a short note to info2@krupczak.org.

[edit] What are all the Pieces/Parts?

  • Cartographer GUI -- Graphical user interface application, written in Java, which can query Cartographer agents and display dependency relationships. It communicates with Cartographer agents via the XMP. The Cartographer GUI is not available via open source.
  • XMP Jar -- Java support for XMP is encapsulated in this Jar file. It is available separately, distributed under the GPLv2, for use in the Cartographer GUI, OpenNMS, and various other integration projects.
  • Cartographer Agent -- an agent engine and plugins supporting various MIBs and functionality. The agent engine is written in C and is available under the GPLv2. The agent engine is called xmpd. The agent engine implements a small core MIB.
  • MIB2 Plugin -- a plugin for xmpd that implements MIB-2 RFC 1213 plus minor extensions. The plugin is written in C and is loaded automatically by the agent engine. The MIB-2 plugin is available under the GPLv2. Plugins are written as shared libraries which are loaded at run-time by the agent engine or xmpd.
  • Test Plugin -- a simple, example plugin designed to serve as a template for plugin development. It is written in C and is available under the GPLv2.
  • Cartographer Plugin -- this C plugin is the heart of the Cartographer project and implements the Cartographer MIB and accompanying functionality. This source to this plugin is not open-sourced.

The figures below depict the software architectural relationship between the various components. Green denotes an open-source component, covered by the GPLv2, while blue denotes those that are traditional or closed-source covered by our own license agreement.

[edit] XMP Protocol Implementation in Java

[edit] Binary Package: Agent Engine Plus Plugins (All Platforms)

[edit] Current

[edit] Old

[edit] Source Code

Package includes source code to the agent engine, MIB2-plugin, and a test/example plugin. Source code for the cartographer plugin is not included.

[edit] Cartographer Java GUI


[edit] Current

[edit] Old

[edit] Cartographer Tools for Android

  • Android XmpQuery tool in Google Play Store

[edit] Mailing Lists

There are several mailing lists associated with the Cartographer project.

[edit] Bug Tracking and Source Code Repository

We are not yet using any formal bug tracking system (e.g. Bugzilla). However, we are evaluating different options assuming we find any bugs. In the interim, please email bugs, nits, and questions to the developers' mailing list.

The Cartographer project source code is stored in a Subversion repository that is not accessible to the public. We will consider moving it to Sourceforge or another open-source project hosting provider if/when the need arises.

[edit] See Also