Radar

https://radarhq.io/docs
Admin
Radar is an open-source Kubernetes visibility tool that provides real-time topology mapping,...
Tokens:183,055
Snippets:1,618
Trust Score:6.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### POST /api/cloud/install/start

Source: https://radarhq.io/docs/reference/api

Starts the cloud installation process for eligible local Radar instances. This is part of the Cloud Connect driver.

```APIDOC
## POST /api/cloud/install/start

### Description
Starts the cloud installation process for eligible local Radar instances.

### Method
POST

### Endpoint
/api/cloud/install/start
```

--------------------------------

### Install with CloudNativePG

Source: https://radarhq.io/docs/cloud/self-hosted/install

Install the chart using an existing CloudNativePG cluster.

```bash
helm install radar-hub skyhook/radar-hub \
  --namespace radar-hub --create-namespace \
  --set postgres.bundled.enabled=false \
  --set postgres.external.cnpgCluster=acme-pg \
  ... # the rest below
```

--------------------------------

### Install with bundled Postgres

Source: https://radarhq.io/docs/cloud/self-hosted/install

Install the chart using the default bundled Postgres for evaluation purposes. Not suitable for production.

```bash
helm install radar-hub skyhook/radar-hub \
  --namespace radar-hub --create-namespace \
  --set postgres.bundled.persistence.size=10Gi \
  ... # the rest below
```

--------------------------------

### GET /api/cloud/install/status

Source: https://radarhq.io/docs/reference/api

Retrieves the status of the cloud installation process. This is part of the Cloud Connect driver.

```APIDOC
## GET /api/cloud/install/status

### Description
Retrieves the status of the cloud installation process.

### Method
GET

### Endpoint
/api/cloud/install/status
```

--------------------------------

### Install with managed Postgres

Source: https://radarhq.io/docs/cloud/self-hosted/install

Install the chart pointing to an external managed database via a pre-created secret.

```bash
helm install radar-hub skyhook/radar-hub \
  --namespace radar-hub --create-namespace \
  --set postgres.bundled.enabled=false \
  --set postgres.external.existingSecret=radar-hub-pg \
  ... # the rest below
```

--------------------------------

### Install Radar CLI on Windows via PowerShell installer

Source: https://radarhq.io/docs/install

Downloads and runs the PowerShell installer for Radar on Windows.

```powershell
iwr -useb https://get.radarhq.io/install.ps1 | iex
```

--------------------------------

### Install Radar CLI on Windows via Scoop

Source: https://radarhq.io/docs/install

Adds the Skyhook Scoop bucket and installs Radar. After install, the binary is laid down as kubectl-radar; the bare 'radar' command works only if you add a symlink yourself.

```powershell
scoop bucket add skyhook https://github.com/skyhook-io/scoop-bucket
scoop install radar
```

--------------------------------

### Install Radar with Helm

Source: https://radarhq.io/docs/quickstart-cloud

Use this Helm command to install the Radar agent in your cluster. The command includes your unique cluster ID and a one-time install token.

```bash
helm upgrade --install radar oci://ghcr.io/skyhook-io/radar \
  --namespace radar --create-namespace \
  --set cloud.enabled=true \
  --set cloud.url=wss://api.radarhq.io/agent \
  --set cloud.token=rhc_... \
  --set cloud.clusterName=<cluster_id> \
  --set rbac.helm=true \
  --set rbac.secrets=true \
  --set rbac.podExec=true \
  --set rbac.portForward=true
```

--------------------------------

### Install Radar Hub via Helm

Source: https://radarhq.io/docs/cloud/self-hosted/install

Deploys the Radar Hub chart with specified configurations for namespace, database, authentication, and ingress. The license key can be provided during installation or via a subsequent upgrade.

```bash
helm install radar-hub skyhook/radar-hub \
  --namespace radar-hub --create-namespace \
  --set hub.publicURL=https://radar.acme.example \
  --set hub.cookiePassword="$(openssl rand -base64 48)" \
  --set license.key="$RADAR_HUB_LICENSE" \
  --set postgres.bundled.enabled=false \
  --set postgres.external.existingSecret=radar-hub-pg \
  --set auth.breakGlass.email=admin@acme.example \
  --set auth.breakGlass.password=changeme123 \
  --set ingress.enabled=true \
  --set ingress.className=nginx \
  --set "ingress.hosts[0].host=radar.acme.example" \
  --set "ingress.hosts[0].paths[0].path=/" \
  --set "ingress.hosts[0].paths[0].pathType=Prefix" \
  --set "ingress.tls[0].secretName=radar-acme-tls" \
  --set "ingress.tls[0].hosts[0]=radar.acme.example"
```

