Versions Compared

Old Version 1

changes.mady.by.user IncrediBuild (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user IBJ (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section


Column


Section

The Configuration page allows you to categorize and group up information specific to different products being built with IncrediBuild.

Through the Configurations page you can group up information regarding a specific product being built, the Agents used for the build, and the build commands used. By setting up configurations you can view, categorize, and filter through any piece of information regarding any builds and Agents you may be interested in knowing more about.

If you are developing more than one product, want to view the performance for a specific group of Agent machines, or want to view the build performance for a specific set of builds that use a particular build command, you will want to setup some configurations. It is especially useful because you can then pinpoint specific problems, compare the performance between different build groups and different Agents groups.

In this section「Configuration」ページでは IncrediBuild でビルドされた様々なプロダクトや Agent を分類、グループ化することができます。

ビルドされた特定のプロダクト、ビルドに使用した Agent やコマンドに関する情報をグループ化して、「Agent」ページや「Build」ページで表示、分類、絞り込みを実行できます。

複数のプロダクトを開発している場合、特定の Agent グループや特定のビルドコマンドを使用したビルドのパフォーマンスを確認したい場合には、用途に合わせて設定を行う必要があります。問題を特定したり、ビルドグループや Agent グループごとのパフォーマンスを比較したりするのに役立ちます。


メニュー:



Table of Content Zone
locationtop

Products Configuration

Products Configuration gives you the ability to separate your builds based off of what product is being built with IncrediBuild.

プロダクトの設定

「Product 設定」タブでは IncrediBuild でビルドされたプロダクトに基づいてビルドを分類できます。

Example:

  • You are using incrediBuild to distribute processes for two different products. Let's say for Product 1, all build commands related to it contain the string "Blender" in the build command. In this case, "Blender" is the string in the build command argument that differentiates Product 1 builds from the other product builds. Now let's say that there is a second product we are building, let us call it Product 2. The unique string text "Durango" is what distinguishes the build commands for Product 2. Therefore, for Product 1, we would use the fact that the string "Blender" is a rule necessary to group up all build commands related to product 1, and for product 2, the string "Durango" is necessary as a rule to group up all builds related to Product 2.
Info

Below we will explain how you can achieve what was done in the example above. We will configure the necessary rules for Product 1. The same can be done for Product 2.

Note: This isn't limited to two products. This procedure can be done to configure as many products as you'd like.

How to Create a New Product Configuration

  1. From the Products Configuration page, click Add Product.
    • Image Removed
  2. This will open the new product page:
    • Image Removed
  3. Enter in the name of your product and give a short description if you'd like, here we will call it Product 1:
    • Image Removed
  4. Click on "Save and continue to rules."
  5. The "Product Rules" tab will open.
  6. click "Add new rule":
    • Image Removed
  7. Give your rule a name. Here we are using the String Text "blender" as that rule differentiates Product 1 from the other products.
    • Image Removed 
    • click on "Add" to implement the rule.
    • You can add as many rules as you please using the "AND" and "AND NOT" options.
  8. Click on Save Rule when you are satisfied with the rules you have set.
  9. The rules are now applied to your product.
    • You can manually scroll through and check which commands are affected by each rule in place by clicking on "Show Commands Affected by Rule."
  10. Alternatively, you can manually select which build command arguments to include from the Product Commands Tab:
  • Image Removed

Agents Configuration

From the Agents Configuration page you can group up different Agents based off the strings used in their names. Once they are grouped you can go to the Agents page and filter between the different Agent Configurations to change the graphic display to illustrate data specific to that Agent group.

Example:

  • You have Agents running on machines on your local network, but you also have Virtual Machines with Agents running on them. Let's assume every Virtual Machine with Agents on them have names that begin with "vm". you can set the string text value to "vm" as a rule and now all Agents that contain the string value "vm" in their names are grouped together under the same name.
Info

Below we will explain how you can achieve what was done in the example above. We will configure the necessary rules for all Agents running on Virtual Machines. The same can be done to configure the necessary rules for Agents running on local machines. You will just need to know the necessary key differentiators between which Agents are on VM's and which are run locally. This shouldn't be difficult to do, the names of each machine should offer some indicitation that they belong to the same group.

How to Create a New Agent Configuration

  • From the Agents tab, click on "Add Agents Group"
    • Image Removed
  • This will open the New Agent Group page.
    • Image Removed
  • Enter a name you find suitable for this group of Agents and add a description:
    • Image Removed
  • click on "Save and Continue to Rules" when you are done.
  • Next the Agent Rules Tab will open up:
    • Give your rule a name:
    • Image Removed
    •  To add exceptions or restrictions, enter a string of characters into the "String Text" field that are relevant to the names of the Agents you would like to group up.
    • In this case, we named our rule "VM" and used the string text value "vm" as our rule, because every virtual machine running an Agent begins with "vm"
  • Add as many rules as you would like, and when you are done click on "Save Rule."
  • You have now successfully created a new Agents Group.
  • Once you have created different rules you can search between them using the "Search Rule" search box. In the image below we only have one rule, so searching isn't really beneficial, but once you have numerous rules, this could come in handy.
    • Image Removed
  • Alternatively, you can click on the "Agents" tab and manually select the Agents you want to group up by pressing the "Agents" tab:
    • Image Removed
    • When you are done, click on "Associate Agents."
    • You have now successfully created an Agent Group.

    例:

    IncrediBuild を使って2つのプロダクトでビルドを分散処理しているとします。一方のプロダクト (ここでは「プロダクト1」と呼びます) に関連するビルドコマンドにはすべて文字列「Blender」が含まれているとします。この場合、文字列「Blender」をビルドコマンドの引数として使い、「プロダクト1」と他のプロダクトのビルドを区別できます。もう一方のプロダクト (ここでは「プロダクト2」と呼びます) が一意の文字列「Durango」がビルドコマンドに含まれていることによって他のプロダクトと区別できる場合、「プロダクト1」に関連するすべてのビルドコマンドには「Blender」、「プロダクト2」に関連するすべてのビルドコマンドには「Durango」という文字列をルールに設定することでそれぞれをグループ化できます。


    Info

    ルールの設定方法については以下をご覧ください。「プロダクト 1」にルールを設定する手順を解説していますが、その他のプロダクトの場合も同様の手順で設定します。

    注: 設定できるプロダクトの数に上限はありません。

    新規プロダクトの作成方法

    1. 「Product」タブの [Add Product] ボタンをクリックします。
      • Image Added
    2. 「New Product」ページ (「Product Info」タブ) が開きます。
      • Image Added
    3. プロダクト名 (ここでは「Product1」とします) を入力します。必要に応じて定義するプロダクト名の簡単な説明(Description)を入力いただけます。
      • Image Added
    4. [Save and continue to rules] をクリックします。
    5. 「Product Rules」タブが開きます。
    6. [Add new rule] をクリックします。
      • Image Added
    7. ルール名を記入します。ここでは「Blender」という文字列を使用したものを「Product1」と定義して、他のプロダクトと区別します。
      • Image Added 
      • [Add] ボタンをクリックしてルールを適用します。
      • [AND] および [AND NOT] オプションを使用してルールを詳細に設定できます。
    8. ルールの設定が完了したら [Save Rule] をクリックします。
    9. ルールがプロダクトに適用されました。
      • 「Product Rules」画面の [Show Commands Affected by Rule] をクリックするとルールが適用されたコマンドを確認できます。
    10. 「Product Command」タブで適用したいビルド コマンドを手動で選択することもできます。
    • Image Added


    Agent グループの設定

    「AGENTS」タブでは名前に含まれる文字列に基づいて Agent をグループ化できます。グループ化したAgentは、「Agent」ページのフィルターにて、本ページで定義した Agent グループを指定することによってデータを絞り込むことができます。

    例:

    ローカルネットワーク上に物理マシンとVM(仮想マシン)が混在しており、双方にAgentがインストールされていて、すべてのVM(仮想マシン)の名前が「vm」で始まるとします。文字列のルールを「vm」に設定すると、名前に「vm」が含まれる Agent が同じグループに分類されます


    Info

    注:上記のグループ設定の詳細については以下の実際の設定手順をご覧ください。クラウド上のVMとローカルマシンのエージェントを区別するのに必要なルールを設定する場合も同様です。クラウドとローカルのエージェントのマシン名の違いを設定するだけです。

    Agent グループの新規作成方法

    1. 「Agent」タブで [Add Agent Group] をクリックします。
      • Image Added
    2. 「New Agent Group」ページが開きます。
      • Image Added
    3. Agent グループの名前と説明(Description)を入力します。
      • Image Added
    4. [Save and Continue to Rules] をクリックします。
    5. 「Agent Rules」タブが開きます。
      • [Add New Rules] をクリックしてルールの名前を入力します。
      • Image Added
      •  例外や制限を追加するには、グループ化したい Agent の名前に応じた文字列を [String Text] フィールドに入力します。
      • この例では、Agent がインストールされている全ての仮想マシンが「vm」という文字列で始まるため、ルール名を「VM」に、ルールを「vm」にしています。
    6. ルールの設定が完了したら [Save Rule] をクリックします。
    7. 新しい Agent グループが作成されます。
    8. ルールは「Search Rule」検索フィールドで検索できます。以下の画像ではルールが 1 つしか設定されていませんが、ルールが多い場合には役立つ機能です。
      • Image Added
    9. 「Agent」タブをクリックしてグループ化する Agent を手動で選択することもできます。
      • Image Added
      • Agent を選択して [Accociate Agent] をクリックします。
    10. 新しい Agent グループが作成されます。



    Column
    width20


    Div
    alignleft

    Dashboard Manualダッシュボード マニュアル:

    Child pages (Children Display)
    styleh4
    pageIncrediBuild ダッシュボード



    ...