Skip to content

Commit

Permalink
Minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Irma12 committed Oct 31, 2024
1 parent ed353af commit ab9362d
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions content/docs/integrations/wiz/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,33 @@ integrationType: OSS plugin

To begin using Wiz plugin, you will need the following parameters:

Wiz API URL (API Endpoint URL)
Wiz Token URL
Client ID and Client Secret
- Wiz API URL (API Endpoint URL)
- Wiz Token URL
- Client ID and Client Secret

In order to retrieve those, you can read official documentation (https://win.wiz.io/reference/prerequisites) where it is described how to obtain the values.

### Setting up the plugin:

#### 1: Store the credentials in Roadie.

Visit `https://<tenant-name>.roadie.so/administration/settings/secrets` and enter the Client ID value from above into `WIZ_CLIENT_ID`. Enter Client Secret into `WIZ_CLIENT_SECRET` on the same page.
Visit `https://<tenant-name>.roadie.so/administration/settings/secrets` and enter the Client ID value from above into `WIZ_CLIENT_ID`.

Enter Client Secret into `WIZ_CLIENT_SECRET` on the same page.

These will be used to make API call for generating API Token needed for other API calls.

#### 2: Configure the plugin.

Visit `https://<tenant-name>.roadie.so/administration/wiz` enable Wiz by clicking on 'enabled' checkbox.
Visit `https://<tenant-name>.roadie.so/administration/wiz` and enable Wiz by clicking on 'enabled' checkbox.

At this point you will be required to enter Wiz API Url and Wiz Token URL.

Wiz link is optional and will be used in to navigate to your Wiz instance in EntityIssuesWidget card, which will be shown below.
Wiz link is optional and will be used in to navigate to your Wiz instance in EntityIssuesWidget card, which will be described below.

### 3: Add the annotation to Backstage Component
#### 3: Add the annotation to Backstage Component

Add following annotations to relevant catalog-info.yaml files
Add following annotations to relevant catalog-info.yaml files.

```
wiz.io/project-id: <project_id>
Expand All @@ -46,29 +48,29 @@ Project id can be found in Wiz projects dashboard.

### 4. Add Wiz plugin widgest/cards to your Overview page

Navigate to the component you have added the annotation for and [add the Wiz cards to the overview page](/docs/getting-started/configuring-backstage-plugins/#step-1-add-the-ui-component).
Navigate to the component you have added the annotation and proceed to [add the new cards to the Overview page](/docs/getting-started/configuring-backstage-plugins/#step-1-add-the-ui-component).

Select card you would like to add to your page from the list

![add-wiz-cards.png](./add-wiz-cards.png)

Currently you can select from these cards:

EntityIssuesWidget which shows the information about number of different severity Open and Resolved issues.
<b>EntityIssuesWidget</b> which shows the information about number of different severity Open and Resolved issues.

![issues-widget.png](./issues-widget.png)

EntityIssuesChart which provides graphical representation of resolved vs open issues over last 6 months.
<b>EntityIssuesChart</b> which provides graphical representation of resolved vs open issues over last 6 months.

![issues-chart.png](./issues-chart.png)

EntitySeverityChart which provides graphical representation of all issues over last 6 months, indicated by severity.
<b>EntitySeverityChart</b> which provides graphical representation of all issues over last 6 months, indicated by severity.

![severity-graph.png](./severity-graph.png)

### 5. Add Wiz plugin tab to your component

Using plus icon select Wiz from the dropdown as shown below
Clicking plus icon from the tab will open a form in which you will have an option to select Wiz from the dropdown as shown below

![add-wiz-tab.png](./add-wiz-tab.png)

Expand All @@ -81,3 +83,7 @@ This will add following Wiz content as a tab
Expanding the view will open more details about specific Control

![wiz-expanded-issues.png](./wiz-expanded-issues.png)

## References

- [Wiz API docs](https://win.wiz.io/reference/prerequisites)

0 comments on commit ab9362d

Please sign in to comment.