Skip to content

Commit dd54dee

Browse files
authored
Merge pull request #3702 from replicatedhq/security-page-improvements
Security Center page improvements
2 parents 0f0a0c0 + 9d15f45 commit dd54dee

File tree

1 file changed

+53
-27
lines changed

1 file changed

+53
-27
lines changed

docs/vendor/security-center-about.mdx

Lines changed: 53 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,20 @@ The Security Center is Alpha. To get access to the Security Center, reach out to
1010

1111
The Security Center helps you strengthen security enablement in your application delivery process by making it easier for both you and your enterprise customers to monitor security risks, assess known vulnerabilities, and view security information for each application release.
1212

13-
The Security Center is powered by Replicated’s [SecureBuild](https://securebuild.com/) technology. Every image is scanned continuously, not just at release time. Customers can see the same application version security information that you do, driving customer transparency, reduced security questionnaire burden, and adoption of newer, more secure versions of your application.
13+
The Security Center is powered by Replicated’s [SecureBuild](https://securebuild.com/) technology. With SecureBuild, every image is scanned continuously (not just at release time) using the open source vulnerability scanner [grype](https://github.com/anchore/grype).
1414

15-
## Requirements
15+
The Security Center surfaces the results of image scans in both the Vendor Portal and the Enterprise Portal so that your customers can see the same security information that you do for each application version. This results in greater transparency, reduced security questionnaire burden, and the adoption of newer, more secure versions of your application.
1616

17+
## Requirements
1718
* Access to the Security Center Alpha requires a feature flag be turned on for your team. For more information, reach out to your Replicated account representative.
18-
* Display and reporting of application images requires the [Replicated SDK version 1.8.0](/release-notes/rn-replicated-sdk#180) or later.
19-
* Display and reporting of Embedded Cluster images requires the [Replicated SDK version 1.9.0](/release-notes/rn-replicated-sdk#190) or later.
20-
* For Helm CLI installations, to include all container images observed in the cluster in the Security Center reports (rather than application images only), set the Replicated SDK to [Report All Images](/vendor/replicated-sdk-customizing#report-all-images). This setting is automatically enabled for Embedded Cluster installations.
21-
* Each Helm chart in the release must have a unique [HelmChart](/reference/custom-resource-helmchart-v2) custom resource. The HelmChart custom resource is required to create the list of images that are scanned and reported on in the Security Center. This HelmChart custom resource requirement applies to both Helm CLI and Embedded Cluster installations.
19+
* Version 1.9.0 or later of the [Replicated SDK](/vendor/replicated-sdk-installing#install-the-sdk-as-a-subchart) is required to report CVE information from specific customer instances back to the Vendor Portal. For more information, see [Customer-Specific CVE Information](#customer-specific-cve-information) below.
20+
* For Helm CLI installations, additionally set the Replicated SDK to [Report All Images](/vendor/replicated-sdk-customizing#report-all-images). This ensures that the Security Center reports all container images observed in the cluster. This settting is enabled by default for Embedded Cluster installations.
21+
* Each Helm chart in the release must have a unique [HelmChart](/reference/custom-resource-helmchart-v2) custom resource. The HelmChart custom resource is required for both Embedded Cluster and Helm CLI installations in online (internet-connected) or air-gapped environments to create the list of images that are scanned and reported on in the Security Center.
2222

23-
The following is an example HelmChart custom resource for a chart named `examplechart` with a chart version of `1.0.0`:
23+
:::note
24+
For Embedded Cluster and air gap installations, you do not need to make any changes to your existing HelmChart custom resource(s) to support Security Center image scanning.
25+
26+
For Helm CLI installations in online environments, note that only the HelmChart `chart.name` and `chart.chartVersion` fields are required to support Security Center image scanning for the given chart. For example:
2427

2528
```yaml
2629
apiVersion: kots.io/v1beta2
@@ -34,57 +37,80 @@ The Security Center is powered by Replicated’s [SecureBuild](https://securebui
3437
# chartVersion must match the version of the chart
3538
chartVersion: 1.0.0
3639
```
37-
For more information about the HelmChart custom resource, see [HelmChart v2](/reference/custom-resource-helmchart-v2).
40+
:::
3841
3942
## Limitations
43+
4044
* The Security Center is Alpha. The features and functionality of the Security Center are subject to change.
45+
4146
* Security Center reporting is available only for Embedded Cluster and Helm CLI installations. It is not available for kURL installations or for KOTS installations in an existing cluster.
47+
4248
* If you have configured the [`builder`](/reference/custom-resource-helmchart-v2#builder) key in any of the HelmChart custom resources in your release, note that the Security Center uses the Helm values provided in the `builder` key to create the list of images that are scanned and reported on for the given Helm chart. The Security Center will scan and report on this same list of images for both air gap and online installations. If there are any images that you want reported on in the Security Center, ensure that they are exposed by the values provided in the `builder` key.
4349

50+
## Vendor Portal Security Center Interfaces
4451

45-
## Security Center Interfaces
52+
### Security Center Dashboard
4653

47-
The Security Center is accessible through the following interfaces:
48-
* Vendor-facing dashboard available in the Replicated Vendor Portal. See [Vendor Portal](#vendor-portal) below.
49-
* Enterprise customer-facing dashboard available in the Replicated Enterprise Portal (optionally enabled per customer license). See [Enterprise Portal](#enterprise-portal) below.
54+
The Security Center dashboard is available in the Vendor Portal at **[App name] > Security**.
55+
56+
The following shows an example of the Security Center dashboard:
5057

51-
### Vendor Portal
58+
![Security Center dashboard](/images/security-center-dashboard.png)
5259

53-
The Vendor Portal Security Center gives you access to the following key security insights for your releases:
54-
* Known vulnerabilities in container images
55-
* CVE details
56-
* A summary of top security risks based on the assessed severity of the vulnerability
60+
[View a larger version of this image](/images/security-center-dashboard.png)
5761

58-
The following shows an example of the vendor-facing Security Center dashboard in the Vendor Portal:
62+
You can filter for the information on the Security Center dashboard by release type (Linux/Embedded Cluster or Helm) and release channel. The information displayed on the Security Center dashboard applies to the currently promoted release of the selected type on the selected channel.
5963

60-
![Security Center dashboard](/images/security-center-dashboard.png)
64+
The Security Center dashboard includes the following:
65+
* An overview of vulnerabilities present in the release, including a breakdown of CVE severity (Critical, High, Medium, Low) and a detailed list of the top security risks
66+
* On the **Container images** tab, a complete list of scanned images with vulnerability counts per image
67+
* On the **CVE details** tab, for each CVE identified:
68+
* The CVE identifier and description
69+
* The CVSS score and severity rating
70+
* A list of images affected by the CVE
71+
* Fixed versions (when available)
6172

62-
[View a larger version of this image](/images/security-center-dashboard.png)
73+
### Release-Specific CVE Information
74+
75+
CVE details are available for all current and previously promoted application release versions. To view CVE information for a specifc release, go to **Releases > [Release Version] > Security**.
6376

64-
This dashboard displays an overview of vulnerabilities present in the release for the selected channel and installation type. When a channel is selected, the information displayed is for the promoted release for that channel.
77+
### Customer-Specific CVE Information
6578

66-
Additionally, CVE details are available at the individual release level for all current and previously promoted application release versions. To view CVE information for a specifc release go to **Releases > [Release Version] > Security**.
79+
You can view CVE details at the customer level for active instances running the Replicated SDK verson 1.9.0 or later. This gives you visibility into all container images running alongside your application, helping you identify security risks and urgent upgrade needs across your customer base.
6780

68-
You can also view CVE details at the individual customer level for active instances. To view CVE information for a specific customer instance go to **Customers > [Customer] > [Instance] > Security**. Instances must be running the Replicated SDK verson 1.8.0 or later.
81+
To view CVE information for a specific customer instance go to **Customers > [Customer] > [Instance] > Security**.
6982

70-
### Enterprise Portal
83+
## Enterprise Portal Security Center Interface
7184

7285
The Enterprise Portal Security Center allows you to provide key security information to your enterprise customers alongside your application releases.
7386

87+
The **Security Center** tab of the Enterprise Portal is not enabled by default. See [Enable the Enterprise Portal Security Center](#enable-the-enterprise-portal-security-center). When enabled, the Security Center intelligently filters data based on the customer's installation type, ensuring that customers only see relevant security information.
88+
7489
On the **Security Center** tab of the Enterprise Portal, for each available release version, customers can:
75-
* View a detailed report of known CVEs
76-
* Download the Software Bill of Materials (SBOM)
90+
* View a CVE report with the complete list of known vulnerabilities and their severity levels
91+
* View details about the vulnerabilities identified for each image
92+
* Understand how many CVEs are fixed by upgrading to newer versions
93+
* Download the Software Bill of Materials (SBOM) in SPDX format for compliance and security audits
7794

7895
The following shows an example of the Security Center dashboard in the Enterprise Portal:
7996

8097
![Enterprise Portal Security Center dashboard](/images/ep-security-center-dashboard.png)
8198

8299
[View a larger version of this image](/images/ep-security-center-dashboard.png)
83100

84-
#### Enable the Enterprise Portal Security Center
101+
102+
### Enable the Enterprise Portal Security Center
85103

86104
The **Security Center** tab in the Enterprise Portal is not enabled by default. If the Security Center feature flag is enabled for your Vendor Portal team, you can optionally enable the Enterprise Portal **Security Center** tab on a per-customer basis or globally for all customers.
87105

88106
To enable the **Security Center** tab in a customer's Enterprise Portal, go to **Customers > [Customer] > Enterprise Portal access**.
89107

90108
To enable the **Security Center** tab for all customers using the Enterprise Portal, go to **Enterprise Portal > Portal Settings > Optional Features** and enable the **Enable Security Center** feature toggle.
109+
110+
## Include and Exclude Images From Security Center Scans
111+
112+
You can explicitly include or exclude images from being scanned by the Security Center:
113+
114+
* To exclude images from being scanned in Helm CLI installations, use the [installer-only annotation](/vendor/packaging-include-resources#installer-only). This is useful if your application has any charts and resources that are only relevant to Embedded Cluster installations and should not be shown to customers that install with the Helm CLI.
115+
116+
* If there are any images that are _not_ referenced in the PodSpecs for your application but should be included in Security Center image scans, list those images in the Application custom resource [additionalImages](/vendor/operator-defining-additional-images#define-additional-images-for-air-gap-bundles) field.

0 commit comments

Comments
 (0)