makebootconfig

java -Xmx64m -Xms64m
-jar KVHOME/lib/kvstore.jar makebootconfig [-verbose]
-root <rootDirectory> -host <hostname> -harange <startPort,endPort>
-port <port> [-config <configFile>]
[-store-security <none | configure | enable> ] 
[-noadmin]
[-admindir <directory path>]
[-admindirsize <directory size>]
[-storagedir <directory path>] 
[-storagedirsize <directory size>]
[-rnlogdir <directory path>]
[-capacity <n_rep_nodes>]
[-num_cpus <ncpus>][-memory_mb <memory_mb>]
[-servicerange <startPort,endPort>]
[-admin-web-port <admin web service port>]
[-hahost <haHostname>]
[-secdir <security dir>] [-pwdmgr {pwdfile | wallet | <class-name>}]
[-kspwd <password>]
[-external-auth {kerberos}]
  [-krb-conf <kerberos configuration>]
  [-kadmin-path <kadmin utility path>]
  [-instance-name <database instance name>]
  [-admin-principal <kerberos admin principal name>]
  [-kadmin-keytab <keytab file>]
  [-kadmin-ccache <credential cache file>]
  [-princ-conf-param <param=value>]*
[-security-param <param=value>]*
[-mgmt {jmx|none}] 
[-dns-cachettl <time in sec>]
      [-force] 

