Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-2472: Add deprecation notice for container threat detection #1896

Merged
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
4 changes: 2 additions & 2 deletions calico-cloud/get-started/install-automated.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ These features can be enabled or diabled only by setting them in your `values.ya

| Feature name | Parameter | Values |
|---------|-----|--------|
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default) |
| Image Assurance (deprecated) | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection (deprecated) | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default) |
| Packet Capture | `installer.components.packetCaptureAPI.state` | `Enabled`, `Disabled` (default) |
| Compliance Reports | `installer.components.compliance.enabled` | `true` (default), `false` |

Expand Down
4 changes: 2 additions & 2 deletions calico-cloud/get-started/install-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ You can quickly connect a cluster to Calico Cloud by generating a unique kubectl

| Feature | Key | Values |
|---------|-----|--------|
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Image Assurance (deprecated) | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection (deprecated) | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Packet Capture | `installer.components.packetCaptureAPI.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Compliance Reports | `installer.components.compliance.enabled` | `true` (default), `false` |

Expand Down
4 changes: 2 additions & 2 deletions calico-cloud/get-started/install-private-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ You can perform a Helm installation from images stored on a private registry.

| Feature | Key | Values |
|---------|-----|--------|
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Image Assurance (deprecated) | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection (deprecated) | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |

| Packet Capture | `installer.components.packetCaptureAPI.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Compliance Reports | `installer.components.compliance.enabled` | `true` (default), `false` |
Expand Down
19 changes: 13 additions & 6 deletions calico-cloud/threat/container-threat-detection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,17 @@
description: Threat detection for containerized workloads.
redirect_from:
- /threat/malware-detection
title: Container threat detection (deprecated)
---

# Container threat detection

:::info deprecation notice

The container threat detection features described on this page are deprecated and will be removed in a future release.

:::

## Big picture

Get alerts when security threats, such as malware and other suspicious processes, are detected in your cluster.
Expand Down Expand Up @@ -35,7 +42,7 @@

### Required

$[prodname] Container threat detection uses eBPF to monitor container activity, and it runs on Linux-based
$[prodname] container threat detection uses eBPF to monitor container activity, and it runs on Linux-based

Check failure on line 45 in calico-cloud/threat/container-threat-detection.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'prodname'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'prodname'?", "location": {"path": "calico-cloud/threat/container-threat-detection.mdx", "range": {"start": {"line": 45, "column": 3}}}, "severity": "ERROR"}
nodes in a Kubernetes cluster.

Nodes require amd64 (x86_64) architecture CPUs and one of the following distributions:
Expand All @@ -58,20 +65,20 @@

## How to

- [Enable Container threat detection in the managed cluster](#enable-container-threat-detection)
- [Enable container threat detection in the managed cluster](#enable-container-threat-detection)
- [Monitor the Security Events page for malicious programs](#monitor-alerts-page-for-malicious-programs)
- [Exclude a process from Security Events alerts](#exclude-a-process-from-Security-Events-alerts)
- [Update detectors settings](#update-detectors-settings)
- [Configure detectors via RuntimeSecurity Custom Resource](#configure-detectors-via-runtimesecurity-custom-resource)

### Enable Container Threat Detection
### Enable container threat detection

Container threat detection is disabled by default.

To enable Container threat detection on your managed cluster, go to the **Threat Defense** section in the $[prodname] UI, and select **Enable Container Threat Detection**.
This will result in Container threat detection running on all nodes in the managed cluster to detect malware and suspicious processes.
To enable container threat detection on your managed cluster, go to the **Threat Defense** section in the $[prodname] UI, and select **Enable Container Threat Detection**.

Check failure on line 78 in calico-cloud/threat/container-threat-detection.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'prodname'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'prodname'?", "location": {"path": "calico-cloud/threat/container-threat-detection.mdx", "range": {"start": {"line": 78, "column": 109}}}, "severity": "ERROR"}
This will result in container threat detection running on all nodes in the managed cluster to detect malware and suspicious processes.

Alternatively, Container threat detection can be enabled using kubectl:
Alternatively, container threat detection can be enabled using kubectl:

Check failure on line 81 in calico-cloud/threat/container-threat-detection.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'kubectl'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'kubectl'?", "location": {"path": "calico-cloud/threat/container-threat-detection.mdx", "range": {"start": {"line": 81, "column": 64}}}, "severity": "ERROR"}

```bash
kubectl apply -f - <<EOF
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ These features can be enabled or diabled only by setting them in your `values.ya

| Feature name | Parameter | Values |
|---------|-----|--------|
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default) |
| Image Assurance (deprecated) | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection (deprecated) | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default) |
| Packet Capture | `installer.components.packetCaptureAPI.state` | `Enabled`, `Disabled` (default) |
| Compliance Reports | `installer.components.compliance.enabled` | `true` (default), `false` |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ You can quickly connect a cluster to Calico Cloud by generating a unique kubectl

| Feature | Key | Values |
|---------|-----|--------|
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Image Assurance (deprecated) | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection (deprecated) | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |

| Packet Capture | `installer.components.packetCaptureAPI.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Compliance Reports | `installer.components.compliance.enabled` | `true` (default), `false` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ You can perform a Helm installation from images stored on a private registry.

