Linux への Klocwork サーバーパッケージのインストール

このページでは、インストーラを使用して Klocwork サーバーパッケージをインストールする手順について説明します。

お使いになる前に

アップグレードですか? 前バージョンからのアップグレードを参照してください。

ソフトウェアはどこで入手できますか?

パッケージKlocwork サポートからダウンロードします。通常は、組織内で Klocwork テクニカルサポートポータルへのアクセス権限を持っているのは 1 人か 2 人のユーザーだけです。アクセス権限がない場合は新しいアカウントを登録してください。

ライセンスが必要です。まだ持っていない場合は、ライセンスの取得を参照してください。

2 つのバージョンの Klocwork サーバーの実行

たとえば既存のサーバーへのアクセスを継続しながら Klocwork 2023.1 サーバーをテストするなど、2 セットの Klocwork サーバーを実行する場合は、別々の projects_root ディレクトリでそれらを実行する必要があります。

システム要件のチェック

必要なパッケージおよび依存関係のリストについては、システム要件を参照してください。

インストールに関する注意事項

  • Klocwork サーバーを実行するには、ulimit -n を 2048 にする必要があります。
  • ダウンロードした .sh ファイルが実行可能ファイルであることを確認します。chmod コマンドを使用して適切なパーミッションを設定します。chmod 755 <kw-installer.sh>
  • Klocwork のインストール時にパーミッションを制御するには、umask の値を変更します。
  • Klocwork ソフトウェアはルート ユーザー以外でインストールします。
  • この製品をインストールするパスが、ユーザーがこの製品を呼び出すパスと同じであることを確認してください。たとえば、インストール環境へのローカル パスが /local/tools/klocwork でも、他のマシンにいるユーザーは NFS パス /opt/tools/klocwork を使用してこの製品を呼び出さなければなりません。したがって、ユーザーがこの製品を確実に呼び出せるようにするには、インストール時に /opt/tools/klocwork パスを使用します。
  • ファイルロッキングに関係する指摘のため、ユーザーホームディレクトリを NFS 上に配置しないでください。ファイルまたはディレクトリをロックできませんでした: 使用可能なロックがありませんを参照してください。
  • インストーラーは環境変数 'TMPDIR' を使用します。
  • 一部の Linux インストール環境では、Klocwork Server を実行する場合に、サードパーティライブラリの追加インストールが必要になることがあります。例: libaio1libaio、または libaio.x86_64
  • Linux でインストールしており、ターゲットマシンに 6 GB 以上のメモリがある場合、メモリ設定の構成はパフォーマンスを向上させるために増加されます。
  • Klocwork サーバーとデータベースサーバーは、同じマシン上で実行する必要があります。

ファイルロックに関する指摘を回避するために、NFS 上に projects_root ディレクトリを配置しないでください。

インストールパッケージの実行

次のコマンドを実行します。

kw-server-installer.23.1.x.x.<platform>.sh [options] <install_directory> [<component ...>]

フィールド

  • <platform> は linux です。
  • [<options>] は、サーバーパッケージ用のコマンドラインオプションに一覧表示されているオプションのいずれかです。
  • <install_directory> には、Klocwork をインストールするディレクトリを指定します。projects_root ディレクトリのサブディレクトリは指定しないでください。選択したディレクトリが空でない場合は、インストールを続行できません。
  • [<component ...>] は、サーバーコンポーネントの引数の任意の引数です。コンポーネントが複数個ある場合は、スペースで区切ります。1 つ以上のコンポーネントを指定しない場合、パッケージ全体がインストールされます。--list オプションを使用すると、さまざまなコンポーネントの引数のリストを表示することもできます。

サーバーパッケージ用のコマンドラインオプション

