Skip to content
Closed
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
12 changes: 10 additions & 2 deletions calico-cloud/get-started/install-automated.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ import IconUser from '/img/icons/user-icon.svg';

You can connect clusters to Calico Cloud as part of an automated workflow, using persistent client credentials and customized Helm charts.

:::note

Starting from April 2025, container security features will not be enabled by default.
Image Assurance, Compliance Reports, and Container Threat Detection will need to be enabled explicitly.

:::


## Prerequisites

* You have an active Calico Cloud account. You can sign up for a 14-day free trial at [calicocloud.io](https://calicocloud.io).
Expand Down Expand Up @@ -82,10 +90,10 @@ 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` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| Container Threat Detection | `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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

:::note
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We'll also need to add a note about deprecation here.

Something along the lines of:

"Legacy users - those who have signed up prior to April 2025 - are still able to install the components above by setting the state to be Enabled. If you use the kubectl installs, then you can use deploy-with-container-security.yaml instead."

@ctauchen Is this messaging okay?

cc: @ozdanborne

Copy link
Collaborator

Choose a reason for hiding this comment

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

@WilliamTigera Thanks, I'll dig into the implications of the deprecation schedule and add notes myself where necessary.


Expand Down
17 changes: 15 additions & 2 deletions calico-cloud/get-started/install-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ title: Install Calico Cloud

You can quickly connect a cluster to Calico Cloud by generating a unique kubectl or Helm command in the web console and running it on your cluster.

:::note

Starting from April 2025, container security features will not be enabled by default.
Image Assurance, Compliance Reports, and Container Threat Detection will need to be enabled explicitly.

:::

## Prerequisites

* You have an active Calico Cloud account. You can sign up for a 14-day free trial at [calicocloud.io](https://calicocloud.io).
Expand All @@ -27,6 +34,12 @@ You can quickly connect a cluster to Calico Cloud by generating a unique kubectl
kubectl apply -f https://installer.calicocloud.io/manifests/cc-operator/latest/deploy.yaml && curl -H "Authorization: Bearer mprcnz04t:9dav6eoag:s8w7xjslez1x1xkf6ds0h23miz5b1fw6phh9897d0n76e4pjfdekijowjv5lw9dd" "https://www.calicocloud.io/api/managed-cluster/deploy.yaml?version=v19.1.0" | kubectl apply -f -
```

1. For legacy users that want to install container security features, change the `deploy.yaml` in the command above to `deploy-with-container-security.yaml`

```bash title="Example of generated kubectl installation command"
kubectl apply -f https://installer.calicocloud.io/manifests/cc-operator/latest/deploy-with-container-security.yaml && curl -H "Authorization: Bearer mprcnz04t:9dav6eoag:s8w7xjslez1x1xkf6ds0h23miz5b1fw6phh9897d0n76e4pjfdekijowjv5lw9dd" "https://www.calicocloud.io/api/managed-cluster/deploy-with-container-security.yaml?version=v19.1.0" | kubectl apply -f -
```

1. From a terminal, paste and run the command.
1. On the **Managed Clusters** page, you should immediately see your cluster in the list of managed clusters.
Monitor the status under **Connection Status**.
Expand All @@ -48,10 +61,10 @@ You can quickly connect a cluster to Calico Cloud by generating a unique kubectl

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Above this, we'll also need to add:

For legacy users that want to install image assurance using kubectl: Replace deploy.yaml with deploy-with-container-security.yaml.

   kubectl apply -f https://installer.calicocloud.io/manifests/cc-operator/latest/deploy-with-container-security.yaml && curl -H "Authorization: Bearer mprcnz04t:9dav6eoag:s8w7xjslez1x1xkf6ds0h23miz5b1fw6phh9897d0n76e4pjfdekijowjv5lw9dd" "https://www.calicocloud.io/api/managed-cluster/deploy-with-container-security.yaml?version=v19.1.0" | kubectl apply -f -

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm guessing that you're talking about people who are doing upgrades and who have IA enabled. If they run the generated kubectl command for v21.1.0, it will disable IA and CTD. If they want to continue with these enabled, they need to:

  1. Generate and copy the kubectl command.
  2. s/deploy.yaml/deploy-with-container-security.yaml
  3. Apply, and see a successful upgrade with deprecated features working normally.

Is that right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's correct.

| Feature | Key | Values |
|---------|-----|--------|
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled` (default), `Disabled` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| 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. |
| 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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We also need to add a note that if you're not a legacy user, installing with container security enabled will cause an installation error.

@ctauchen If you're able to tell me the best location to place the messaging, I believe you might put them in a deprecated section?

```bash title="Example of generated Helm command with user-added parameters"
helm repo add calico-cloud https://installer.calicocloud.io/charts --force-update && helm upgrade --install calico-cloud-crds calico-cloud/calico-cloud-crds --namespace calico-cloud --create-namespace && helm upgrade --install calico-cloud calico-cloud/calico-cloud --namespace calico-cloud --set apiKey=ryl34elz8:9dav6eoag:ifk1uwruwlgp7vzn7ecijt5zjbf5p9p1il1ag8877ylwjo4muu19wzg2g8x5qa7x --set installer.clusterName=my-cluster --set installer.calicoCloudVersion=v19.1.0 \
Expand Down
12 changes: 10 additions & 2 deletions calico-cloud/get-started/install-private-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ title: Install using a private registry

You can perform a Helm installation from images stored on a private registry.

:::note

Starting from April 2025, container security features will not be enabled by default.
Image Assurance, Compliance Reports, and Container Threat Detection will need to be enabled explicitly.

:::


## Prerequisites

* You have an active Calico Cloud account. You can sign up for a 14-day free trial at [calicocloud.io](https://calicocloud.io).
Expand Down Expand Up @@ -37,11 +45,11 @@ 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` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| 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. |

| 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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

```bash title="Example of generated Helm command with user-added parameters"
helm repo add calico-cloud https://installer.calicocloud.io/charts --force-update && helm upgrade --install calico-cloud-crds calico-cloud/calico-cloud-crds --namespace calico-cloud --create-namespace && helm upgrade --install calico-cloud calico-cloud/calico-cloud --namespace calico-cloud --set apiKey=ryl34elz8:5kdv6siag:ifk1uwruwlgp7vzn7ecijt5zjbf5p9p1il1ag8877ylwjo4muu19wzg2g8x5qa7x --set installer.clusterName=my-cluster --set installer.calicoCloudVersion=v19.1.0 \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ 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` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| Container Threat Detection | `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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

:::note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ 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` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| 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. |

| 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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

```bash title="Example of generated Helm command with user-added parameters"
helm repo add calico-cloud https://installer.calicocloud.io/charts --force-update && helm upgrade --install calico-cloud-crds calico-cloud/calico-cloud-crds --namespace calico-cloud --create-namespace && helm upgrade --install calico-cloud calico-cloud/calico-cloud --namespace calico-cloud --set apiKey=ryl34elz8:5kdv6siag:ifk1uwruwlgp7vzn7ecijt5zjbf5p9p1il1ag8877ylwjo4muu19wzg2g8x5qa7x --set installer.clusterName=my-cluster --set installer.calicoCloudVersion=v19.1.0 \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ 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` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| Container Threat Detection | `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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

:::note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ 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` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| 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. |
| 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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

```bash title="Example of generated Helm command with user-added parameters"
helm repo add calico-cloud https://installer.calicocloud.io/charts --force-update && helm upgrade --install calico-cloud-crds calico-cloud/calico-cloud-crds --namespace calico-cloud --create-namespace && helm upgrade --install calico-cloud calico-cloud/calico-cloud --namespace calico-cloud --set apiKey=ryl34elz8:9dav6eoag:ifk1uwruwlgp7vzn7ecijt5zjbf5p9p1il1ag8877ylwjo4muu19wzg2g8x5qa7x --set installer.clusterName=my-cluster --set installer.calicoCloudVersion=v19.1.0 \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ 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` |
| Image Assurance | `installer.components.imageAssurance.state` | `Enabled`, `Disabled` (default) |
| 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. |

| 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` |
| Compliance Reports | `installer.components.compliance.enabled` | `true`, `false` (default) |

```bash title="Example of generated Helm command with user-added parameters"
helm repo add calico-cloud https://installer.calicocloud.io/charts --force-update && helm upgrade --install calico-cloud-crds calico-cloud/calico-cloud-crds --namespace calico-cloud --create-namespace && helm upgrade --install calico-cloud calico-cloud/calico-cloud --namespace calico-cloud --set apiKey=ryl34elz8:5kdv6siag:ifk1uwruwlgp7vzn7ecijt5zjbf5p9p1il1ag8877ylwjo4muu19wzg2g8x5qa7x --set installer.clusterName=my-cluster --set installer.calicoCloudVersion=v19.1.0 \
Expand Down