| Feature | Key | Values |
|---------|-----|--------|
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Image Assurance (deprecated) | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Container Threat Detection (deprecated) | `installer.components.runtimeSecurity.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |

| Packet Capture | `installer.components.packetCaptureAPI.state` | `Enabled`, `Disabled` (default\*) <br/> * The default for new clusters is `Disabled`. For upgrades for previously connected clusters, the default will retain the previous state. |
| Compliance Reports | `installer.components.compliance.enabled` | `true` (default), `false` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ If you wish to apply Azure Policy to our namespaces, you can now override this l
### Deprecated and removed features

* Image Assurance is deprecated and will be removed in a future release.
* The container threat detection feature is deprecated and will be removed in a future release.
* The security posture management feature has been removed.
* The admission controller feature has been removed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,17 @@
description: Threat detection for containerized workloads.
redirect_from:
- /threat/malware-detection
title: Container threat detection (deprecated)
---

# Container threat detection

:::info deprecation notice

The container threat detection features described on this page are deprecated and will be removed in a future release.

:::

## Big picture

Get alerts when security threats, such as malware and other suspicious processes, are detected in your cluster.
Expand Down Expand Up @@ -35,7 +42,7 @@

### Required

$[prodname] Container threat detection uses eBPF to monitor container activity, and it runs on Linux-based
$[prodname] container threat detection uses eBPF to monitor container activity, and it runs on Linux-based

Check failure on line 45 in calico-cloud_versioned_docs/version-20-2/threat/container-threat-detection.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'prodname'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'prodname'?", "location": {"path": "calico-cloud_versioned_docs/version-20-2/threat/container-threat-detection.mdx", "range": {"start": {"line": 45, "column": 3}}}, "severity": "ERROR"}
nodes in a Kubernetes cluster.

Nodes require amd64 (x86_64) architecture CPUs and one of the following distributions:
Expand All @@ -58,20 +65,20 @@

## How to

- [Enable Container threat detection in the managed cluster](#enable-container-threat-detection)
- [Enable container threat detection in the managed cluster](#enable-container-threat-detection)
- [Monitor the Security Events page for malicious programs](#monitor-alerts-page-for-malicious-programs)
- [Exclude a process from Security Events alerts](#exclude-a-process-from-Security-Events-alerts)
- [Update detectors settings](#update-detectors-settings)
- [Configure detectors via RuntimeSecurity Custom Resource](#configure-detectors-via-runtimesecurity-custom-resource)

### Enable Container Threat Detection
### Enable container threat detection

Container threat detection is disabled by default.

To enable Container threat detection on your managed cluster, go to the **Threat Defense** section in the $[prodname] UI, and select **Enable Container Threat Detection**.
This will result in Container threat detection running on all nodes in the managed cluster to detect malware and suspicious processes.
To enable container threat detection on your managed cluster, go to the **Threat Defense** section in the $[prodname] UI, and select **Enable Container Threat Detection**.

Check failure on line 78 in calico-cloud_versioned_docs/version-20-2/threat/container-threat-detection.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'prodname'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'prodname'?", "location": {"path": "calico-cloud_versioned_docs/version-20-2/threat/container-threat-detection.mdx", "range": {"start": {"line": 78, "column": 109}}}, "severity": "ERROR"}
This will result in container threat detection running on all nodes in the managed cluster to detect malware and suspicious processes.

Alternatively, Container threat detection can be enabled using kubectl:
Alternatively, container threat detection can be enabled using kubectl:

Check failure on line 81 in calico-cloud_versioned_docs/version-20-2/threat/container-threat-detection.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'kubectl'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'kubectl'?", "location": {"path": "calico-cloud_versioned_docs/version-20-2/threat/container-threat-detection.mdx", "range": {"start": {"line": 81, "column": 64}}}, "severity": "ERROR"}

```bash
kubectl apply -f - <<EOF
Expand Down