Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
rbren committed May 11, 2023
1 parent b0d0118 commit 073fe7f
Show file tree
Hide file tree
Showing 17 changed files with 65 additions and 65 deletions.
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ Fairwinds Insights runs across the entire development lifecycle, from CI to Admi

The platform enables DevOps teams to find and prevent configuration problems as applications move
from development to production. It provides out-of-the-box
[integrations into CI/CD workflows](/features/infrasturcture-as-code-scanning),
an [admission controller](/features/admission-controller)
[integrations into CI/CD workflows](features/infrasturcture-as-code-scanning),
an [admission controller](features/admission-controller)
for enforcing custom policies (using Polaris or Open Policy Agent) at pre-deployment,
and automation for running
[Kubernetes auditing tools](/features/in-cluster-scanning).
[Kubernetes auditing tools](features/in-cluster-scanning).
Findings and recommendations are stored in a single location, enabling operators to gain visibility
and control over multiple Kubernetes clusters, track and prioritize issues,
and monitor the security and cost of Kubernetes workloads.

Learn more about
[installing Fairwinds Insights](/features/in-cluster-scanning),
features like [Slack notifications](/features/integrations),
and our [supported plugins](/technical-details/reports/polaris).
[installing Fairwinds Insights](features/in-cluster-scanning),
features like [Slack notifications](features/integrations),
and our [supported plugins](technical-details/reports/polaris).

