On this page
Hyvop Community guide#
For the person who installs and runs Hyvop on a Kubernetes cluster, and for the people who then use it.
This is the guide of the 0.9.0 beta. Read release-criteria.md ("Known limitations of the 0.9.0 beta") before you rely on a figure. If you run the Enterprise Edition, the Enterprise page says what differs and where its own guide is.
Reading order#
Follow the pages in this order the first time. Each one assumes the ones before it.
| Step | Page | What it is for |
|---|---|---|
| 1 | editions.md | What the Community Edition includes and where it stops: one cloud account, 1,000 resources per scan, 3 policies, 30 days |
| 2 | install.md | Install the chart, open the UI, create the first administrator, turn on HTTPS |
| 3 | connect-aws.md | Connect an AWS account: the role and its policy, access keys, the cost report bucket, demo mode |
| 3 | connect-azure.md | Connect an Azure subscription: the app registration, its roles, the cost export |
| 3 | connect-gcp.md | Connect a GCP project: the service account and its roles |
| 4 | user/README.md | The user guide, once data arrives: connect and collect, findings, ownership, policies, remediation, audit, the model |
| 5 | models.md | Turn the AI features on: the install's model, the one an organisation brings, what is sent to it |
| 6 | mail.md | Give Hyvop a mail relay, and approve a remediation plan from an e-mail |
| 7 | approvals.md | Who approves a remediation plan, in which order, and what happens when someone does not answer |
Then, to run it:
| Page | What it is for |
|---|---|
| configuration.md | Every value of the chart: type, default, meaning |
| backup-and-restore.md | What holds state, what to copy, how to get back |
| upgrade.md | Upgrade and roll back; what the first release changes |
| troubleshooting.md | The first-run checklist, the ingestion card, and the failures seen most |
| air-gapped.md | An install with no internet access: the bundle, the load script, every outbound call and its switch |
And, to look things up:
| Page | What it is for |
|---|---|
| api.md | Every route of the Hyvop API and who may call it |
| release-criteria.md | The known limitations of the 0.9.0 beta |
| enterprise.md | What differs in the Enterprise Edition, and where its guide is |
The user guide#
For the people who use the product, not those who run it: user/README.md has one page for each part of the product, in the order a new install fills up:
- connect-and-collect.md: connect a cloud account, follow the first collection
- findings.md: what a finding is and what each detector looks at
- ownership.md: who answers for a resource
- policies.md: write a rule in a sentence and see what it does
- remediation.md: the plan, and who must approve it
- audit.md: what Hyvop records
- ai.md: the model, budgets and usage
- dashboards.md: dashboards, charts, parameters, pinning to the sidebar
- users.md: invite people, roles, switch an account off
- settings.md: your profile, API keys, the mail relay, the model's configuration
- ticketing.md: All Tickets and Destinations, which this edition does not have
Licence#
Hyvop is proprietary software. The Community edition is free to use. The source code is not published.
Getting help#
Start with troubleshooting.md.
- Community has this documentation and no support channel.
- Paid editions have support as described on the pricing page of hyvop.com. To buy one, or to ask before you do, write to
sales@hyvop.com; for anything else,contact@hyvop.com. - Security reports go to
security@hyvop.com.