Skip to content
Draft
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
2 changes: 1 addition & 1 deletion docs/partials/helm/_helm-cr-builder-airgap-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The Replicated Vendor Portal uses the Helm values in the `builder` key to run `h
The Vendor Portal then uses this list of images to do the following:
* Create the Helm CLI air gap installation instructions that are automatically made available to customers in the [Enterprise Portal](/vendor/enterprise-portal-about) or Download Portal.
* Build the `.airgap` bundle for a release to support air gap installations with a Replicated installer (Embedded Cluster, KOTS, kURL).
* Determine which images to scan and report on in the [Security Center (Alpha)](/vendor/security-center-about).
* Determine which images to scan and report on in the [Security Center (Beta)](/vendor/security-center-about).

You must configure the `builder` key to support the following installation types:

Expand Down
2 changes: 1 addition & 1 deletion docs/partials/helm/_kots-helm-cr-description.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Each Helm chart `.tgz` archive in a release requires a unique HelmChart custom r
The HelmChart custom resource also generates a list of required images for the chart, which is necessary for the following use cases:
* Air gap installations with the Helm CLI or with a Replicated installer
* Online installations with a Replicated installer where the user will push images to a local image registry
* Online or air gap installations that use the [Security Center (Alpha)](/vendor/security-center-about) to scan and report on Helm chart images
* Online or air gap installations that use the [Security Center (Beta)](/vendor/security-center-about) to scan and report on Helm chart images
2 changes: 1 addition & 1 deletion docs/vendor/helm-install-airgap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Before you install, complete the following prerequisites:

* For each Helm chart in your release, add the Replicated HelmChart custom resource. Additionally, if the chart's default values do not expose all the required and optional images that might be needed to install in air-gapped environments, configure the HelmChart resource's `builder` key. For more information about how to configure the `builder` key, see [builder](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_.

Configuring the `builder` key ensures all the images that might be needed to install in air-gapped environments are included in the Helm CLI installation instructions in the Enterprise Portal. For installations that use the [Security Center (Alpha)](/vendor/security-center-about), the HelmChart custom resource is also required to build the list of images that are scanned in the Security Center.
Configuring the `builder` key ensures that the Enterprise Portal's Helm CLI installation instructions include all the images that air-gapped environments might need to install. If you use the [Security Center (Beta)](/vendor/security-center-about), also add a HelmChart custom resource so the Security Center can build the list of images it scans.

* The customer record in the Vendor Portal must have the following:

Expand Down
2 changes: 1 addition & 1 deletion docs/vendor/install-with-helm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Before you install, complete the following prerequisites:

* Declare the Replicated SDK as a dependency in your Helm chart. For more information, see [Install the SDK as a Subchart](replicated-sdk-installing#install-the-sdk-as-a-subchart) in _Installing the Replicated SDK_.

* If the [Security Center (Alpha)](/vendor/security-center-about) is enabled for your account, add a unique HelmChart custom resource for each Helm chart in your release. The HelmChart custom resource is required to create the list of images that are scanned and reported on in the Security Center.
* If your account has access to the [Security Center (Beta)](/vendor/security-center-about), add a unique HelmChart custom resource for each Helm chart in your release. The Security Center uses these HelmChart custom resources to create the list of images that it scans and reports on.

The following is an example HelmChart custom resource for a chart named `examplechart` with a chart version of `1.0.0`:

Expand Down
2 changes: 1 addition & 1 deletion docs/vendor/packaging-include-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can use the `kots.io/installer-only` annotation to prevent an entire Helm ch

The `kots.io/installer-only` annotation does the following:
- Excludes the chart (or the resource in a chart's templates) from the Helm CLI installation and update instructions in the Enterprise Portal and Vendor Portal. For more information about how users can view these instructions in the Enterprise Portal, see [View Insall and Update Instructions](/vendor/enterprise-portal-use#view-install-and-update-instructions) in _Log In To and Use the Enterprise Portal_.
- Excludes the chart (or the resource in a chart's templates) from Security Center reports for Helm CLI installations. For more information about the Security Center, see [About the Security Center (Alpha)](/vendor/security-center-about).
- Excludes the chart (or the resource in a chart's templates) from Security Center reports for Helm CLI installations. For more information about the Security Center, see [About the Security Center (Beta)](/vendor/security-center-about).

This annotation is useful for charts that are required for Replicated installer-based deployments but should not be visible or deployed when customers install with the Helm CLI.

Expand Down
2 changes: 1 addition & 1 deletion docs/vendor/replicated-onboarding-helm-only.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ To configure your chart to use the proxy registry:

### Task 4: Add the HelmChart custom resource and create a release

For each Helm chart used by your application, add a unique Replicated HelmChart custom resource. Replicated uses the HelmChart resource to generate a list of the images that are used by your Helm chart. This enables features such as air gap installations and scanning and reporting on application images with the [Replicated Security Center (Alpha)](/vendor/security-center-about). For more information, see [HelmChart v2](/reference/custom-resource-helmchart-v2).
For each Helm chart used by your application, add a unique Replicated HelmChart custom resource. Replicated uses the HelmChart resource to generate a list of the images that your Helm chart uses. This enables features such as air gap installations and scanning and reporting on application images with the [Replicated Security Center (Beta)](/vendor/security-center-about). For more information, see [HelmChart v2](/reference/custom-resource-helmchart-v2).

After you configure the HelmChart custom resource, you can create and promote your first release in the Vendor Portal.

Expand Down
8 changes: 4 additions & 4 deletions docs/vendor/security-center-about.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# About the Security Center (Alpha)
# About the Security Center (Beta)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Replicated.Headings] 'About the Security Center (Beta)' should use sentence case.


This topic provides an overview of the Replicated Security Center.

:::note
The Security Center is Alpha. To get access to the Security Center, reach out to your Replicated account representative.
The Security Center is Beta. To get access to the Security Center, reach out to your Replicated account representative.
:::

## Overview
Expand Down Expand Up @@ -52,7 +52,7 @@ The following describes the Security Center SBOM generation process:
- **Enterprise Portal**: Your customers can download release-specific SBOMs in SPDX format from the Enterprise Portal's **Security** tab.

## Requirements
* 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.
* The Security Center Beta requires a feature flag for your team. To enable it, reach out to your Replicated account representative.
* 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.
* 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.
* 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.
Expand All @@ -78,7 +78,7 @@ The following describes the Security Center SBOM generation process:

## Limitations

* The Security Center is Alpha. The features and functionality of the Security Center are subject to change.
* The Security Center is Beta. The features and functionality of the Security Center are subject to change.

* 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.

Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ const sidebars = {
},
{
type: "category",
label: "Security Center (Alpha)",
label: "Security Center (Beta)",
items: [
"vendor/security-center-about",
],
Expand Down
Loading