名前 短い名前 説明
--agree -a ライセンス契約を表示しないでライセンス条項に同意します。
--database-port <port_number>   データベースサーバーの実行に使用するポート番号を指定します。デフォルト: 3306。このオプションは、kwservice でポート番号を指定することと等価です。
--debug   デバッグ情報を印刷
--force -f 整合性チェックを行わないでインストールします
--help -h このヘルプを表示して終了します
--klocwork-port <port_number>   Klocwork サーバーの実行に使用するポート番号を指定します。デフォルト: 8080。このオプションは、kwservice でポート番号を指定することと等価です。
--license-port <port_number>   ライセンスサーバーがローカルに実行されても、非デフォルトのポートで実行されることを指定します。デフォルト: 27000。このオプションは、kwservice でポート番号を指定することと等価です。
--license-server <host>[:<port>]   リモートライセンスサーバーホストを指定します。ホスト引数は必要ですが、ポート引数はオプションです。デフォルト: localhost:27000このオプションは、kwservice でホストとポートを指定することと等価です。
--list -l 使用できる機能 (コンポーネント) を列挙します。
--projects-root <directory> -p 非デフォルト projects_root ディレクトリへの完全パスを指定します。デフォルト: <install_directory>/projects_root。指定するディレクトリは、次の条件のうちいずれかを満たしている必要があります。
  • まだ存在しません。
  • 空です。
  • 以前に作成された有効な projects_root ディレクトリです。指定済みのルート Klocwork インストールディレクトリと同じディレクトリを指定しないでください。Klocwork を projects_root ディレクトリのサブディレクトリにインストールしないでください。
重要: アップグレードしている場合、移行する古い方の projects_root ディレクトリを指定してください。
--version -v Klocwork ソフトウェアのバージョンを表示し、終了します。

サーバーコンポーネントの引数

インストールするサーバーコンポーネント (機能) 入力する引数
ライセンスサーバー LicenseServer
Klocwork サーバー KlocworkServer

PATH への Klocwork の追加

Linux では、PATH に <klocwork_install>/bin を追加することをお勧めします。そうしない場合は、コマンドを <klocwork_install>/bin から実行する必要があります。

ライセンスファイルのコピー

ライセンスファイルを次の場所にコピーします。

<projects_root>/licenses

ライセンスファイルには拡張子 .lic が必要です。

組織のライセンスサーバーの使用など、ライセンスオプションについては、ライセンスのカスタマイズを参照してください。

サーバーの起動

kwservice start でサーバーを起動します。

kwservice --projects-root <projects_root> start 

フィールド <projects_root> は、インストール時に指定した projects_root ディレクトリです。

kwservice --projects-root /space/klocwork/projects_root start 

サーバーが起動したことを示すメッセージが表示され、サーバーホスト名およびポート番号、そして projects_root へのパスが示されます。例:

Using projects root: /space/klocwork/projects_root Local Host is: serverxyz.com [13.1.1.142]
Starting License Server [started on serverxyz.com:27000] (projects root is /space/klocwork/projects_root) 
Starting Database Server [started on serverxyz.com:3306] (projects root is /space/klocwork/projects_root) 
Starting Klocwork Server [started on serverxyz.com:8080] (projects root is /space/klocwork/projects_root)

Important: Klocwork サーバーを自動的に起動するスクリプトを作成する場合は、既存のプロセスを阻害するので、スクリプト名に 'klocwork' を使用しないでください。

Klocwork Static Code Analysis へのログイン

Klocwork サーバーを開始した後、Klocwork Static Code Analysis は、インストール時に選択した Klocwork サーバーのホスト名と Klocwork サーバーのポート (例: server21:8080) の URL を使用してアクセスできます。デフォルトでは、Klocwork をインストールした人が Klocwork 管理者として設定され、プロジェクト ルート管理者の役割に割り当てられます。最初は、基本認証アクセス制御メソッドが使用されるので、パスワードなしでログインできます。たとえば、インストール時に使用したユーザー アカウントが jsmith の場合、管理者の役割で静的コード解析にログインするには、次の資格情報を使用します。
username: jsmith
password: <empty>

セキュリティと認証方法の詳細については、セキュリティとパーミッションを参照してください。