Skip to content

Commit

Permalink
Merge pull request #158 from jbokyung2/master
Browse files Browse the repository at this point in the history
feat: update user guide for [Asset Inventory > Collector]
  • Loading branch information
jbokyung2 authored Aug 24, 2023
2 parents 76bc5de + f632c8f commit 2971883
Show file tree
Hide file tree
Showing 66 changed files with 118 additions and 94 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 37 additions & 28 deletions content/en/docs/guides/asset-inventory/collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,16 @@ For detailed information on this, see [here](/docs/guides/asset-inventory/servic
![collector-create-button](/docs/guides/asset-inventory/collector-img/collector-create-button_en.png)

(2) Follow the steps on the "Create New Collector" page.

(2-1) On the Plugin List page, find a required collector plugin and click the [Select] button.

![collector-plugin-lists](/docs/guides/asset-inventory/collector-img/collector-create-step1_en.png)
![collector-plugin-lists](/docs/guides/asset-inventory/collector-img/collector-create-step1_2_en.png)

(2-2) Enter the name and version of the collector and click the [Continue] button.

(Depending on the collector, it can be required to select a specific cloud provider.)

![collector-plugin-create](/docs/guides/asset-inventory/collector-img/collector-create-step2_en.png)
![collector-plugin-create](/docs/guides/asset-inventory/collector-img/collector-create-step2_2_en.png)

{{<alert title="Version and auto upgrade">}}
Version refers to the version of the previously selected collector plugin, which can be chosen by disabling auto upgrade. In this case, the data is always collected with the specified version of the plugin.
Expand All @@ -60,12 +62,12 @@ On the other hand, if you enable auto upgrade, your data will always be collecte

(2-3-2) Additional Options: Depending on the collector, there may or may not be additional options to select.

![collector-plugin-create](/docs/guides/asset-inventory/collector-img/collector-create-step3_en.png)
![collector-plugin-create](/docs/guides/asset-inventory/collector-img/collector-create-step3_2_en.png)

(2-4) You can set up a schedule to automatically perform data collection (optional).
Once you have completed all the steps, click the [Create New Collector] button to finalize the collector creation.

![collector-plugin-create](/docs/guides/asset-inventory/collector-img/collector-create-step4_en.png)
![collector-plugin-create](/docs/guides/asset-inventory/collector-img/collector-create-step4_2_en.png)

(2-5) Once collector is created, you can collect data immediately.

Expand All @@ -79,7 +81,7 @@ You can view a list of all collectors that have been created on the collector pa

**Advanced search** allows you to filter the list by elaborate criteria. For a detailed explanation, see [here](/docs/guides/advanced/search/).

![collector-list-inquiry](/docs/guides/asset-inventory/collector-img/collector-list_en.png)
![collector-list-inquiry](/docs/guides/asset-inventory/collector-img/collector-list_2_en.png)

<br>

Expand All @@ -89,31 +91,31 @@ You can view a list of all collectors that have been created on the collector pa

(1-1) Select a specific collector card from the list to navigate to its detailed page.

![collector-list-select](/docs/guides/asset-inventory/collector-img/collector-list-select_en.png)
![collector-list-select](/docs/guides/asset-inventory/collector-img/collector-list-select2_en.png)

(1-2) You can view the basic information, schedule, additional options, and attached service accounts.

![collector-detail-info-tab](/docs/guides/asset-inventory/collector-img/collector-detail_en.png)
![collector-detail-info-tab](/docs/guides/asset-inventory/collector-img/collector-detail2_en.png)

<br>

### (2) Edit or Delete

(2-1) Click on the [Edit] icon at the top and modify the collector name.

![collector-detail-edit](/docs/guides/asset-inventory/collector-img/collector-detail-name-edit_en.png)
![collector-detail-edit](/docs/guides/asset-inventory/collector-img/collector-detail-name-edit2_en.png)

(2-2) If you need to edit details such as base information, schedule, additional options or service accounts, click the [Edit] button in each area.

![collector-detail-edit](/docs/guides/asset-inventory/collector-img/collector-detail-edit_01_en.png)
![collector-detail-edit](/docs/guides/asset-inventory/collector-img/collector-detail-edit_01_2_en.png)

(2-3) After making the changes, click the [Save Changes] button to complete the modification.

![collector-detail-edit](/docs/guides/asset-inventory/collector-img/collector-detail-edit_02_en.png)
![collector-detail-edit](/docs/guides/asset-inventory/collector-img/collector-detail-edit_02_2_en.png)

(2-4) If you need to delete a collector, click the [Trash] icon on the top.

![collector-detail-delete](/docs/guides/asset-inventory/collector-img/collector-detail-name-delete_en.png)
![collector-detail-delete](/docs/guides/asset-inventory/collector-img/collector-detail-name-delete_2_en.png)

<br>

Expand All @@ -123,13 +125,15 @@ After creating a collector, you can still modify the automated data collection s

(1) In the collector list page, you can enable or disable automated data collection for each collector by using the schedule toggle button(Switch On/Off) in the collector card section. You can quickly set and modify the frequency by clicking the [Edit] button.

![collector-edit-schedule](/docs/guides/asset-inventory/collector-img/collector-edit-schedule_01_en.png)
![collector-edit-schedule](/docs/guides/asset-inventory/collector-img/collector-edit-schedule_01_2_en.png)

![collector-edit-schedule](/docs/guides/asset-inventory/collector-img/collector-edit-schedule_02_en.png)
![collector-edit-schedule](/docs/guides/asset-inventory/collector-img/collector-edit-schedule_02_2_en.png)

![collector-edit-schedule](/docs/guides/asset-inventory/collector-img/collector-edit-schedule_03_2_en.png)

(2) You can also navigate to the detailed page of each collector and change the schedule.

![collector-edit-schedule](/docs/guides/asset-inventory/collector-img/collector-detail-schedule_en.png)
![collector-edit-schedule](/docs/guides/asset-inventory/collector-img/collector-detail-schedule_2_en.png)

<br>

Expand All @@ -149,9 +153,23 @@ Data collection works in two ways:

Collector needs account information from a [Provider](/docs/guides/asset-inventory) for data collection, which is registered through [Service account](/docs/guides/asset-inventory/service-account).

(1) On the collector list page, move the mouse cursor over the collector card for which you want to collect data.
(1) Click on [Collect Data]

(Collector list Page)
Hover over the collector card area for data collection, and then click the [Collect Data] button.

![collector-collect-data](/docs/guides/asset-inventory/collector-img/collector-collect-data-01_en.png)

(Collector Detail Page)
Click the [Collect Data] button located in the top right corner of the detailed page.

![collector-collect-data](/docs/guides/asset-inventory/collector-img/collector-collect-data-02_en.png)

![collector-collect-data](/docs/guides/asset-inventory/collector-img/collector-edit-schedule_01_en.png)
![collector-collect-data](/docs/guides/asset-inventory/collector-img/collector-collect-data-03_en.png)

<br>

(2) Proceed with data collection.

(2) Whether or not the collector has completed a data collection can be checked in [Collector history](/docs/guides/asset-inventory/collector/#check-data-collection-history). You can click the [View details] link of a selected collector to go to that page.

Expand All @@ -165,7 +183,7 @@ When collecting data with a collector, you may only collect data from a specific

(2) You can find the list of attached service accounts on the bottom of detail page.

![collector-service-account](/docs/guides/asset-inventory/collector-img/collector-detail-service-account_en.png)
![collector-service-account](/docs/guides/asset-inventory/collector-img/collector-detail-service-account2_en.png)

{{<alert title="Service account">}}
[Service account](/docs/guides/asset-inventory/service-account) has access information for the provider account required for data collection.
Expand All @@ -186,19 +204,10 @@ You can check your data collection history on the **Collector history** page.

You can go to the collector history page by clicking the [Collector history] button at the top of the collector page.

If you want to check only the data collection history of a specific collector, you can go to where you can check that information by clicking the [View details] button from a list of collectors.

![collector-history-at-table](/docs/guides/asset-inventory/collector-img/collector-history-at-table.png)

### Viewing data collection list

Through the chart at the top of the collector history page, you can quickly check data collection status by date.

The list at the bottom displays a list of data collections that meet the criteria for an advanced search and status filter. For a detailed description of advanced search, see [here](/docs/guides/advanced/search/).
![collector-history-at-table](/docs/guides/asset-inventory/collector-img/collector-collect-history01_en.png)

For items in the process of data collection, you can check the collection status through the status bar of the job progress field.
![collector-history-at-table](/docs/guides/asset-inventory/collector-img/collector-collect-history02_en.png)

![collector-history-full-page](/docs/guides/asset-inventory/collector-img/collector-history-full-page.png)

### Checking the details of data collection history

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
78 changes: 42 additions & 36 deletions content/ja/docs/guides/asset-inventory/collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,16 @@ description: >
![collector-create-button](/ja/docs/guides/asset-inventory/collector-img/collector-create-button_ja.png)

(2) 「新しいコレクターを作成する‌」ページの手順に従ってください。

(2-1) 「プラグインリスト」ページで必要なコレクタープラグインを見つけ、[選択]ボタンをクリックしてください。

![collector-plugin-lists](/ja/docs/guides/asset-inventory/collector-img/collector-create-step1_ja.png)
![collector-plugin-lists](/ja/docs/guides/asset-inventory/collector-img/collector-create-step1_2_ja.png)

(2-2) コレクターの名前とバージョンを入力し、[次へ]ボタンをクリックしてください。

(コレクターによっては、特定のクラウドプロバイダーを選択する必要がある場合があります。)

![collector-plugin-create](/ja/docs/guides/asset-inventory/collector-img/collector-create-step2_ja.png)
![collector-plugin-create](/ja/docs/guides/asset-inventory/collector-img/collector-create-step2_2_ja.png)

{{<alert title="バージョンと自動アップグレード">}}
"バージョン"とは、以前に選択したコレクタープラグインのバージョンを指します。これは自動アップグレードを無効にして選択することができます。この場合、データは常に指定されたプラグインのバージョンで収集されます。
Expand All @@ -60,12 +62,12 @@ description: >

(2-3-2) 追加オプション:コレクターによっては、選択する追加オプションがある場合とない場合があります。

![collector-plugin-create](/ja/docs/guides/asset-inventory/collector-img/collector-create-step3_ja.png)
![collector-plugin-create](/ja/docs/guides/asset-inventory/collector-img/collector-create-step3_2_ja.png)

(2-4) データ収集を自動的に行うためのスケジュールを設定することができます(オプション)。
すべての手順を完了したら、[新しいコレクターを作成]ボタンをクリックして、コレクターの作成を確定してください。

![collector-plugin-create](/ja/docs/guides/asset-inventory/collector-img/collector-create-step4_ja.png)
![collector-plugin-create](/ja/docs/guides/asset-inventory/collector-img/collector-create-step4_2_ja.png)

(2-5) コレクターが作成されると、すぐにデータを収集することができます。

Expand All @@ -80,7 +82,7 @@ description: >

**詳細検索**を利用すると、詳細条件で一覧をフィルタリングできます。これに関する詳細については、[こちら](/ja/docs/guides/advanced/search/)をご参考にしてください。

![collector-list-inquiry](/ja/docs/guides/asset-inventory/collector-img/collector-list_ja.png)
![collector-list-inquiry](/ja/docs/guides/asset-inventory/collector-img/collector-list_2_ja.png)

<br>

Expand All @@ -90,31 +92,31 @@ description: >

(1-1) リストから特定のコレクターカードを選択し、そのコレクターの詳細ページに移動します。

![collector-list-select](/ja/docs/guides/asset-inventory/collector-img/collector-list-select_ja.png)
![collector-list-select](/ja/docs/guides/asset-inventory/collector-img/collector-list-select2_ja.png)

(1-2) 基本情報、スケジュール、追加オプション、関連サービスアカウントを表示できます。

![collector-detail-info-tab](/ja/docs/guides/asset-inventory/collector-img/collector-detail_ja.png)
![collector-detail-info-tab](/ja/docs/guides/asset-inventory/collector-img/collector-detail2_ja.png)

<br>

### (2) Edit or Delete

(2-1) 上部の[編集]アイコンをクリックしてコレクター名を変更します。

![collector-detail-edit](/ja/docs/guides/asset-inventory/collector-img/collector-detail-name-edit_ja.png)
![collector-detail-edit](/ja/docs/guides/asset-inventory/collector-img/collector-detail-name-edit2_ja.png)

(2-2) 基本情報、スケジュール、追加オプション、サービスアカウントなどの詳細を編集する 경우、各領域の[編集]ボタンをクリックしてください。

![collector-detail-edit](/ja/docs/guides/asset-inventory/collector-img/collector-detail-edit_01_ja.png)
![collector-detail-edit](/ja/docs/guides/asset-inventory/collector-img/collector-detail-edit_01_2_ja.png)

(2-3) After making the changes, click the [Save Changes] button to complete the modification.

![collector-detail-edit](/ja/docs/guides/asset-inventory/collector-img/collector-detail-edit_02_ja.png)
![collector-detail-edit](/ja/docs/guides/asset-inventory/collector-img/collector-detail-edit_02_2_ja.png)

(2-4) 変更を行った後、変更を完了するために[変更を保存]ボタンをクリックしてください。

![collector-detail-delete](/ja/docs/guides/asset-inventory/collector-img/collector-detail-name-delete_ja.png)
![collector-detail-delete](/ja/docs/guides/asset-inventory/collector-img/collector-detail-name-delete_2_ja.png)

<br>

Expand All @@ -124,13 +126,15 @@ description: >

(1) コレクターリストページでは、各コレクターの自動データ収集をコレクターカードセクションのスケジュール切り替えボタン(オン/オフ)を使用して有効化または無効化できます。[編集]ボタンをクリックして頻度を迅速に設定および変更することもできます。

![collector-edit-schedule](/ja/docs/guides/asset-inventory/collector-img/collector-edit-schedule_01_ja.png)
![collector-edit-schedule](/ja/docs/guides/asset-inventory/collector-img/collector-edit-schedule_01_2_ja.png)

![collector-edit-schedule](/ja/docs/guides/asset-inventory/collector-img/collector-edit-schedule_02_2_ja.png)

![collector-edit-schedule](/ja/docs/guides/asset-inventory/collector-img/collector-edit-schedule_02_ja.png)
![collector-edit-schedule](/ja/docs/guides/asset-inventory/collector-img/collector-edit-schedule_03_2_ja.png)

(2) また、各コレクターの詳細ページに移動してスケジュールを変更することもできます。

![collector-edit-schedule](/ja/docs/guides/asset-inventory/collector-img/collector-detail-schedule_ja.png)
![collector-edit-schedule](/ja/docs/guides/asset-inventory/collector-img/collector-detail-schedule_2_ja.png)

<br>

Expand All @@ -150,11 +154,26 @@ description: >

コレクターはがデータを収集するためには、[プロバイダ](/ja/docs/guides/asset-inventory)のアカウント情報を必要です。アカウント情報は、[サービスアカウント](/ja/docs/guides/asset-inventory/service-account)を通じて登録されます。

(1) コレクターリストページで、データを収集したいコレクターカードの上にマウスカーソルを移動してください。
(1) データ収集

(コレクターリストページ)
データ収集のためにコレクターカードエリアにカーソルを合わせ、その後 [データ収集] ボタンをクリックしてください。

![collector-collect-data](/ja/docs/guides/asset-inventory/collector-img/collector-collect-data-01_ja.png)

(コレクター詳細ページ)
詳細ページの右上にある[データ収集]ボタンをクリックします。

![collector-collect-data](/ja/docs/guides/asset-inventory/collector-img/collector-collect-data-02_ja.png)

![collector-collect-data](/ja/docs/guides/asset-inventory/collector-img/collector-collect-data-03_ja.png)

<br>


![collector-collect-data](/ja/docs/guides/asset-inventory/collector-img/collector-edit-schedule_01_ja.png)
(2) データ収集を進めます

(2) 当該コレクターのデータ収集の完了状況は、[コレクター履歴](/ja/docs/guides/asset-inventory/collector/#データ収集スケジュールを設定する)で確認できます。選択したコレクターの[詳細を見る]リンクをクリックすると、当該ページへ移動します。
当該コレクターのデータ収集の完了状況は、[コレクター履歴](/ja/docs/guides/asset-inventory/collector/#データ収集スケジュールを設定する)で確認できます。選択したコレクターの[詳細を見る]リンクをクリックすると、当該ページへ移動します。

<br>

Expand All @@ -166,7 +185,7 @@ description: >

(2) 詳細ページの一番下に、関連付けられたサービスアカウントの一覧が表示されます。

![collector-service-account](/ja/docs/guides/asset-inventory/collector-img/collector-detail-service-account_ja.png)
![collector-service-account](/ja/docs/guides/asset-inventory/collector-img/collector-detail-service-account2_ja.png)

{{<alert title="サービスアカウント">}}
[サービスアカウント](/ja/docs/guides/asset-inventory/service-account)は、データ収集に必要なプロバイダアカウントに対するアクセス情報を持っています。
Expand All @@ -180,29 +199,16 @@ description: >

<br>

## データ収集スケジュールを設定する

周期的にリソースを収集するようコレクターのスケジュールを設定することができます。

(1) コレクター一覧でスケジュールを設定するコレクターを選択します。

(2) 下にある[スケジュール]タブを選択します。

ここでスケジュール一覧を確認したり、追加・変化・削除を実行できます。

![collector-schedule-tab](/ja/docs/guides/asset-inventory/collector-img/collector-schedule-tab.png)

<br>
## データ収集履歴の確認

### データ収集リストを照会する
**コレクター履歴** ページでデータ収集履歴を確認できます。

コレクター履歴ページの画面上部にあるチャートから、日別データ収集状況を速やかに確認できます
コレクターページの上部にある[コレクター履歴]ボタンをクリックしてコレクター履歴ページに移動できます

画面下部には、詳細検索と状態フィルター条件と一致するデータ収集リストが表示されます。詳細検索に関する詳細については、[こちら](/ja/docs/guides/advanced/search/)をご参考にしてください。
![collector-history-at-table](/ja/docs/guides/asset-inventory/collector-img/collector-collect-history01_ja.png)

データを収集中の項目は、Job Progressフィールドのステータスバーで収集状況を確認できます。
![collector-history-at-table](/ja/docs/guides/asset-inventory/collector-img/collector-collect-history02_ja.png)

![collector-history-full-page](/ja/docs/guides/asset-inventory/collector-img/collector-history-full-page.png)

### データ収集履歴の詳細情報を確認する

Expand Down
Loading

0 comments on commit 2971883

Please sign in to comment.