karaf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbono...@apache.org
Subject svn commit: r1546732 - in /karaf/trunk/manual/src/main/webapp: _navigation.conf users-guide/index.conf users-guide/instances.conf
Date Sat, 30 Nov 2013 14:10:21 GMT
Author: jbonofre
Date: Sat Nov 30 14:10:21 2013
New Revision: 1546732

URL: http://svn.apache.org/r1546732
Log:
Fix typo and link in the manual

Modified:
    karaf/trunk/manual/src/main/webapp/_navigation.conf
    karaf/trunk/manual/src/main/webapp/users-guide/index.conf
    karaf/trunk/manual/src/main/webapp/users-guide/instances.conf

Modified: karaf/trunk/manual/src/main/webapp/_navigation.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/_navigation.conf?rev=1546732&r1=1546731&r2=1546732&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/_navigation.conf (original)
+++ karaf/trunk/manual/src/main/webapp/_navigation.conf Sat Nov 30 14:10:21 2013
@@ -5,20 +5,20 @@ h3. [Home|/index]
 
 h3. [Users Guide|/users-guide/index]
 
-- [Installing Karaf|/users-guide/installation]
-- [Directory Structure|/users-guide/directory-structure]
-- [Starting and stopping Karaf|/users-guide/start-stop]
-- [OS integration|/users-guide/wrapper]
+- [Installation|/users-guide/installation]
+- [Directory structure|/users-guide/directory-structure]
+- [Start, stop, restart, connect|/users-guide/start-stop]
+- [Integration in the operating system: the Service Wrapper|/users-guide/wrapper]
 - [Configuration|/users-guide/configuration]
 - [Using the console|/users-guide/using-console]
 - [Web console|/users-guide/web-console]
 - [Remote console|/users-guide/remote-console]
 - [Web console|/users-guide/web-console]
 - [Deployer|/users-guide/deployer]
-- [Child instances|/users-guide/child-instances]
+- [Instances|/users-guide/instances]
 - [Security|/users-guide/security]
 - [Failover Deployments|/users-guide/failover]
-- [Logging system|/users-guide/logging-system]
+- [Log|/users-guide/logging-system]
 - [Provisioning|/users-guide/provisioning]
 - [KAR archive|/users-guide/kar]
 - [JRE tuning|/users-guide/jre-tuning]

Modified: karaf/trunk/manual/src/main/webapp/users-guide/index.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/index.conf?rev=1546732&r1=1546731&r2=1546732&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/index.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/index.conf Sat Nov 30 14:10:21 2013
@@ -1,7 +1,7 @@
 h1. Karaf Users Guide
 
 * [Installation|installation]
-* [Directory Structure|directory-structure]
+* [Directory structure|directory-structure]
 * [Start, stop, restart, connect|start-stop]
 * [Integration in the operating system: the Service Wrapper|wrapper]
 * [Configuration|configuration]
@@ -12,7 +12,7 @@ h1. Karaf Users Guide
 * [Instances|instances]
 * [Security|security]
 * [Failover Deployments|failover]
-* [Logging system|logging-system]
+* [Log|logging-system]
 * [Provisioning|provisioning]
 * [Provisioning Schema|provisioning-schema]
 * [Karaf Archive|kar]

