diff --git a/calico-enterprise/operations/cnx/access-the-manager.mdx b/calico-enterprise/operations/cnx/access-the-manager.mdx index 331e8b3a68..3fc80d469e 100644 --- a/calico-enterprise/operations/cnx/access-the-manager.mdx +++ b/calico-enterprise/operations/cnx/access-the-manager.mdx @@ -28,6 +28,7 @@ For security, the $[prodname] web console is not exposed outside of the cluster | Load balancer | Configure your cluster with a service load balancer controller to implement the external load balancer. See [Kubernetes loadbalancer](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/) | Ensure the $[prodname] web console receives a HTTPS (TLS) connection (not unencrypted HTTP). If you require TLS termination at your load balancer, you must use a load balancer that supports transparent HTTP/2 proxying, or re-originate a TLS connection from your load balancer to the $[prodname] web console. If you do not require TLS termination, configure your proxy to “pass thru” the TLS to the $[prodname] web console. | | Port forwarding | Forward traffic from a local port to the Kubernetes API server, where it is proxied to the web console. This approach is **not recommended for production**, but is useful if you do not have a load balancer or ingress infrastructure configured, or you need to get started quickly. | n/a | | OpenShift routes | Use OpenShift routes to expose a service by giving it an externally-reachable hostname (for example, `www.example.com`) . | n/a | +| Calico Ingress Gateway | Expose the web console through Calico Ingress Gateway by setting `spec.ingressGateway` on the `Manager` resource. The operator creates and manages the Gateway, route, and TLS certificate for you. | Requires a `GatewayAPI` resource on the cluster. If your cluster uses OIDC, set the `Authentication` resource's `managerDomain` to `https://` followed by the hostname you choose (for example, `https://manager.example.com`). | ## How to @@ -176,6 +177,71 @@ Access the $[prodname] web console in your browser using the URL with clusternam + + +Instead of creating an ingress or load balancer yourself, you can let the operator expose the web console through [Calico Ingress Gateway](../../networking/ingress-gateway/about-calico-ingress-gateway.mdx). The operator creates the Gateway, the route to the web console, and a TLS certificate for the hostname you choose, and it removes them again when you turn the feature off. + +**Before you start** + +- Enable Calico Ingress Gateway by creating a `GatewayAPI` resource. See [Create an ingress gateway](../../networking/ingress-gateway/create-ingress-gateway.mdx). +- On bare metal clusters, make sure an IP pool is available for the gateway's load balancer address. + +1. Set a hostname on the `Manager` resource: + + ```bash + kubectl patch manager tigera-secure --type merge \ + -p '{"spec":{"ingressGateway":{"hostname":"manager.example.com"}}}' + ``` + + To place the Gateway in a namespace of your choosing, add `gatewayNamespace`. The operator creates the namespace if it does not exist: + + ```yaml + spec: + ingressGateway: + hostname: manager.example.com + gatewayNamespace: my-gateway-namespace + ``` + + If your `GatewayAPI` resource defines more than one gateway class, also set `gatewayClassName` to choose one. + +1. Wait for the Gateway to be programmed and read its address. The Gateway is in `calico-system` unless you set `gatewayNamespace`: + + ```bash + kubectl get gateway -n calico-system calico-manager-gateway + ``` + + ```bash title="Expected output" + NAME CLASS ADDRESS PROGRAMMED + calico-manager-gateway tigera-gateway-class True + ``` + +1. Point your hostname at that address in DNS. + +:::note + +If your cluster uses OIDC, set the `Authentication` resource's `managerDomain` to `https://` plus that hostname (as in the example below). The host must match `spec.ingressGateway.hostname`, or the operator reports the $[prodname] web console as degraded: + +```bash +kubectl patch authentication tigera-secure --type merge \ + -p '{"spec":{"managerDomain":"https://manager.example.com"}}' +``` + +Your identity provider also needs to accept `https:///dex/callback` and `https:///login/oidc/callback` as redirect URLs. + +::: + +### Log in to the $[prodname] web console + +Access the $[prodname] web console in your browser at the hostname you configured. For example: `https://manager.example.com`. + +To stop using the gateway, remove the field. The operator deletes everything it created for it: + +```bash +kubectl patch manager tigera-secure --type json \ + -p '[{"op":"remove","path":"/spec/ingressGateway"}]' +``` + + ## Additional resources diff --git a/calico/observability/view-flow-logs.mdx b/calico/observability/view-flow-logs.mdx index 5725d6b45c..258669539d 100644 --- a/calico/observability/view-flow-logs.mdx +++ b/calico/observability/view-flow-logs.mdx @@ -119,8 +119,64 @@ Port forwarding the Whisker service is a simple and secure method to view your f 1. To open Calico Whisker, open your browser and go to `https://localhost:8443`. Calico Whisker uses a self-signed certificate, so your browser shows a security warning the first time. Accept the warning to continue. - You may not see any flows at the beginning. - But in a few moments, as the console receives data, you'll begin to see a list of flow logs. + The flow table populates as Whisker receives data, filling in within a few moments. + +### Expose the web console with Calico Ingress Gateway + +Port forwarding is fine for a quick look, but it only works from a workstation with `kubectl` access. To give a team a stable URL, expose Whisker through [Calico Ingress Gateway](../networking/ingress-gateway/about-calico-ingress-gateway.mdx). The operator creates the Gateway, the route to Whisker, and a TLS certificate for the hostname you choose, and it removes them again when you turn the feature off. + +***Prerequisites*** + +* Calico Ingress Gateway is enabled, which means a `GatewayAPI` resource exists on the cluster. See [Create an ingress gateway](../networking/ingress-gateway/create-ingress-gateway.mdx). +* On bare metal clusters, an IP pool is available for the gateway's load balancer address. + +***Procedure*** + +1. Set a hostname on the `Whisker` resource: + + ```bash + kubectl patch whisker default --type merge \ + -p '{"spec":{"ingressGateway":{"hostname":"whisker.example.com"}}}' + ``` + + To place the Gateway in a namespace of your choosing, add `gatewayNamespace`. The operator creates the namespace if it does not exist: + + ```yaml + spec: + ingressGateway: + hostname: whisker.example.com + gatewayNamespace: my-gateway-namespace + ``` + + If your `GatewayAPI` resource defines more than one gateway class, also set `gatewayClassName` to choose one. + +1. Wait for the Gateway to be programmed and read its address. The Gateway is in `calico-system` unless you set `gatewayNamespace`: + + ```bash + kubectl get gateway -n calico-system calico-whisker-gateway + ``` + + ```bash title="Expected output" + NAME CLASS ADDRESS PROGRAMMED + calico-whisker-gateway tigera-gateway-class True + ``` + +1. Point your hostname at that address in DNS, then open `https://whisker.example.com` in your browser. + The gateway serves a self-signed certificate, so your browser shows a security warning the first time. + Accept the warning to continue. + +:::warning + +Calico Whisker and Goldmane contain sensitive network and workload data. Anyone who can reach the gateway hostname can read your flow logs. Do not expose it externally without putting your own authentication in front of it. + +::: + +While `spec.ingressGateway` is set, Calico restricts which pods may reach Whisker: only this gateway's proxy pods are allowed in. Removing the field deletes everything the operator created for the gateway: + +```bash +kubectl patch whisker default --type json \ + -p '[{"op":"remove","path":"/spec/ingressGateway"}]' +``` ## Additional resources