Hyvop user guide#
For the people who use Hyvop once it is installed: who connect an account, read findings, say who owns a resource, write policies and approve plans. The people who install and run it have the administrator guide.
One page for each part of the product. They follow the order in which a new install fills up.
| Page | What it is for |
|---|---|
| connect-and-collect.md | Connect a cloud account, follow the first collection, read the "Getting started" checklist and the "Ingestion" card |
| findings.md | What a finding is, the states it goes through, what each detector looks at |
| ownership.md | Who answers for a resource: roles, how an owner is found, what "validated" means, what is sent to a model |
| policies.md | Write a rule in a sentence, confirm it, and what a policy does |
| remediation.md | The plan, who must approve it and in which order. In this edition nothing is carried out |
| audit.md | What Hyvop records, and what it does not record yet |
| ai.md | The model: off by default, which one is used, budgets and usage |
| dashboards.md | Dashboards and their charts, parameters, adding a chart with AI, pinning to the sidebar |
| users.md | Invite people, give them a role, switch an account off or delete it |
| settings.md | Your profile and password, API keys, the mail relay, the model's configuration |
| ticketing.md | All Tickets and Destinations: locked in the Community Edition, and what they show where they are on |
The API is described in api.md.
How these pages name things#
A screen is named by its menu label, then its route, for example Detection > Active (/inefficiencies). The menu
groups are Dashboard, Detection, Ownership, Remediation, Governance, Data Sources and Settings. Some entries are for
administrators only, and some are locked in the Community Edition; a page says so where it matters.
What the product does not do yet is said in the page, in a line that begins with "Not in this edition" or "Not built".