Skip to content

Commit

Permalink
Adds docs for custom dashboards phase 1 and 2
Browse files Browse the repository at this point in the history
  • Loading branch information
@ctauchen
ctauchen committed Dec 17, 2024
1 parent 4ae19ff commit 2cd2d19
Show file tree
Hide file tree
Showing 18 changed files with 280 additions and 53 deletions.
24 changes: 17 additions & 7 deletions calico-cloud/release-notes/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,31 @@ title: Release notes

# Calico Cloud release notes

## December 17, 2024 (web console update)

### New features and enhancements

#### Dashboards (tech preview)

We added a set of dashboards to help you understand the activity in your cluster.
Each dashboard is made up of graphs, charts, and diagrams that visually represent the data in your logs.

You can also create your own arrangement by creating a custom dashboard.
With a custom dashboard, you can combine and arrange cards from any of the other dashboards.

For more information, see [Dashboards](../visibility/dashboards.mdx).

## December 3, 2024 (version 20.3.0)

### New features and enhancements

#### Image Assurance scan result management {/* Cloud 1 */}
#### Image Assurance scan result management

In this release, you can more easily manage your Image Assurance scan results by deleting results you don't need.
On the **All Scan Results** page, select the checkbox next to result item, and then click **Actions > Delete**.
You can also select multiple results and delete them as a bulk action.

#### Support for Windows nodes on AKS {/* Cloud 2 */}
#### Support for Windows nodes on EKS

We've expanded our support for Windows nodes to include hybrid clusters on Amazon Elastic Kubernetes Service.

