To perform store configuration, you use the
runadmin
utility, which provides a command
line interface (CLI). The runadmin
utility
can be used for a number of purposes. In this chapter, we want to
use it to administer the nodes in our store, so we have to tell
runadmin
what node and registry port it can
use to connect to the store.
In this book, we have been using 5000
as the
registry port. For this example, we use the string
node01
to represent the network name
of the node to which runadmin
connects.
You should think about the name of the node to which the runadmin connects. The node used for initial configuration of the store, during store creation, cannot be changed.
The most important thing about this node is that it must have the Storage Node Agent running on it. All your nodes should have an SNA running on them at this point. If not, you need to go follow the instructions in Installing Oracle NoSQL Database before proceeding with the steps provided in this chapter.
Beyond that, be aware that if this is the very first node you have ever connected to the store using the CLI, then it becomes the node on which the master copy of the administration database resides. If you happen to care about which node serves that function, then make sure you use that node at this time.
To start runadmin
for administration purposes:
> java -jar KVHOME/lib/kvstore.jar runadmin \ -port 5000 -host node01
Note that once you have started the CLI, you can use its
help
command in order to discover all the
administration commands available to you.
Also note that the configuration steps described in this chapter can
be collected into a script file, and then that file can be
passed to the utility using its -script
command line option. See
Using a Script
for more information.
Some of the steps described in this chapter make heavy
use of the CLI's plan
command. This
command identifies a configuration action that you want to
perform on the store. You can either run that action
immediately or you can create a series of plans with
the -noexecute
flag and then
execute them later by using the
plan execute
command.
You can list all available plans by using the
plan
command without arguments.
For a high-level description of plans, see Plans.