--------------------------------

### Install Radar desktop app on Windows via Scoop

Source: https://radarhq.io/docs/install

Installs the Radar desktop app for Windows using Scoop.

```powershell
scoop install radar-desktop
```

--------------------------------

### Install Radar via Helm

Source: https://radarhq.io/docs/configuration/in-cluster

Commands to add the Skyhook Helm repository and install the Radar chart into a dedicated namespace.

```bash
helm repo add skyhook https://skyhook-io.github.io/helm-charts
helm repo update skyhook
helm upgrade --install radar skyhook/radar -n radar --create-namespace
```

--------------------------------

### Install Radar with explicit kubeconfig context

Source: https://radarhq.io/docs/cloud/self-hosted/install

Use the --context flag to specify the intended kubeconfig context for the installation.

```bash
kubectl radar cloud install \
  --hub-url https://radar.acme.example \
  --context prod-us-east-1
```

--------------------------------

### Domain auto-join configuration example

Source: https://radarhq.io/docs/cloud/members

Shows an example of allowed domains and the default role for domain auto-join. Free-mail providers are blocklisted, and auto-joined users always get the default role, never owner.

```text
Allowed domains:    acme.com, eng.acme.com
Default role:       member
```

--------------------------------

### POST /api/cloud/install/prepare

Source: https://radarhq.io/docs/reference/api

Prepares the cloud installation process for eligible local Radar instances. This is part of the Cloud Connect driver.

```APIDOC
## POST /api/cloud/install/prepare

### Description
Prepares the cloud installation process for eligible local Radar instances.

### Method
POST

### Endpoint
/api/cloud/install/prepare
```

--------------------------------

### GET /api/gitops/managed-resources

Source: https://radarhq.io/docs/reference/api

Retrieves all managed resources in the GitOps setup. This endpoint is part of the Argo CD GitOps API.

```APIDOC
## GET /api/gitops/managed-resources

### Description
Retrieves all managed resources in the GitOps setup.

### Method
GET

### Endpoint
/api/gitops/managed-resources
```

--------------------------------

### Check Back-Channel Logout startup logs

Source: https://radarhq.io/docs/configuration/authentication

Verify Back-Channel Logout support in the startup logs.

```text
[oidc] Backchannel Logout enabled (sid-based revocation)
# or
[oidc] WARNING: --auth-oidc-backchannel-logout is set, but IdP does not advertise backchannel_logout_supported.
```

--------------------------------

### Install Radar CLI on macOS/Linux via install script

Source: https://radarhq.io/docs/install

Installs the Radar CLI binary as kubectl-radar. After install, use 'kubectl radar' as a plugin or 'kubectl-radar' standalone. The bare 'radar' command works only if you add a symlink yourself or install via Homebrew.

```bash
curl -fsSL https://get.radarhq.io | sh
```

--------------------------------

### Troubleshoot pod startup failures

Source: https://radarhq.io/docs/configuration/in-cluster

Use these commands to inspect logs and pod status for pods labeled with app.kubernetes.io/name=radar in the radar namespace.

```bash
kubectl logs -n radar -l app.kubernetes.io/name=radar
kubectl describe pod -n radar -l app.kubernetes.io/name=radar
```

--------------------------------

### Install Radar CLI on macOS/Linux via Homebrew

Source: https://radarhq.io/docs/install

Installs the Radar CLI via Homebrew. After install, the bare 'radar' command works (unlike the install script or Scoop).

```bash
brew install skyhook-io/tap/radar
```

--------------------------------

### Perform pre-upgrade checks and backup

Source: https://radarhq.io/docs/cloud/self-hosted/upgrade

Verify the chart availability, lint the new chart against existing values, and create a Postgres database backup before proceeding with the upgrade.

```bash
# 1. Verify the chart is reachable + the new version is what you expect.
helm search repo skyhook/radar-hub

# 2. Lint the new chart against your live values.
helm get values radar-hub --namespace radar-hub > /tmp/live-values.yaml
helm template radar-hub skyhook/radar-hub \
  --namespace radar-hub \
  -f /tmp/live-values.yaml > /tmp/rendered.yaml

# 3. (Recommended) Take a backup of your Postgres.
pg_dump -h <host> -U radar radar_hub | gzip > radar-hub-pre-upgrade.sql.gz
```

--------------------------------

### POST /api/cloud/install/dismiss

Source: https://radarhq.io/docs/reference/api

Dismisses the cloud installation prompt or process. This is part of the Cloud Connect driver.