Modified: karaf/trunk/manual/src/main/webapp/users-guide/instances.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/instances.conf?rev=1546732&r1=1546731&r2=1546732&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/instances.conf (original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/instances.conf Sat Nov 30 14:10:21 2013
@@ -1,13 +1,13 @@
 h1. Instances
 
-A instance is a complete new Karaf runtime, isolated from the other ones.
+A instance is a complete new Apache Karaf runtime, isolated from the other ones.
 
-The purpose is to easily create and manage a new Karaf runtime without installing a complete
distribution.
+The purpose is to easily create and manage a new Apache Karaf runtime without installing
a complete distribution.
 A instance
 
 A  instance is a new instance that you can launch separately from the root one, and deploy
applications into.
 
-An instance does not contain a full copy of the Karaf distribution, but only a set of the
configuration files and data folder which contains all the runtime information, logs and temporary
files.
+An instance does not contain a full copy of the Apache Karaf distribution, but only a set
of the configuration files and data folder which contains all the runtime information, logs
and temporary files.
 
 h2. Using the instance commands
 
@@ -23,7 +23,7 @@ As shown in the following example, {{ins
 karaf@root()> instance:create test
 {code}
 
-The new instance is fresh Karaf instance. It uses default configuration files set, as you
install a fresh Karaf distribution.
+The new instance is fresh Apache Karaf instance. It uses default configuration files set,
as you install a fresh Karaf distribution.
 
 You can enable the verbose mode for the {{instance:create}} command using the {{-v}} option:
 
@@ -56,12 +56,12 @@ Creating file: /opt/karaf/instances/test
 Creating file: /opt/karaf/instances/test/bin/stop
 {code}
 
-You can manually configure the different ports, the location of the instance, the Karaf features
URLs using different options of the {{instance:create}} command.
+You can manually configure the different ports, the location of the instance, the Apache
Karaf features URLs using different options of the {{instance:create}} command.
 You can have details about these options using the {{--help}} option.
 
 h3. Cloning an instance
 
-Instead of creating a fresh instance, you can clone an existing instance using [{{instance:clone}}|/commands/instance-clone].
+Instead of creating a fresh instance, you can clone an existing instance using {{instance:clone}}.
 
 The {{instance:clone}} command reuse the files from the source instance:
 
@@ -113,7 +113,7 @@ NB: {{instance:destroy}} will remove the
 
 h3. Changing instance ports
 
-You can change the SSH port number assigned to an instance using the [{{instance:ssh-port-change}}|/commands/ssh-port-change]
command:
+You can change the SSH port number assigned to an instance using the {{instance:ssh-port-change}}
command:
 
 {code}
 karaf@root()> instance:ssh-port-change test 8104
@@ -121,7 +121,7 @@ karaf@root()> instance:ssh-port-change t
 
 where test is the instance name and 8104 is the new SSH port number to use for the test instance.
 
-You can change the RMI Registry port number (used by JMX) of an instance using the [{{instance:rmi-registry-port-change}}|/commands/rmi-registry-port-change]
command:
+You can change the RMI Registry port number (used by JMX) of an instance using the {{instance:rmi-registry-port-change}}
command:
 
 {code}
 karaf@root()> instance:rmi-registry-port-change test 1102
@@ -129,7 +129,7 @@ karaf@root()> instance:rmi-registry-port
 
 where test is the instance name and 1102 is the new RMI Registry port number to use for the
test instance.
 
-You can also change the RMI Server port number (used by JMX too) of an instance using the
[{{instance:rmi-server-port-change}}|/commands/rmi-server-port-change] command:
+You can also change the RMI Server port number (used by JMX too) of an instance using the
{{instance:rmi-server-port-change}} command:
 
 {code}
 karaf@root()> instance:rmi-server-port-change test 44447
@@ -143,7 +143,7 @@ h3. Starting instances
 
 New instances are created in a stopped state.
 
-To start an instance, you can use the [{{instance:start}}|/commands/instance-start] command:
+To start an instance, you can use the {{instance:start}} command:
 
 {code}
 karaf@root()> instance:start test
@@ -153,7 +153,7 @@ where test is the instance name.
 
 h3. Listing instances
 
-To list the instances and their current status, you can use the [{{instance:list}}|/commands/instance-list]
command:
+To list the instances and their current status, you can use the {{instance:list}} command:
 
 {code}
 karaf@root()> instance:list
@@ -171,7 +171,7 @@ An instance can be in the following stat
 
 h3. Status of an instance
 
-You can get directly the status of a given instance using the [{{instance:status}}|/commands/instance-status]
command:
+You can get directly the status of a given instance using the {{instance:status}} command:
 
 {code}
 karaf@root()> instance:status test
@@ -182,7 +182,7 @@ where test is the instance name.
 
 h3. Connecting to an instance
 
-You can connect to a running instance directly from the root one using the [{{instance:connect}}|/commands/instance-connect]
command:
+You can connect to a running instance directly from the root one using the {{instance:connect}}
command:
 
 {code}
 karaf@root()> instance:connect test
@@ -192,7 +192,8 @@ where 'test' is the instance name where 
 
 By default, this command will use the same username used on the root instance, and the password
will be prompted.
 
-You can use a different username using the {{-u}} or {{--username}} option. You can also
provide the password using the {{-p}} or {{--password}} option.
+You can use a different username using the {{-u}} or {{--username}} option. You can also
provide the password using the
+{{-p}} or {{--password}} option.
 
 If you don't provide any argument, you will logon on the instance:
 
@@ -227,7 +228,8 @@ region                        | 3.0.0   
 
 h3. Stop an instance
 
-To stop an instance, you can connect to the instance (using {{instance:connect}}) and execute
the {{system:shutdown}} command.
+To stop an instance, you can connect to the instance (using {{instance:connect}}) and execute
the {{system:shutdown}}
+command.
 
 You can also use the [{{instance:stop}}|/commands/instance-stop] command:
 
@@ -241,7 +243,7 @@ The instance will go to the "Stopped" st
 
 h3. Destroy an instance
 
-You can completely delete a stopped instance using the [{{instance:destroy}}|/commands/instance-destroy]
command:
+You can completely delete a stopped instance using the {{instance:destroy}} command:
 {code}
 karaf@root()> instance:destroy test
 {code}
@@ -252,7 +254,7 @@ NB: the {{instance:destroy}} deletes the
 
 h3. Rename an instance
 
-You can change the name of a stopped instance using the [{{instance:rename}}|/commands/instance-rename]
command:
+You can change the name of a stopped instance using the {{instance:rename}} command:
 
 {code}
 karaf@root()> instance:rename test newTest
@@ -264,7 +266,8 @@ h2. Instance script
 
 The {{instance:*}} commands require the root instance running.
 
-But, you can also administrate directly instances without the root instance, using the {{bin/instance}}
Unix script (or {{bin/instance.bat}} script on Windows).
+But, you can also administrate directly instances without the root instance, using the {{bin/instance}}
Unix script
+(or {{bin/instance.bat}} script on Windows).
 
 You find the same actions that you can do with the {{instance:*}} commands in the {{instance[.bat]}}
script:
 
@@ -324,38 +327,41 @@ OPTIONS
 
 {code}
 
-h2. InstanceMBean
+h2. JMX InstanceMBean
 
 On the JMX layer, you have a MBean dedicated to the management of the instances.
 
-The ObjectName to use is {{org.apache.karaf:type=instance,name=root}} (you can find it in
the MBean using jconsole for instance).
+The ObjectName to use is {{org.apache.karaf:type=instance,name=*}}.
 
 h3. Instances attribute
 
-The InstanceMBean provides an Instances attribute providing a tabular data. This tabular
data contains a table of all instance, with details for each instance:
-- {{Is Root}} (boolean): if true, the instance is the root instance, false else.
-- {{JavaOpts}} (string): it contains the JVM arguments used by the instance.
-- {{Location}} (string): it's the path to the instance storage.
-- {{Name}} (string): it's the name of the instance.
-- {{Pid}} (long): it's the current system process ID (PID) of the instance process.
-- {{RMI Registry Port}} (int): it's the port number of the instance RMI Registry (JMX).
-- {{RMI Server Port}} (int): it's the port number of the instance RMI Server (JMX).
-- {{SSH Port}} (int): it's the port number of the instance SSH Server.
-- {{State}} (string): it's the current status of the instance (Stopped, Starting, Started).
+The InstanceMBean provides an Instances attribute providing a tabular data. This tabular
data contains a table of all
+instance, with details for each instance:
+
+* {{Is Root}} (boolean): if true, the instance is the root instance, false else.
+* {{JavaOpts}} (string): it contains the JVM arguments used by the instance.
+* {{Location}} (string): it's the path to the instance storage.
+* {{Name}} (string): it's the name of the instance.
+* {{Pid}} (long): it's the current system process ID (PID) of the instance process.
+* {{RMI Registry Port}} (int): it's the port number of the instance RMI Registry (JMX).
+* {{RMI Server Port}} (int): it's the port number of the instance RMI Server (JMX).
+* {{SSH Port}} (int): it's the port number of the instance SSH Server.
+* {{State}} (string): it's the current status of the instance (Stopped, Starting, Started).
 
 h3. Operations
 
 The InstanceMBean provides the following operations, corresponding to the previous {{instance:*}}
commands:
-- {{createInstance(instanceName, sshPort, rmiRegistryPort, rmiServerPort, location, javaOpts,
features, featuresUrls)}}: create a new instance.
-- {{changeSshPort(instanceName, port)}}: change the SSH port of an instance.
-- {{changeRmiServerPort(instanceName, port)}}: change the RMI server port of an instance.
-- {{changeRmiRegistry(instanceName, port)}}: change the RMI registry port of an instance.
-- {{changeJavaOpts(instanceName, javaOpts)}}: change the Java options of an instance.
-- {{destroyInstance(instanceName)}}: destroy an instance.
-- {{startInstance(instanceName)}}: start an instance.
-- {{startInstance(instanceName, options)}}: start an instance with the given Java options.
-- {{startInstance(instanceName, options, wait, debug)}}: start an instance with the given
Java options. If wait is true, this operation is waiting for the instance is in "Started"
state. If debug is true, the instance is started in debug mode.
-- {{stopInstance(instanceName)}}: stop an instance.
-- {{renameInstance(instanceName, newInstanceName)}}: rename an instance.
-- {{renameInstance(instanceName, newInstanceName, verbose)}}: rename an instance. If verbose
is true, this operation provides details in the log.
-- {{cloneInstance(instanceName, cloneName, sshPort, rmiRegistryPort, rmiServerPort, location,
javaOpts)}}: clone an existing instance.
\ No newline at end of file
+* {{createInstance(instanceName, sshPort, rmiRegistryPort, rmiServerPort, location, javaOpts,
features, featuresUrls)}}: create a new instance.
+* {{changeSshPort(instanceName, port)}}: change the SSH port of an instance.
+* {{changeRmiServerPort(instanceName, port)}}: change the RMI server port of an instance.
+* {{changeRmiRegistry(instanceName, port)}}: change the RMI registry port of an instance.
+* {{changeJavaOpts(instanceName, javaOpts)}}: change the Java options of an instance.
+* {{destroyInstance(instanceName)}}: destroy an instance.
+* {{startInstance(instanceName)}}: start an instance.
+* {{startInstance(instanceName, options)}}: start an instance with the given Java options.
+* {{startInstance(instanceName, options, wait, debug)}}: start an instance with the given
Java options.
+ If wait is true, this operation is waiting for the instance is in "Started" state. If debug
is true, the instance is started in debug mode.
+* {{stopInstance(instanceName)}}: stop an instance.
+* {{renameInstance(instanceName, newInstanceName)}}: rename an instance.
+* {{renameInstance(instanceName, newInstanceName, verbose)}}: rename an instance. If verbose
is true, this operation provides details in the log.
+* {{cloneInstance(instanceName, cloneName, sshPort, rmiRegistryPort, rmiServerPort, location,
javaOpts)}}: clone an existing instance.
\ No newline at end of file



Mime
View raw message