説明:

  • -capacity <n_rep_nodes>: ストレージ・ノードがサポートできるレプリケーション・ノードの総数です。値のデフォルトは"1"です。

    capacityを0に設定すると、このストレージ・ノードを使用してアービタ・ノードをホストできます。

  • -config <configFile>: 複数のストレージ・ノード・エージェント・プロセスが同じルート・ディレクトリを共有する場合のみ指定します。この値のデフォルトはconfig.xmlです。

  • -dns-cachettl <time in sec>は、レプリケーション・ノードがホスト名をIPアドレス・マッピングにキャッシュする必要がある秒数を指定します。デフォルト値は-1で、マッピングを無期限にキャッシュする必要があることを意味します。値0は、マッピングをキャッシュする必要がないことを意味します。このフラグの値は、networkaddress.cache.ttlおよびnetworkaddress.cache.negative.ttlセキュリティ・プロパティの設定に使用されます。

  • -external-auth {kerberos}は、外部認証サービスとしてKerberosを指定します。コマンドラインでキータブまたは資格証明キャッシュを指定しなかった場合は、securityconfigユーティリティのインタラクティブ・バージョンが実行されます。

    このフラグが許可されるのは、-store-securityフラグの値をconfigureまたはenableとして指定した場合のみです。

    実行中のストアからKerberos認証を削除するには、userExternalAuth security.xmlパラメータの値をNONEに設定します。

    Kerberosの詳細は、セキュリティ・ガイドKerberos認証サービスを参照してください。

    -external-authには、次のフラグを指定できます。

    • -admin-principal <kerberos admin principal name>

      Kerberos管理インタフェースにログインするために使用するプリンシパルを指定します。これは、kadminキータブまたはパスワードを使用して管理インタフェースに接続する場合に必須です。

    • -kadmin-ccache <credential cache file>

      kadmin/ADMINHOSTのサービス・チケットを含める必要があるKerberos資格証明キャッシュ・ファイルへの完全なパス名を指定します。ADMINHOSTは、管理サーバーまたはkadmin/adminサービスの完全修飾ホスト名です。

      指定しない場合、ユーザーは、Kerberos管理インタフェースへのログイン中にプリンシパルのパスワードを入力するよう求められます。このフラグを-kadmin-keytabフラグと組み合せて指定することはできません。

    • -kadmin-keytab <keytab file>

      Kerberos管理ユーザー・プリンシパルおよび暗号化されたキーを格納するKerberosキータブ・ファイルの場所を指定します。セキュリティ構成ツールでは、Kerberos管理インタフェースにログインするために、指定したキータブ・ファイルが使用されます。

      キータブ・ファイルのデフォルトの場所は、Kerberos構成ファイルで指定します。そこでキータブを指定していない場合は、ファイルuser.home/krb5.keytabが検索されます。

      キータブを使用してKerberos管理にログインする場合、-admin-principalフラグを指定する必要があります。そうしないと、正しい管理プリンシパルが認識されません。このフラグを-kadmin-ccacheフラグと組み合せて指定することはできません。

    • -kadmin-path <kadmin utility path>

      Kerberos kadminユーティリティの絶対パスを示します。デフォルト値は/usr/kerberos/sbin/kadminです。

    • -krb-conf <kerberos configuration>

      デフォルトのレルムおよびKDC情報を含むKerberos構成ファイルの場所を指定します。指定しない場合、デフォルト値は/etc/krb5.confです。

    • -princ-conf-param <param=value>*

      構成デフォルトの上書きを可能にする反復可能な引数。

      Oracle NoSQL DatabaseのKerberosサービス・プリンシパルの有効期限を指定するには、krbPrincValidityパラメータを使用します。

      Oracle NoSQL DatabaseのKerberosサービス・プリンシパルのパスワード有効期限を指定するには、krbPrincPwdExpireパラメータを使用します。

      作成する新しいキーに使用する暗号化タイプとsaltタイプのリストを指定するには、krbKeysaltパラメータを使用します。

  • -force ブート構成検証が無効なパラメータを見つけた場合でも、ブート構成ファイルの生成を強制実行するために、オプションで指定します。

  • -hahost <haHostname>: ストア・レプリケーション・トラフィックの個別のネットワーク・インタフェースを指定する場合に使用できます。この値のデフォルトは、-hostフラグを使用して指定されるホスト名です。

    ここで指定したホスト名は、DNSまたはノードに接続するクライアント・コードを実行するマシン上の/etc/hostsファイルを使用して解決可能である必要があります。

  • -harange <startPort,endPort>は、レプリケーション・ノードおよび管理がそれらの間の通信に使用する空きポートの範囲です。これらのポートは連続している必要があります。このノードに指定した容量と少なくとも同じ数のポートに加え、ノードが管理をホストする場合は追加ポートを割り当てる必要があります。

  • -host <hostname>: コマンドが実行されるノードに関連付けられたホスト名を識別します。このホスト名は、このノードとの通信に使用されるネットワーク・インタフェースを識別します。

    ここで指定したホスト名は、DNSまたはノードに接続するクライアント・コードを実行するマシン上の/etc/hostsファイルを使用して解決可能である必要があります。

  • -kspwd<password>: スクリプトベースの構成では、このオプションを使用することで、ツールによるコマンドラインでのキーストア・パスワードの指定が可能になります。指定されていない場合、ユーザーはパスワードの入力を求められます。

  • -memory_mb <memory_mb>は、マシンで使用可能なメモリーの合計MB数です。値が0の場合、ストアはマシン上のメモリー容量を特定しようとしますが、その値を使用できるのは、使用されているJVMがOracle Hotspot JVMである場合のみです。デフォルト値は"0"です。

    最善の結果を得るには、このパラメータを指定しないでください。Oracle NoSQL Databaseではデフォルトで適切な値が特定されます。このパラメータは慎重に使用する必要があり、例外的な状況にのみ使用してください。

  • -num_cpus <ncpus>: レプリケーション・ノードで使用できるマシン上のプロセッサの総数です。値が0の場合、システムはストレージ・ノードに問い合せて、マシン上のプロセッサ数を特定しようとします。この値のデフォルトは"0"です。

    最善の結果を得るには、このパラメータを指定しないでください。Oracle NoSQL Databaseではデフォルトで適切な値が特定されます。このパラメータは慎重に使用する必要があり、例外的な状況にのみ使用してください。

  • -port <port>は、Oracle NoSQL DatabaseがアクセスされるTCP/IPポートです。レジストリ・ポートと呼ばれることもあります。このポートは、このコマンドが実行されるノードで空いている必要があります。

  • -pwdmgr [ pwdfile | wallet ]

    キーストアへのアクセスなどに必要なパスワードの保持に使用されるパスワード・マネージャ・メカニズムを示します。

    -pwdmgrには次のオプションがあります。

    • -pwdmgr pwdfile

      パスワード・ストアが読取り保護されたクリアテキストのパスワード・ファイルであることを示します。これは、Oracle NoSQL Database CEデプロイメントにのみ使用できるオプションです。代替実装を指定できます。

    • -pwdmgr wallet

      パスワード・ストレージ・メカニズムとしてOracle Walletを指定します。このオプションは、Oracle NoSQL Database EEバージョンでのみ使用できます。

  • -root <rootDirectory>: ルート・ディレクトリが存在する場所を識別します。

  • -secdir <security dir>

    セキュリティ構成を保持するKVROOT内のディレクトリの名前を指定します。これは、指定されたsecrootに対して相対的な名前で指定する必要があります。指定しない場合、デフォルト値はsecurityです。

  • -security-param <param=value>*

    構成デフォルトの上書きを可能にする反復可能な引数。

    Oracle NoSQL DatabaseのKerberosサービス・プリンシパルのサービス名を指定するには、krbServiceNameパラメータを使用します。

    Oracle NoSQL DatabaseのKerberosサービス・プリンシパルのセキュリティ・ディレクトリ内のキータブ・ファイル名を指定するには、krbServiceKeytabパラメータを使用します。

  • -servicerange <startPort,endPort> ストレージ・ノードおよびその管理対象サービスで実行されている管理サービス間の通信に使用されるポートの範囲。このパラメータはオプションであり、ストレージ・ノード上のサービスがファイアウォールまたはその他のセキュリティ上の理由で特定のポートを使用する必要がある場合に役立ちます。デフォルトでは、サービスは匿名ポートを使用します。値の文字列の形式は、"startPort,endPort"です。

  • -admin-web-port <admin web service port>は、管理Webサービスを開始するTCP/IPポートです。指定しない場合、デフォルトのポート値は–1です。-admin-web-portに正の整数を指定していない場合、管理Webサービスは管理サービスとともに開始されません。Oracle NoSQL Databaseの管理のためのREST APIを参照してください。

  • -noadminは、SNAのブートストラップ管理サービスを無効にするように指定します。

  • -admindir <path>は、管理ノードに関連付けられた環境を格納するために使用するディレクトリへのパスを指定します。ディレクトリを指定しない場合、管理ノードはルート・ディレクトリの下のディレクトリを使用します。

  • -admindirsize <directory size>は、-admindirで識別される管理ストレージ・ディレクトリのサイズを指定します。このパラメータはオプションです。管理ディレクトリ・サイズの管理を参照してください。

    このパラメータに指定する値はlongである必要があり、オプションで、その後に単位文字列を付けます。指定できる単位文字列はKB、MBおよびGBで、それぞれ1024、1024^2および1024^3に対応します。指定可能な文字列では大/小文字は区別されません。long値と単位文字列の間の有効なデリミタは、「 」、「-」または「_」です。

    次に例を示します。

    -admindirsize 200 MB
    -admindirsize 1_gb
    -admindirsize 3000-Mb
  • -storagedir <path>は、レプリケーション・ノードが記憶域に使用するディレクトリへのパスを指定します。ストレージ・ノードがホストするレプリケーション・ノードが複数ある(1つより多い)場合、レプリケーション・ノードごとにこの引数を1回ずつ指定して、引数の数がストレージ・ノードの容量を超えないようにしてください。

    ストレージ・ディレクトリを明示的に指定しない場合、レプリケーション・ノードはルート・ディレクトリの下のディレクトリを使用します。必ず、-storagedir引数の数をcapacity引数の値と一致させてください。たとえば、ストレージ・ノードが4つのディスクをホストし、それぞれのレプリケーション・ノードにディスクを1つずつ使用する場合、capacityに4を指定し、4つの-storagedir引数を使用して、それぞれに対応する-storagedirsize <directory size>値を指定します。

  • -storagedirsize <directory size>は、それぞれの-storagedir引数で識別されるディレクトリのサイズを指定します。このパラメータはオプションですが、ストア・トポロジを決定する際に-storagedirsize <directory size>が考慮されるため、値を指定することをお薦めします。たとえば、一部のストレージ・ノードそれぞれのディスク容量がストアの他のSNより小さい場合、システムは、ストレージ容量と一致するようにシャードへのパーティション分散を調整することにより、それらのSNに格納されるデータが少なくなるように調整します。詳細は、ストレージ・ディレクトリ・サイズの管理を参照してください。

    また、すべてではありませんが、指定した一部のストレージ・ディレクトリについて-storagedirsize <directory size>パラメータを指定するとエラーになります。

    -storagedirsize <directory size>値はlongとして指定し、オプションで、その後に単位文字列を付けます。指定できる単位文字列はKB、MB、GBおよびTBで、それぞれ1024、1024^2、1024^3、1024^4に対応します。指定可能な文字列では大/小文字は区別されません。long値と単位文字列の間の有効なデリミタ文字は、「 」、「-」または「_」です。

    次に例を示します。

    -storagedirsize 200 MB
    -storagedirsize 4_tb
    -storagedirsize 5000-Mb

    注意:

    -storagedirパラメータを指定し、-storagedirsizeを指定しない場合、makebootconfigによって警告が表示されます。両方のパラメータを指定することをお薦めします。
  • -storageDirStorageType [hard drive | SSD | NVMe]は、ストレージ・ディレクトリを配置するディスクのタイプを指定します。

  • -rnlogdir <path>は、レプリケーション・ノードのログ・ファイルを格納するために使用するディレクトリへのパスを指定します。このフラグは、レプリケーション・ノードのログ・ディレクトリを複数指定するためにコマンド内で複数回使用できますが、その数はノードの容量を超えないようにしてください。

    ディレクトリを指定しない場合、デフォルトでは、ログはルート・ディレクトリの下に格納されます。

  • -store-security [none | configure | enable] セキュリティが使用されるかどうかを指定します。-store-security noneを指定すると、セキュリティは使用されません。-store-security configureを指定すると、セキュリティが使用され、makebootconfigプロセスによって、セキュリティ構成ユーティリティが処理の一部として起動されます。-store-security enableが指定されている場合、セキュリティは使用されません。セキュリティ構成ユーティリティを使用し、または別のシステムで以前に作成した構成をコピーすることで、セキュリティを構成する必要があります。

    注意:

    -store-securityコマンドはオプションです。ユーザーが–store-securityを指定しなくても、セキュリティはデフォルトで有効になっています。ユーザーは、ストレージ・ノード・エージェントを起動する前に、securityconfigユーティリティを実行してセキュリティ・フォルダを作成する必要があります。

  • -mgmt {jmx|none}

    ストレージ・ノードに対して有効にする監視のタイプを指定します。このパラメータはオプションです。監視が無効化されている場合、デフォルト値は「None」です。このパラメータを使用して、Java Management Extensions (JMX)エージェントを監視できるようにします。

    jmxを指定すると、ストレージ・ノードと、そのストレージ・ノードでホストされているレプリケーション・ノード、管理ノードおよびストレージ・ノード・エージェントなどのNoSQLコンポーネントの監視にJMXインタフェースが使用されます。Oracle NoSQL DatabaseのJMXエージェントは読取り専用インタフェースです。これらのインタフェースでは、ストレージ・ノード、およびストレージ・ノードがホストするすべてのレプリケーション・ノードまたは管理に関する情報についてストレージ・ノードをポーリングできます。ポーリングから提供される情報には、サービス・ステータス(RUNNING、STOPPED、UNREACHABLEなど)、操作パラメータおよびパフォーマンス・メトリックが含まれます。また、JMXを使用して調停ノードを監視することもできます。

    また、JMXエージェントは、特定のイベントについてイベント・トラップおよび通知を配信します。たとえば、JMXは、サービス・ステータスの状態が変化するたびに通知を送信したり、ストアで超過したパフォーマンス制限について通知を送信します。メトリックTotalReqを使用して操作リクエストの合計数を取得でき、メトリックTotalOpsは返されたレコードまたは処理されたレコードの合計数を示します。監視可能なイベントの定義は、ストレージ・ノード(SN)の監視を参照してください。

Oracle NoSQL Databaseのインスタンスで使用される未デプロイ・ストレージ・ノードの起動に使用される構成ファイルを作成します。このファイルは事前に存在することはできません。インストールの構成に使用される初期ブート構成ファイルを作成するには、インストールの構成パラメータを参照してください。

makebootconfigユーティリティを使用してパラメータを設定した後、それらを変更できます。使用するコマンドは、change-policy —paramsおよびplan change-parameters –paramsです。パラメータを変更すると、ノードの再起動が必要になることがあります。詳細は、CLIコマンド・リファレンスを参照してください。