```APIDOC
## POST /api/cloud/install/dismiss

### Description
Dismisses the cloud installation prompt or process.

### Method
POST

### Endpoint
/api/cloud/install/dismiss
```

--------------------------------

### Start Radar with explicit namespace list using --namespaces

Source: https://radarhq.io/docs/configuration/files

Use this command to start Radar with a specific list of namespaces when your account cannot list namespaces cluster-wide. Radar probes each listed namespace for access and watches all granted namespaces. The list is capped by --max-scope-candidates (default 20).

```bash
kubectl radar --namespaces ns1,ns2,ns3
```

--------------------------------

### Install Radar CLI as kubectl plugin via Krew

Source: https://radarhq.io/docs/install

Installs Radar as a kubectl plugin. After install, use 'kubectl radar' as a plugin or 'kubectl-radar' standalone.

```bash
kubectl krew install radar
```

--------------------------------

### Manual Helm Installation

Source: https://radarhq.io/docs/cloud/self-hosted/install

Manual steps to add the Radar Helm repository, create the necessary namespace and secret, and upgrade the Helm release with cloud configuration.

```bash
helm repo add skyhook https://skyhook-io.github.io/helm-charts
helm repo update skyhook
kubectl create namespace radar --dry-run=client -o yaml | kubectl apply -f -
kubectl create secret generic radar-cloud-config -n radar \
  --from-literal=token=<one-time-token> \
  --dry-run=client -o yaml | kubectl apply -f -
helm upgrade --install radar skyhook/radar \
  --namespace radar \
  --set cloud.enabled=true \
  --set cloud.url="wss://radar.acme.example/agent" \
  --set cloud.clusterName=<cluster-id> \
  --set cloud.existingSecret=radar-cloud-config \
  --set auth.mode=proxy \
  --set rbac.helm=true \
  --set rbac.secrets=true \
  --set rbac.podExec=true \
  --set rbac.portForward=true \
  --set rbac.metrics=true \
  --set rbac.selfUpgrade=true
```

--------------------------------

### Install via Helm with LoadBalancer

Source: https://radarhq.io/docs/cloud/self-hosted/configuration

Deploy the hub using Helm with LoadBalancer and self-signed TLS settings.

```bash
helm install radar-hub skyhook/radar-hub \
  --namespace radar-hub --create-namespace \
  --set hub.publicURL=https://radar.acme.example \
  --set service.web.type=LoadBalancer \
  --set web.tls.selfSigned=true \
  ... # license, cookiePassword, break-glass, Postgres as above
```

--------------------------------

### Configure Gemini CLI

Source: https://radarhq.io/docs/features/mcp

Add the configuration to ~/.gemini/settings.json.

```json
{
  "mcpServers": {
    "radar": {
      "httpUrl": "http://localhost:9280/mcp"
    }
  }
}
```

--------------------------------

### GET /api/cluster-info

Source: https://radarhq.io/docs/reference/api

Retrieves information about the cluster. This endpoint is used to get details about the cluster configuration and status.

```APIDOC
## GET /api/cluster-info

### Description
Retrieves information about the cluster.

### Method
GET

### Endpoint
/api/cluster-info

### Response
#### Success Response (200)
- No specific fields documented.

#### Response Example
{}

```

--------------------------------

### Load kubeconfig files from a directory with --kubeconfig-dir

Source: https://radarhq.io/docs/configuration/files

Use --kubeconfig-dir to load valid kubeconfig files from one or more directories. Discovery is non-recursive.

```bash
kubectl radar --kubeconfig-dir ~/.kube/configs/
```

--------------------------------

### Verify upgrade logs

Source: https://radarhq.io/docs/cloud/self-hosted/upgrade

Check the logs of the radar-hub deployment to ensure the control plane booted correctly and the database migration was successful.

```bash
kubectl -n radar-hub logs deploy/radar-hub-hub --tail=30
```

--------------------------------

### Check migrate initContainer logs

Source: https://radarhq.io/docs/cloud/self-hosted/troubleshooting

Use this command to view the migrate initContainer logs when the hub Pod is stuck in Init. Failure modes include 'relation "X" does not exist', 'password authentication failed', and 'connection refused'.

```bash
kubectl -n radar-hub logs deploy/radar-hub-hub -c migrate
```

--------------------------------

### POST /api/resources/preview

Source: https://radarhq.io/docs/reference/api

Previews a resource configuration before applying.

```APIDOC
## POST /api/resources/preview

### Description
Previews a resource configuration before applying.

### Method
POST

### Endpoint
/api/resources/preview

```
Tokens:
Raw