Skip to content

Commit 6345aa6

Browse files
committed
edits
1 parent fc06717 commit 6345aa6

File tree

4 files changed

+22
-12
lines changed

4 files changed

+22
-12
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
A unique HelmChart custom resource is required for each Helm chart `.tgz` archive in a release. The primary purpose of the HelmChart custom resource is to provide the necessary instructions to the Replicated installer (Embedded Cluster, KOTS, kURL) for processing and preparing the given Helm chart for deployment.
1+
For installations with a Replicated installer (Embedded Cluster, KOTS, kURL), a unique HelmChart custom resource is required for each Helm chart `.tgz` archive in a release. The primary purpose of the HelmChart custom resource is to provide the necessary instructions to the Replicated installer for processing and preparing the given Helm chart for deployment.
22

3-
The HelmChart custom resource is also necessary to generate a list of required images for the chart, which supports the following use cases:
3+
The HelmChart custom resource is also used to generate a list of required images for the chart, which is required for the following use cases:
44
* Air gap installations with the Helm CLI or with a Replicated installer
55
* Online installations with a Replicated installer where the user will push images to a local image registry
66
* Online or air gap installations that use the [Security Center (Alpha)](/vendor/security-center-about) to scan and report on Helm chart images

docs/reference/custom-resource-helmchart-v2.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ This topic describes the KOTS HelmChart v2 custom resource.
2323

2424
<KotsHelmCrDescription/>
2525

26-
For more information, see [About Distributing Helm Charts with KOTS](/vendor/helm-native-about).
27-
2826
## Example
2927

3028
The following is an example manifest file for the HelmChart v2 custom resource:

docs/vendor/install-with-helm.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Before you install, complete the following prerequisites:
1616

1717
* 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_.
1818

19-
* 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. This is required to build the list of images that are scanned in the Security Center.
19+
* 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.
2020

21-
The following provides an example HelmChart custom resource for a chart named `examplechart` with a chart version of `1.0.0`:
21+
The following is an example HelmChart custom resource for a chart named `examplechart` with a chart version of `1.0.0`:
2222

2323
```yaml
2424
apiVersion: kots.io/v1beta2
@@ -34,10 +34,6 @@ Before you install, complete the following prerequisites:
3434
```
3535
For more information about the HelmChart custom resource, see [HelmChart v2](/reference/custom-resource-helmchart-v2).
3636
37-
:::note
38-
To support the use of the Security Center, the only required fields in the HelmChart spec are `chart.name` and `chart.chartVersion`. It is not necessary to configure any of the other fields available for the HelmChart resource.
39-
:::
40-
4137
## Firewall Openings for Online Installations with Helm {#firewall}
4238
4339
<FirewallOpeningsIntro/>

docs/vendor/security-center-about.mdx

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,24 @@ The Security Center is powered by Replicated’s [SecureBuild](https://securebui
1717
* 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.
1818
* Display and reporting of application images requires the [Replicated SDK version 1.8.0](/release-notes/rn-replicated-sdk#180) or later.
1919
* Display and reporting of Embedded Cluster images requires the [Replicated SDK version 1.9.0](/release-notes/rn-replicated-sdk#190) or later.
20-
* In a Helm CLI install, display of all container images observed in the cluster beyond application images requires setting 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 corresponding HelmChart 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.
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.
22+
23+
The following is an example HelmChart custom resource for a chart named `examplechart` with a chart version of `1.0.0`:
24+
25+
```yaml
26+
apiVersion: kots.io/v1beta2
27+
kind: HelmChart
28+
metadata:
29+
name: examplechart
30+
spec:
31+
chart:
32+
# name must match the name of the chart
33+
name: examplechart
34+
# chartVersion must match the version of the chart
35+
chartVersion: 1.0.0
36+
```
37+
For more information about the HelmChart custom resource, see [HelmChart v2](/reference/custom-resource-helmchart-v2).
2238
2339
## Limitations
2440
* The Security Center is Alpha. The features and functionality of the Security Center are subject to change.

0 commit comments

Comments
 (0)