Expand Down Expand Up @@ -47,17 +61,13 @@ For more information see [Deploy a dual ToR cluster](../networking/configuring/d

* Guardian will respect HTTP proxy environment variables when set on the deployment by mutating webhook configurations.
* Enhanced filtering options in the endpoints page of the Manager UI.
* Performance improvemments to Image Assurance processes.
* Performance improvements to Image Assurance processes.

### Deprecated and removed features

* All compliance reporting features are deprecated and will be removed in a future release.
We're building a new compliance reporting system that will eventually replace the current one.

### Bug fixes

* TBD

## November 6, 2024 (version 20.2.0)

### New features and enhancements
Expand Down
18 changes: 12 additions & 6 deletions calico-cloud/tutorials/calico-cloud-features/tour.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,24 @@ description: A quick tour of the Calico Cloud user interface.

Let's go through each item in the Manager UI left navbar from top to bottom. You can follow along using any cluster.

## Dashboard
## Dashboards

> From the left navbar, click Dashboards.
The Dashboard provides a birds-eye view of cluster activity. Note the following:

- The filter panel at the top lets you change dashboard views and the time range.
- The **Customize Layout** menu lets you choose what components are displayed on the dashboard. To get WireGuard metrics for pod-to-pod and host-to-host encryption, you must [enable WireGuard](../../compliance/encrypt-cluster-pod-traffic.mdx).
- For application-related dashboard cards to show data, like HTTP Response Codes or Url Requests, you need to [configure L7 logs](../../visibility/elastic/l7/configure.mdx).
Dashboards help you see and understand the activity in your cluster.
Each dashboard is made up of categorized graphs, charts, and diagrams that visually represent the data in your logs.

![dashboards](/img/calico-enterprise/dashboards.png)


* The **Cluster Health** dashboard provides a birds-eye view of cluster activity.
* The **Security Posture** dashboard helps you assess the overall security risk of your cluster and tells you how to address high-priority security issues.
* The **Data Volume** dashboard provides a high-level view of traffic in your cluster.
* The **DNS Dashboard** summarizes DNS data and logs into metrics, providing high-level information on the types of DNS lookups made, responses, and overall DNS performance.

Check failure on line 27 in calico-cloud/tutorials/calico-cloud-features/tour.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'lookups'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'lookups'?", "location": {"path": "calico-cloud/tutorials/calico-cloud-features/tour.mdx", "range": {"start": {"line": 27, "column": 121}}}, "severity": "ERROR"}
* The **Flow Logs** dashboard gives you an overview of how packets are being sent and received by all the pods in your cluster.
* The **L7** dashboard provides application performance metrics for inscope Kubernetes services.

Check failure on line 29 in calico-cloud/tutorials/calico-cloud-features/tour.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'inscope'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'inscope'?", "location": {"path": "calico-cloud/tutorials/calico-cloud-features/tour.mdx", "range": {"start": {"line": 29, "column": 70}}}, "severity": "ERROR"}
* The **TCP Performance** dashboard provides TCP metrics to help you identify bottlenecks, packet loss, and performance issues.

## Service Graph

> From the left navbar, select **Service Graph**, **Default**
Expand Down
35 changes: 18 additions & 17 deletions calico-cloud/users/user-management.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,24 @@ The default permissions align with typical needs for each role.

This table describes what level of access each predefined role has for features in Manager UI:

| | Owner | Admin | Viewer | DevOps | Security | Compliance | UsageMetrics | ImageAssuranceAdmin |
|---------------------------------------|:------------------:|:------------------:|:------:|:----------:|:----------:|:----------:|:------------:|:-------------------:|
| _Service Graph_ and _Flow Visualizer_ | view | view | view | view | view | - | - | - |
| _Policies_ | view, edit | view, edit | view | view, edit | view, edit | view | - | - |
| _Nodes_ and _Endpoints_ | view | view | view | view | view | view | - | - |
| _Network Sets_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - |
| _Managed Clusters_ | view, edit, delete | view, edit, delete | view | view, edit | view | - | - | - |
| _Compliance Reports_ | view | view | view | - | view | view | - | - |
| _Timeline_ | view | view | view | view | view | - | - | - |
| _Alerts_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - |
| _Kibana_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - |
| _Image Assurance_ | view, edit | view, edit | - | view, edit | view, edit | - | - | view, edit |
| _Manage Team_ | view, edit | view, edit | view | view | view | - | - | - |
| _Usage Metrics_ | view | - | - | - | - | - | view | - |
| _Threat Feeds_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - |
| _Web Application Firewall_ | view, edit | view, edit | view | view | view, edit | - | - | - |
| _Container Threat Detection_ | view, edit | view, edit | view | view | view, edit | - | - | - |
| | Owner | Admin | Viewer | DevOps | Security | Compliance | Usage Metrics | Image Assurance Admin | Dashboards Admin |
| ------------------------------------- | ------------------ | ------------------ | ------ | ---------- | ---------- | ---------- | ------------- | --------------------- | ---------------- |
| _Service Graph_ and _Flow Visualizer_ | view | view | view | view | view | - | - | - | - |
| _Policies_ | view, edit | view, edit | view | view, edit | view, edit | view | - | - | - |
| _Nodes_ and _Endpoints_ | view | view | view | view | view | view | - | - | - |
| _Network Sets_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - | - |
| _Managed Clusters_ | view, edit, delete | view, edit, delete | view | view, edit | view | - | - | - | - |
| _Compliance Reports_ | view | view | view | - | view | view | - | - | - |
| _Timeline_ | view | view | view | view | view | - | - | - | - |
| _Alerts_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - | - |
| _Kibana_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - | - |
| _Image Assurance_ | view, edit | view, edit | - | view, edit | view, edit | - | - | view, edit | - |
| _Manage Team_ | view, edit | view, edit | view | view | view | - | - | - | - |
| _Usage Metrics_ | view | - | - | - | - | - | view | - | - |
| _Threat Feeds_ | view, edit | view, edit | view | view, edit | view, edit | - | - | - | - |
| _Web Application Firewall_ | view, edit | view, edit | view | view | view, edit | - | - | - | - |
| _Container Threat Detection_ | view, edit | view, edit | view | view | view, edit | - | - | - | - |
| _Dashboards | view, edit | view, edit | view | view | view | - | - | - | view, edit |

Check failure on line 35 in calico-cloud/users/user-management.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean '_Dashboards'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean '_Dashboards'?", "location": {"path": "calico-cloud/users/user-management.mdx", "range": {"start": {"line": 35, "column": 4}}}, "severity": "ERROR"}

:::note

Expand Down
92 changes: 92 additions & 0 deletions calico-cloud/visibility/dashboards.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
description: Dashboards help you see what's going on in your cluster. See how your cluster is performing, check your security posture, and visualize your system's log data.
---

import IconDashboard from '/img/icons/dashboard.svg';
import IconEllipsis from '/img/icons/ellipsis.svg';
import IconGripLines from '/img/icons/grip-lines.svg';

# Dashboards

Dashboards help you see what's going on in your cluster.
See how your cluster is performing, check your security posture, and visualize your system's log data.

## About dashboards

Calico Cloud provides a set of dashboards to help you understand the activity in your cluster.
Each dashboard is made up of graphs, charts, and diagrams that visually represent the data in your logs.

To view your dashboards, sign in to Calico Cloud Manager and click the <IconDashboard width="20" /> **Dashboards** icon.

You can also create your own arrangement by creating a custom dashboard.
With a custom dashboard, you can combine and arrange cards from any of the other dashboards.

Not all users have access to dashboards.
Creating custom dashboards is limited to administrators.

### Cluster Health

The **Cluster Health** dashboard provides a birds-eye view of cluster activity.

![dashboards](/img/calico-enterprise/dashboards.png)

### Security Posture (tech preview)

The **Security Posture** dashboard helps you assess the overall security risk of your cluster and tells you how to address high-priority security issues.
For more information, see [Security Posture dashboard](../threat/security-posture-overview.mdx).

![Security posture dashboard](/img/calico-cloud/security-posture-first.png)

### Data Volume (tech preview)

The **Data Volume** dashboard provides a high-level view of traffic in your cluster.

![Data volume dashboard](/img/calico-cloud/dashboard-data-volume.png)


### DNS Logs (tech preview)

The **DNS Dashboard** summarizes DNS data and logs into metrics, providing high-level information on the types of DNS lookups made, responses, and overall DNS performance.

Check failure on line 49 in calico-cloud/visibility/dashboards.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'lookups'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'lookups'?", "location": {"path": "calico-cloud/visibility/dashboards.mdx", "range": {"start": {"line": 49, "column": 119}}}, "severity": "ERROR"}

![DNS logs dashboard](/img/calico-cloud/dashboard-dns-logs.png)

### Flow Logs (tech preview)

The **Flow Logs** dashboard gives you an overview of how packets are being sent and received by all the pods in your cluster.
Seeing this data helps you spot unusual flow activity, which may indicate a compromise.

![Flow logs dashboard](/img/calico-cloud/dashboard-flow-logs.png)

### L7 (tech preview)

The **L7** dashboard provides application performance metrics for inscope Kubernetes services.

Check failure on line 62 in calico-cloud/visibility/dashboards.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'inscope'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'inscope'?", "location": {"path": "calico-cloud/visibility/dashboards.mdx", "range": {"start": {"line": 62, "column": 68}}}, "severity": "ERROR"}
The data can assist service owners and platform personnel in assessing the health of cluster workloads without the need for a full service mesh.
[L7 logs](elastic/l7/configure.mdx) are not enabled by default, and must be configured.

![L7 dashboard](/img/calico-cloud/dashboard-l7.png)

### TCP Performance (tech preview)

The **TCP Performance** dashboard provides TCP metrics to help you identify bottlenecks, packet loss, and performance issues.

![TCP performance dashboard](/img/calico-cloud/dashboard-tcp-performance.png)

## Create a custom dashboard (tech preview)

You can create your own custom dashboard by importing cards from other standard and custom dashboards.

***Prerequisites***

* You are signed in to the Calico Cloud Manager UI as a user with the Owner, Admin, or Dashboards Admin role.

***Procedure***

1. From the Calico Cloud Manager UI, click **Dashboards > New Dashboard**.
1. Enter a name for your custom dashboard, and then press **Enter**.
1. To import cards from existing dashboards, click **Import Cards**.
In the dialog that appears, select the cards you want, and then click **Import**.
The page now displays the cards you selected.
1. Add, delete, or move the cards to create the arrangement that suits your needs.
* To add a card, click **Actions > Import** and you can select more cards.
* To delete a card, click the <IconEllipsis width="20" style={{ verticalAlign: "middle" }} /> icon on the card, and then click **Delete**.

Check failure on line 91 in calico-cloud/visibility/dashboards.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'verticalAlign'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'verticalAlign'?", "location": {"path": "calico-cloud/visibility/dashboards.mdx", "range": {"start": {"line": 91, "column": 68}}}, "severity": "ERROR"}
* To move a card, click and hold the <IconGripLines width="20" style={{ verticalAlign: "middle" }} /> icon on the card, and then drag the card to a new location.

Check failure on line 92 in calico-cloud/visibility/dashboards.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'verticalAlign'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'verticalAlign'?", "location": {"path": "calico-cloud/visibility/dashboards.mdx", "range": {"start": {"line": 92, "column": 76}}}, "severity": "ERROR"}
14 changes: 14 additions & 0 deletions calico-cloud_versioned_docs/version-20-2/release-notes/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,20 @@ title: Release notes

# Calico Cloud release notes

## December 17, 2024 (web console update)

### New features and enhancements

#### Dashboards (tech preview)

We added a set of dashboards to help you understand the activity in your cluster.
Each dashboard is made up of graphs, charts, and diagrams that visually represent the data in your logs.

You can also create your own arrangement by creating a custom dashboard.
With a custom dashboard, you can combine and arrange cards from any of the other dashboards.

For more information, see [Dashboards](../visibility/dashboards.mdx).

## December 3, 2024 (version 20.3.0)

### New features and enhancements
Expand Down
18 changes: 12 additions & 6 deletions calico-cloud_versioned_docs/version-20-2/tutorials/calico-cloud-features/tour.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,24 @@ description: A quick tour of the Calico Cloud user interface.

Let's go through each item in the Manager UI left navbar from top to bottom. You can follow along using any cluster.

## Dashboard
## Dashboards

> From the left navbar, click Dashboards.
The Dashboard provides a birds-eye view of cluster activity. Note the following:

- The filter panel at the top lets you change dashboard views and the time range.
- The **Customize Layout** menu lets you choose what components are displayed on the dashboard. To get WireGuard metrics for pod-to-pod and host-to-host encryption, you must [enable WireGuard](../../compliance/encrypt-cluster-pod-traffic.mdx).
- For application-related dashboard cards to show data, like HTTP Response Codes or Url Requests, you need to [configure L7 logs](../../visibility/elastic/l7/configure.mdx).
Dashboards help you see and understand the activity in your cluster.
Each dashboard is made up of categorized graphs, charts, and diagrams that visually represent the data in your logs.

![dashboards](/img/calico-enterprise/dashboards.png)


* The **Cluster Health** dashboard provides a birds-eye view of cluster activity.
* The **Security Posture** dashboard helps you assess the overall security risk of your cluster and tells you how to address high-priority security issues.
* The **Data Volume** dashboard provides a high-level view of traffic in your cluster.
* The **DNS Dashboard** summarizes DNS data and logs into metrics, providing high-level information on the types of DNS lookups made, responses, and overall DNS performance.

Check failure on line 27 in calico-cloud_versioned_docs/version-20-2/tutorials/calico-cloud-features/tour.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'lookups'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'lookups'?", "location": {"path": "calico-cloud_versioned_docs/version-20-2/tutorials/calico-cloud-features/tour.mdx", "range": {"start": {"line": 27, "column": 121}}}, "severity": "ERROR"}
* The **Flow Logs** dashboard gives you an overview of how packets are being sent and received by all the pods in your cluster.
* The **L7** dashboard provides application performance metrics for inscope Kubernetes services.

Check failure on line 29 in calico-cloud_versioned_docs/version-20-2/tutorials/calico-cloud-features/tour.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'inscope'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'inscope'?", "location": {"path": "calico-cloud_versioned_docs/version-20-2/tutorials/calico-cloud-features/tour.mdx", "range": {"start": {"line": 29, "column": 70}}}, "severity": "ERROR"}
* The **TCP Performance** dashboard provides TCP metrics to help you identify bottlenecks, packet loss, and performance issues.

## Service Graph

> From the left navbar, select **Service Graph**, **Default**
Expand Down
Loading

0 comments on commit 2cd2d19

Please sign in to comment.