Author: jbonofre
Date: Mon Feb 20 10:24:13 2012
New Revision: 1291181
URL: http://svn.apache.org/viewvc?rev=1291181&view=rev
Log:
[KARAF-947] Update the manual with the new instance commands
Modified:
karaf/trunk/manual/src/main/webapp/quick-start.conf
karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
Modified: karaf/trunk/manual/src/main/webapp/quick-start.conf
URL:
http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/quick-start.conf?rev=1291181&r1=1291180&r2=1291181&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/quick-start.conf (original)
+++ karaf/trunk/manual/src/main/webapp/quick-start.conf Mon Feb 20 10:24:13 2012
@@ -53,8 +53,8 @@ You can now run your first command. Sim
{code:borderStyle=solid}
karaf@root>
-admin:change-port admin:connect admin:create
admin:destroy
-admin:list admin:start admin:stop
config:cancel
+instance:change-port instance:connect instance:create
instance:destroy
+instance:list instance:start instance:stop
config:cancel
config:edit config:list config:propappend
config:propdel
config:proplist config:propset config:update
dev:dynamic-import
dev:framework dev:print-stack-traces dev:show-tree
features:addUrl
@@ -83,14 +83,14 @@ karaf@root>
You can then grab more specific help for a given command using the {{--help}}
option for this command:
{code:borderStyle=solid}
-karaf@root> admin:create --help
+karaf@root> instance:create --help
DESCRIPTION
- admin:create
+ instance:create
Create a new instance.
SYNTAX
- admin:create [options] name
+ instance:create [options] name
ARGUMENTS
name
@@ -113,7 +113,7 @@ OPTIONS
karaf@root>
{code}
-Note that the console supports tab completion, so you just need to enter {{ad
<tab> cr <tab>}} instead of {{admin:create}}.
+Note that the console supports tab completion, so you just need to enter {{ad
<tab> cr <tab>}} instead of {{instance:create}}.
h2. Deploy a sample application
Modified: karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
URL:
http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf?rev=1291181&r1=1291180&r2=1291181&view=diff
==============================================================================
--- karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf
(original)
+++ karaf/trunk/manual/src/main/webapp/users-guide/child-instances.conf Mon Feb
20 10:24:13 2012
@@ -2,18 +2,18 @@ h1. Managing child instances
A child instance of Karaf is a copy that you can launch separately and deploy
applications into. An instance does not contain the full copy of Karaf, but
only a copy of the configuration files and data folder which contains all the
runtime information, logs and temporary files.
-h2. Using the admin console commands
+h2. Using the instance console commands
-The *admin* console commands allow you to create and manage instances of Karaf
on the same machine. Each new runtime is a child instance of the runtime that
created it. You can easily manage the children using names instead of network
addresses. For details on the *admin* commands, see the [{{admin}}
commands|/commands/admin].
+The *instance* console commands allow you to create and manage instances of
Karaf on the same machine. Each new runtime is a child instance of the runtime
that created it. You can easily manage the children using names instead of
network addresses. For details on the *admin* commands, see the [{{admin}}
commands|/commands/admin].
h2. Creating child instances
-You create a new runtime instance by typing
[{{admin:create}}|/commands/admin-create] in the Karaf console.
+You create a new runtime instance by typing
[{{instance:create}}|/commands/instance-create] in the Karaf console.
-As shown in the following example, {{admin:create}} causes the runtime to
create a new runtime installation in the active runtime's {{instances/[name]}
directory. The new instance is a new Karaf instance and is assigned an SSH
port number based on an incremental count starting at 8101 and a RMI registry
port number based on an incremental count starting at 1099.
+As shown in the following example, {{instance:create}} causes the runtime to
create a new runtime installation in the active runtime's {{instances/[name]}
directory. The new instance is a new Karaf instance and is assigned an SSH
port number based on an incremental count starting at 8101 and a RMI registry
port number based on an incremental count starting at 1099.
{code}
-karaf@root>admin:create finn
+karaf@root> instance:create finn
Creating new instance on SSH port 8106 and RMI port 1100 at:
/home/user/instances/test
Creating dir: /home/user/instances/test/bin
Creating dir: /home/user/instances/test/etc
@@ -39,28 +39,28 @@ karaf@root>
h2. Changing a child's ports
-You can change the SSH port number assigned to a child instance using the
[{{admin:change-ssh-port}}|/commands/admin-change-port] command. The syntax
for the command is:
+You can change the SSH port number assigned to a child instance using the
[{{instance:change-ssh-port}}|/commands/instance-change-port] command. The
syntax for the command is:
{code}
-admin:change-ssh-port instance port
+instance:change-ssh-port instance port
{code}
Note that the child instance has to be stopped in order to run this command.
-In the same way, you can change the RMI registry port number assigned to a
child instance using the
[{{admin:change-rmi-registry-port}}|/commands/admin-change-rmi-registry-port]
command. The syntax for the command is:
+In the same way, you can change the RMI registry port number assigned to a
child instance using the
[{{instance:change-rmi-registry-port}}|/commands/instance-change-rmi-registry-port]
command. The syntax for the command is:
{code}
-admin:change-rmi-registry-port instance port
+instance:change-rmi-registry-port instance port
{code}
Note that the child instance has to be stopped in order to run this command.
h2. Starting child instances
-New instances are created in a stopped state. To start a child instance and
make it ready to host applications, use the
[{{admin:start}}|/commands/admin-start] command. This command takes a single
argument {{[instance-name]}} that identifies the child you want started.
+New instances are created in a stopped state. To start a child instance and
make it ready to host applications, use the
[{{instance:start}}|/commands/instance-start] command. This command takes a
single argument {{[instance-name]}} that identifies the child you want started.
h2. Listing all container instances
-To see a list of all Karaf instances running under a particular installation,
use the [{{admin:list}}|/commands/admin-list] command.
+To see a list of all Karaf instances running under a particular installation,
use the [{{instance:list}}|/commands/instance-list] command.
{code}
-karaf@root>admin:list
+karaf@root> instance:list
SSH Port RMI Port State Pid Name
[ 8107] [ 1106] [Started ] [10628] harry
[ 8101] [ 1099] [Started ] [20076] root
@@ -71,10 +71,10 @@ karaf@root>
h2. Connecting to a child instance
-You can connect to a started child instance's remote console using the
[{{admin:connect}}|/commands/admin-connect] command which takes three arguments:
+You can connect to a started child instance's remote console using the
[{{instance:connect}}|/commands/instance-connect] command which takes three
arguments:
{code}
-admin:connect [-u username] [-p password] instance
+karaf@root> instance:connect [-u username] [-p password] instance
{code}
Once you are connected to the child instance, the Karaf prompt changes to
display the name of the current instance, as shown:
@@ -87,43 +87,46 @@ h2. Stopping a child instance
To stop a child instance from within the instance itself, type
{{system:shutdown}}.
-To stop a child instance remotely, in other words, from a parent or sibling
instance, use the [{{admin:stop}}|/commands/admin-stop]:
+To stop a child instance remotely, in other words, from a parent or sibling
instance, use the [{{instance:stop}}|/commands/instance-stop]:
{code}
-admin:stop instance
+karaf@root> instance:stop instance
{code}
h2. Destroying a child instance
-You can permanently delete a stopped child instance using the
[{{admin:destroy}}|/commands/admin-destroy] command:
+You can permanently delete a stopped child instance using the
[{{instance:destroy}}|/commands/instance-destroy] command:
+
{code}
-admin:destroy instance
+karaf@root> instance:destroy instance
{code}
Note that only stopped instances can be destroyed.
h2. Renaming a child instance
-You can easily change the name of an existing instance using the
[{{admin:rename}}|/commands/admin-rename] command:
+You can easily change the name of an existing instance using the
[{{instance:rename}}|/commands/instance-rename] command:
+
{code}
-admin:rename instance newName
+karaf@root> instance:rename instance newName
{code}
Note that only stopped instances can be renamed.
h2. Cloning a child instance
-You can easily clone (copy) an existing instance using the
[{{admin:clone}}|/commands/admin-clone] command:
+You can easily clone (copy) an existing instance using the
[{{instance:clone}}|/commands/instance-clone] command:
+
{code}
-admin:clone instance cloneName
+karaf@root> instance:clone instance cloneName
{code}
Note that only stopped instances can be cloned.
All instance files will be copied and the name and port numbers are changed in
the cloned instance.
-h2. Using the admin script
+h2. Using the instance script
-You can also manage the local instances of Karaf. The {{admin}} script in the
{{[karaf-install-dir]/bin}} directory provides the same commands as the
{{admin}} console commands, apart from
[{{admin:connect}}|/commands/admin-connect].
+You can also manage the local instances of Karaf. The {{instance}} script in
the {{[karaf-install-dir]/bin}} directory provides the same commands as the
{{instance}} console commands, apart from
[{{instance:connect}}|/commands/instance-connect].
{code}
-> bin/admin
+> bin/instance
Available commands:
change-ssh-port - Changes the secure shell port of an existing container
instance.
change-rmi-registry-port - Changes the RMI registry port (used by management
layer) of an existing container instance.
@@ -137,5 +140,5 @@ Type 'command --help' for more help on t
For example, to list all the instances of Karaf on the local machine, type:
{code}
-bin/admin list
+bin/instance list
{code}