<!-- Begin boilerplate -->
## Join the Fairwinds Open Source Community
Expand Down
6 changes: 3 additions & 3 deletions docs/features/admission-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ You should see a message saying:
Error from server (Privilege escalation should not be allowed: Failure: true): error when creating "STDIN": admission webhook "insights.fairwinds.com" denied the request: Privilege escalation should not be allowed: Failure: true
```

For further tuning please refer to [Admission Controller Configuration.](/features/admission-controller)
For further tuning please refer to [Admission Controller Configuration.](features/admission-controller)

## Configuration
### Helm
Expand Down Expand Up @@ -118,7 +118,7 @@ insights-admission:
### Report Types
The Admission Controller currently runs the following report types:
* Polaris - checks for security and best practices
* [OPA](/features/policies) - apply custom policies to resources
* [OPA](features/policies) - apply custom policies to resources
* Pluto - detects Kubernetes resources that have been deprecated or removed

To enable or disable a particular report:
Expand All @@ -131,7 +131,7 @@ To enable or disable a particular report:

### Customize Policies
To customize the severity or whether a Policy should block an admission request, you can use the
[Policy Configuration](/features/policies) feature.
[Policy Configuration](features/policies) feature.

## Troubleshooting
To troubleshoot the Admission Controller, you can
Expand Down
2 changes: 1 addition & 1 deletion docs/features/automation-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Insights also comes with several templates for Automation Rules which you can mo

### Using the Insights CLI
To manage rules in an infrastructure-as-code repository, you can use the Insights command-line interface (CLI).
Check out [Automation Rules with the CLI](/features/automation-rules) for more information.
Check out [Automation Rules with the CLI](features/automation-rules) for more information.

## Writing Automation Rules
Insights Automation Rules are written in JavaScript. The main input is `ActionItem`, which contains
Expand Down
4 changes: 2 additions & 2 deletions docs/features/in-cluster-scanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ meta:
The Insights Agent runs inside your cluster and sends back data to Fairwinds Insights. The data is then used to indicate specific security, reliability and efficiency issues in the cluster. These issues are called `Action Items` in Insights.

The Insights Agent comes with several different open source reporting tools, each of which can be
configured independently using the [Install Hub.](/features/in-cluster-scanning)
To read more about the different report types, see the [Reports Section](/technical-details/reports/polaris).
configured independently using the [Install Hub.](features/in-cluster-scanning)
To read more about the different report types, see the [Reports Section](technical-details/reports/polaris).
## Installation
### Install Hub
When you create a cluster, you'll be taken to the `Install Hub` page for the cluster. To install the Insights Agent:
Expand Down
16 changes: 8 additions & 8 deletions docs/features/infrastructure-as-code-scanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Insights will run the following report types in CI:
### Choosing Insights CI or Auto-Scan

There are two options for this feature:
- **Auto-Scan**: The easiest option is using our Auto-Scan feature. Auto-Scan uses a GitHub integration to enable infrastructure-as-code scanning across multiple repositories without having to configure individual CI pipelines. This option will use the Fairwinds Insights SaaS infrastructure to run the checks and is recommended for organizations using Github. Currently, Auto-Scan is only able to scan container images from public repositories; for private image scanning, please use the [**Insights CI Script**](/features/infrasturcture-as-code-scanning) instead.
- **Auto-Scan**: The easiest option is using our Auto-Scan feature. Auto-Scan uses a GitHub integration to enable infrastructure-as-code scanning across multiple repositories without having to configure individual CI pipelines. This option will use the Fairwinds Insights SaaS infrastructure to run the checks and is recommended for organizations using Github. Currently, Auto-Scan is only able to scan container images from public repositories; for private image scanning, please use the [**Insights CI Script**](features/infrasturcture-as-code-scanning) instead.
- **Manual Scan**: Recommended for organizations not using Github, this option involves executing our Insights CI script as part of your CI/CD pipelines. In addition, running Insights in your CI/CD pipeline allows you to optionally pull private images and scan them.

| | **Auto-Scan** | **Insights CI Integration** |
Expand Down Expand Up @@ -148,7 +148,7 @@ The Insights CI integration relies on the `fairwinds-insights.yaml` configuratio

Specifically, the `fairwinds-insights.yaml` file must provide the location of configuration files and images you would like to scan.

> If you are looking to setup Insights CI for the first time, please visit our [Insights CI Installation documentation](/features/infrasturcture-as-code-scanning).
> If you are looking to setup Insights CI for the first time, please visit our [Insights CI Installation documentation](features/infrasturcture-as-code-scanning).

### Configuration Options for fairwinds-insights.yaml
Expand All @@ -169,7 +169,7 @@ You can configure the Insights CI integration to exit with a non-zero exit code,

When `options.setExitCode` is set to `true`, there are two reasons why an Action Item may cause a CI job to fail:
- The severity of that Action Item exceeds the value in `options.severityThreshold`. Every Action Item has a severity value between 0 and 1, with 1 being "Critical". By default, an Action Item must have a severity of at least 0.7 ("High").
- The Policy is configured to "always fail" when the Action Item is detected in a scan, regardless of that Action Item's severity. Learn more about this in the [Policy Configurator](/features/policies) section.
- The Policy is configured to "always fail" when the Action Item is detected in a scan, regardless of that Action Item's severity. Learn more about this in the [Policy Configurator](features/policies) section.

Here is an example:
```
Expand Down Expand Up @@ -363,14 +363,14 @@ Make sure the provide version is [SemVer](https://semver.org/) compliant

#### Customizing Auto-Scan Using fairwinds-insights.yaml
Sometimes users may want to customize Auto-Scan behaviors for a specific repo. To do this, you can create a `fairwinds-insights.yaml` file at the root of your git repo and customize things like:
- [Configuring specific exemptions](/features/infrasturcture-as-code-scanning#managing-exemptions)
- [Resolving Helm chart errors due to missing values](/features/infrasturcture-as-code-scanning#helm-chart-with-invalid-or-missing-values-file)
- [Scanning additional container images not present in your manifests](/features/infrasturcture-as-code-scanning#scanning-container-images)
- [Configuring specific exemptions](features/infrasturcture-as-code-scanning#managing-exemptions)
- [Resolving Helm chart errors due to missing values](features/infrasturcture-as-code-scanning#helm-chart-with-invalid-or-missing-values-file)
- [Scanning additional container images not present in your manifests](features/infrasturcture-as-code-scanning#scanning-container-images)
- Enabling/disabling specific scanning tools

> NOTE: When you add a `fairwinds-insights.yaml` file to an Auto-Scan enabled repository, automatic discovery of YAML manifests, Helm charts, and docker images is disabled. You must specify the location of these artifacts within the `fairwinds-insights.yaml` file.
To customize Auto-Scan behavior, please review the [configuration options for `fairwinds-insights.yaml`](/features/infrasturcture-as-code-scanning).
To customize Auto-Scan behavior, please review the [configuration options for `fairwinds-insights.yaml`](features/infrasturcture-as-code-scanning).

## Troubleshooting

Expand Down Expand Up @@ -454,6 +454,6 @@ There are two ways to fix this problem:

OR

- Add a `fairwinds-insights.yaml` to the root of your repository to specify the location of a different values file with the `image.tag` field (or whatever field is not working). Or, you may provide an array of key/value pairs for Insights to use. [Please review this documentation for specifying the location YAML manifests and Helm charts](/features/infrasturcture-as-code-scanning#scanning-configuration-manifests).
- Add a `fairwinds-insights.yaml` to the root of your repository to specify the location of a different values file with the `image.tag` field (or whatever field is not working). Or, you may provide an array of key/value pairs for Insights to use. [Please review this documentation for specifying the location YAML manifests and Helm charts](features/infrasturcture-as-code-scanning#scanning-configuration-manifests).
>NOTE: When you add a `fairwinds-insights.yaml` file to an Auto-Scan enabled repository, automatic discovery of YAML manifests, Helm charts, and docker images is disabled. This is why you must specify the location of these artifacts within the `fairwinds-insights.yaml` file.
6 changes: 3 additions & 3 deletions docs/features/insights-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,17 @@ passing in the name of your organization.
## Syncing
### Policy Configuration
You can use the Insights CLI to manage the configuration of Policies.
Be sure to first read the [Insights CLI documentation](/features/insights-cli) which covers installation and preparation.
Be sure to first read the [Insights CLI documentation](features/insights-cli) which covers installation and preparation.

Check out the [Policy Configurator](/features/policies) documentation on use cases for configuring Policies.
Check out the [Policy Configurator](features/policies) documentation on use cases for configuring Policies.

```bash
insights-cli push settings
```

### Custom OPA Policies
You can use the Insights CLI to manage OPA policies and validate OPA policies offline.
Be sure to first read the [Insights CLI documentation](/features/insights-cli) which covers installation and preparation.
Be sure to first read the [Insights CLI documentation](features/insights-cli) which covers installation and preparation.

#### Pushing to Insights
When pushing OPA policies to Insights, the CLI expects a directory structure like the following:
Expand Down
10 changes: 5 additions & 5 deletions docs/features/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The linked account will show as the creator of any tickets created via Insights
1. Visit your organization's `Settings > Integration` page
2. Hover over `Jira` and click `Add Integration`
3. Once you have connected Jira to Insights, you can create tickets for Action Items manually or
[automatically using Automation Rules](/features/automation-rules#tickets)
[automatically using Automation Rules](features/automation-rules#tickets)

### Jira Tickets and Action Items
If an Action Item that is associated with a Jira ticket is marked as `Resolved` or `Fixed`,
Expand All @@ -73,7 +73,7 @@ The linked account will show as the creator of any Work Items created via Insigh
1. Visit your organization's `Settings > Integration` page
2. Hover over `Azure DevOps` and click `Add Integration`
3. Once you have connected Azure DevOps to Insights, you can create Work Items for Action Items manually or
[automatically using Automation Rules](/features/automation-rules#tickets)
[automatically using Automation Rules](features/automation-rules#tickets)

### Azure DevOps Work Items and Action Items
If an Action Item that is associated with an Azure DevOps work item is marked as `Resolved` or `Fixed`,
Expand All @@ -98,14 +98,14 @@ To set up Slack notifications:
3. Once you have connected Slack to Insights, you can choose which channels you'd like notifications to be
sent to in the `Settings > Notifications` page

See the confgure section to [customize Slack alerts through Automation Rules.](/features/automation-rules#slack-notifications)
See the confgure section to [customize Slack alerts through Automation Rules.](features/automation-rules#slack-notifications)

## PagerDuty
The PagerDuty integration allows you to create PagerDuty incidents for
any Action Item in Fairwinds Insights. This includes all three contexts:
Insights Agent, CI/CD and Admission Controller.

PagerDuty incidents are created via [Automation Rules](/features/automation-rules#pagerduty-incidents).
PagerDuty incidents are created via [Automation Rules](features/automation-rules#pagerduty-incidents).
You can customize your Automation Rule to only trigger on particular events
(e.g. critical level container CVEs from Trivy). You can also customize the
PagerDuty incident with different levels of urgency, add resource metadata
Expand Down Expand Up @@ -137,7 +137,7 @@ with Fairwinds Insights to prevent any confusion

1. Visit your organization's `Settings > Integration` page
2. Hover over `PagerDuty` and click `Add Integration`
3. Once you have connected PagerDuty to Insights, you can use [Automation Rules to trigger incidents](/features/automation-rules#pagerduty-incidents)
3. Once you have connected PagerDuty to Insights, you can use [Automation Rules to trigger incidents](features/automation-rules#pagerduty-incidents)

## Datadog
Fairwinds Insights has an integration to feed data into Datadog.
Expand Down
10 changes: 5 additions & 5 deletions docs/features/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ With the new Policy Configurator, you can now override the default settings of a
| Blocking override for CI/CD and Admission Controller | Based on Action Item severity. `High` and `Critical` are blocking | For the CI/CD and Admission Controller contexts, you can enforce a "must always fail" or "must always pass" rule regardless of the Action Item's severity | |

Policy is configured via the CLI, which will sync any YAML or custom OPA policies to the Insights API.
For more information see the [CLI documentation](/features/insights-cli)
For more information see the [CLI documentation](features/insights-cli)

### Syntax
The CLI expects a `settings.yaml` file in the current directory. The file should follow the following format:
Expand Down Expand Up @@ -81,7 +81,7 @@ checks:
This should show you the Policies that have been modified using the `settings.yaml` file.

### Automation Rules
[Automation Rules](/features/automation) can be used to further customize your policies.
[Automation Rules](features/automation) can be used to further customize your policies.
Automation Rules take precedence over the configuration above.

## Custom Policies with OPA
Expand All @@ -105,7 +105,7 @@ Insights also comes with several templates for OPA Policies which you can modify

#### Using the Insights CLI
To manage policies in an infrastructure-as-code repository, you can use the Insights command-line interface (CLI). Check out
[OPA Policies with the CLI](/features/insights-cli) for more information.
[OPA Policies with the CLI](features/insights-cli) for more information.

### Designing OPA Policies
Each OPA policy will receive an `input` parameter which contains
Expand Down Expand Up @@ -295,7 +295,7 @@ kubectl create job opa-test --from cronjob/opa -n insights-agent
Watch the pod logs for the resulting `Job` to spot any potential errors in your OPA policy.

The Insights CLI also facilitates offline testing of OPA policies. Check out
the [Validating OPA policy](/features/insights-cli#validate-and-debug-opa-policies) documentation.
the [Validating OPA policy](features/insights-cli#validate-and-debug-opa-policies) documentation.

### Adding Resources to OPA Policies
The Insights OPA plugin executes OPA policies for these Kubernetes resources by default:
Expand All @@ -320,7 +320,7 @@ opa:
- ingress
```

By default the OPA plugin inherits the same Kubernetes APIGroups and Resources defined in the default rules for [the Admission Controller](/features/admission-controller).
By default the OPA plugin inherits the same Kubernetes APIGroups and Resources defined in the default rules for [the Admission Controller](features/admission-controller).

## Troubleshooting
### Debug Print Statements
Expand Down
2 changes: 1 addition & 1 deletion docs/first-steps/cost-efficiency.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ the first time you visit the `Efficiency > Workloads` page:
<img :src="$withBase('/img/cost-settings.png')" alt="Cost settings">

We've pre-populated a list of instance types from AWS and GCP and can sync data from your bill when
[AWS Costs is enabled](/technical-details/reports/aws-costs). You can also set custom numbers
[AWS Costs is enabled](technical-details/reports/aws-costs). You can also set custom numbers
if you're running on a different cloud provider or if you're using spot instances. If you have
multiple node types in your cluster, use the most representative type.

Expand Down
8 changes: 4 additions & 4 deletions docs/first-steps/getting-value.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ meta:
content: "Fairwinds Insights | Documentation: How to get value from Fairwinds Insights"
---
# Getting Value from Fairwinds Insights
So you've [installed the Insights agent](/features/in-cluster-scanning)
So you've [installed the Insights agent](features/in-cluster-scanning)
and you're getting some results
back from your audits. Chances are you're seeing quite a few Action Items showing up. Where should you start?

Expand All @@ -18,21 +18,21 @@ their work is done. But if you fail to set some basic configuration
(like resource limits and liveness probes) for each workload,
it can cause serious headaches down the line.

Check out the [workload configuration](/first-steps/workload-configuration) to learn how to audit your
Check out the [workload configuration](first-steps/workload-configuration) to learn how to audit your
workloads for best practices.

## Container Security
Containers are the easiest way for vulnerabilities to sneak into your application. Each container
comes with its own operating system and installed libraries, so detecting and prioritizing vulnerabilities
can become a huge burden at scale.

Check out the [container security section](/first-steps/container-security) to learn how to audit your Docker
Check out the [container security section](first-steps/container-security) to learn how to audit your Docker
images for known CVEs.

## Cost Efficiency
Running workloads in Kubernetes can get expensive quickly. It can be hard to understand which
workloads have the biggest impact on your bottom line and often teams are tempted to overprovision
resources in order to ensure their application always functions properly.

Check out the [cost efficiency section](/first-steps/cost-efficiency) to get a better understanding
Check out the [cost efficiency section](first-steps/cost-efficiency) to get a better understanding
of workload cost as well as detect workloads that are under or over-provisioned.
Loading

0 comments on commit 073fe7f

Please sign in to comment.