Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Add wiz to roadie #1424

Merged
merged 3 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/assets/logos/wiz/wiz-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/integrations/wiz/add-wiz-cards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/integrations/wiz/add-wiz-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 89 additions & 0 deletions content/docs/integrations/wiz/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
title: Wiz
publishedDate: '2024-11-01T11:00:00.0Z'
description: How to set up the Backstage Wiz plugin in Roadie.

humanName: Wiz
logoImage: '../../../assets/logos/wiz/wiz-logo.png'
integrationType: OSS plugin
---

## Prerequisites

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

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.

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` 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 described below.

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

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

```
wiz.io/project-id: <project_id>
```

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 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:

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

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

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

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

<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

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)

Click 'Save and reload layout'.

This will add following Wiz content as a tab

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

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)
Binary file added content/docs/integrations/wiz/issues-chart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/integrations/wiz/issues-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/integrations/wiz/severity-graph.png
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.
Binary file added content/docs/integrations/wiz/wiz-issues.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading