|
| 1 | +# Scaleway Cilium Hubble |
| 2 | + |
| 3 | +This charts deploys Hubble as an add-on to Scaleway Kubernetes clusters. |
| 4 | + |
| 5 | +## Requirements |
| 6 | + |
| 7 | +* Scaleway Kubernetes cluster >= 1.31.0 |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +To add the Scaleway Helm repository and install the chart from there, use the following commands: |
| 12 | + |
| 13 | +```sh |
| 14 | +helm repo add scaleway https://helm.scw.cloud/ |
| 15 | +helm repo update |
| 16 | +helm upgrade --install scaleway-cilium-hubble scaleway/scaleway-cilium-hubble |
| 17 | +``` |
| 18 | + |
| 19 | +You'll then need to rollout cilium agents to load the new configuration: |
| 20 | + |
| 21 | +```sh |
| 22 | +kubectl -n kube-system rollout restart daemonset cilium |
| 23 | +``` |
| 24 | + |
| 25 | +## Configuration |
| 26 | + |
| 27 | +The following table lists the configurable parameters of the Scaleway Cilium Hubble chart and their default values. |
| 28 | + |
| 29 | +| Parameter | Description | Default Value | |
| 30 | +| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------------- | |
| 31 | +| `nodeConfig.enable-hubble` | Enable Hubble gRPC service. | `"true"` | |
| 32 | +| `nodeConfig.hubble-socket-path` | UNIX domain socket for Hubble server to listen to. | `"/var/run/cilium/hubble.sock"` | |
| 33 | +| `nodeConfig.hubble-event-buffer-capacity` | Capacity of the buffer to store recent events. | `"32767"` | |
| 34 | +| `nodeConfig.hubble-metrics-server` | Address to expose Hubble metrics (e.g. ":7070"). Metrics server will be disabled if this field is not set. | `":9965"` | |
| 35 | +| `nodeConfig.hubble-metrics-server-enable-tls` | Enable or disable TLS for Hubble metrics server. | `"false"` | |
| 36 | +| `nodeConfig.hubble-metrics` | A space separated list of metrics to enable. | see `values.yaml` for the default list | |
| 37 | +| `nodeConfig.enable-hubble-open-metrics` | Enable or disable Hubble OpenMetrics. | `"false"` | |
| 38 | +| `nodeConfig.hubble-export-file-max-size-mb` | Maximum size of the Hubble export file in MB. | `"10"` | |
| 39 | +| `nodeConfig.hubble-export-file-max-backups` | Maximum number of backups for the Hubble export file. | `"5"` | |
| 40 | +| `nodeConfig.hubble-listen-address` | An additional address for Hubble server to listen to (e.g. ":4244"). | `":4244"` | |
| 41 | + |
| 42 | +For other parameters, refer to cilium's own chart documentation under the `cilium` top level key. |
| 43 | + |
| 44 | +> Make sure not to enable the `operator`/`envoy`/`agent` as it will break the managed `cilium`. |
| 45 | +
|
| 46 | +## Usage |
| 47 | + |
| 48 | +Once the chart is installed, you can forward the relay port to the local machine: |
| 49 | + |
| 50 | +```sh |
| 51 | +cilium hubble port-forward |
| 52 | +``` |
| 53 | + |
| 54 | +Then open Hubble ui: |
| 55 | + |
| 56 | +```sh |
| 57 | +cilium hubble ui |
| 58 | +``` |
0 commit comments