Skip to content
Merged
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
100 changes: 100 additions & 0 deletions install/kubestellar-console/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Installing Microcks via KubeStellar Console

## Overview

[KubeStellar Console](https://console.kubestellar.io?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) is a multi-cluster Kubernetes dashboard with guided install missions for CNCF projects. The Microcks mission automates the standard Helm-based installation with pre-flight checks, step-by-step commands, validation queries, and rollback instructions.

This guide covers how to use the console's guided mission to install Microcks `1.13.2` on any Kubernetes cluster.

## Prerequisites

- Kubernetes cluster (v1.17+) with `kubectl` configured
- [Helm](https://helm.sh/docs/intro/install/) v3 installed
- Cluster-admin or namespace-admin permissions

## Option 1: Use the Guided Mission (Interactive)

The guided mission walks through each step interactively, querying your cluster to verify success at each stage.

### Install KubeStellar Console

```bash
curl -sSL https://raw.githubusercontent.com/kubestellar/console/main/start.sh | bash
```

This starts the console locally, connecting to your current kubeconfig context. No cloud account or OAuth required.

### Open the Microcks Mission

Navigate to the [Microcks install mission](https://console.kubestellar.io/missions/install-microcks?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) in the console. The mission executes these steps:

1. **Add the Microcks Helm repository**
```bash
helm repo add microcks https://microcks.io/helm
helm repo update
```

2. **Install Microcks via Helm**
```bash
helm install microcks microcks/microcks \
--namespace microcks \
--create-namespace \
--version 1.13.2
```

3. **Validate the installation**
```bash
kubectl get pods --namespace microcks
```
Expected: all pods in `Running` state (microcks, microcks-postman-runtime, microcks-mongodb, keycloak).

4. **Access the Microcks UI**
```bash
kubectl port-forward svc/microcks --namespace microcks 8080:8080
```
Open `http://localhost:8080` in your browser. Default credentials: `admin` / `microcks123`.

Each step includes validation — the console queries your cluster after each command to verify pods are running, services are reachable, and CRDs are registered. On failure, it reads pod logs and events to suggest fixes.

## Option 2: Use the Commands Directly

The mission works as read-only documentation too — no cluster connection required to browse the steps. You can copy-paste the commands above into any terminal.

## Uninstall

```bash
helm uninstall microcks --namespace microcks
kubectl delete namespace microcks
```

## Troubleshooting

| Symptom | Cause | Fix |
|---------|-------|-----|
| `microcks-mongodb` pod in `Pending` | No PVC provisioner | Install a CSI driver or use `--set mongodb.persistent=false` |
| `keycloak` pod in `CrashLoopBackOff` | Missing database connection | Check Keycloak logs: `kubectl logs -n microcks -l app=keycloak` |
| Port-forward fails with "connection refused" | Pod not ready | Wait for all pods: `kubectl wait --for=condition=ready pod -l app=microcks -n microcks --timeout=120s` |

## Solution Missions for Common Issues

In addition to the install mission, the console includes guided troubleshooting missions for the most commonly reported Microcks issues:

| # | Mission | Issue | What it fixes |
|---|---------|-------|---------------|
| 1 | [Keycloak authentication failure](https://console.kubestellar.io/missions/microcks-keycloak-authentication-failure?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) | [#1232](https://github.com/microcks/microcks/issues/1232) | "Failed to Initialize authentication Subsystem" — SSL requirement mismatch between Keycloak and Microcks |
| 2 | [Blank API/Services list](https://console.kubestellar.io/missions/microcks-ui-blank-api-list?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) | [#528](https://github.com/microcks/microcks/issues/528) | UI shows blank page when listing APIs — Keycloak SSL warning silently blocking requests |
| 3 | [Daily statistics error](https://console.kubestellar.io/missions/microcks-daily-statistics-error?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) | [#540](https://github.com/microcks/microcks/issues/540) | IncorrectResultSizeDataAccessException — duplicate MongoDB documents from concurrent replicas |
| 4 | [MongoDB PVC pending](https://console.kubestellar.io/missions/microcks-mongodb-pvc-pending?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) | Common | MongoDB pod stuck in Pending — no default StorageClass or missing CSI driver |
| 5 | [Fallback dispatcher not working](https://console.kubestellar.io/missions/microcks-fallback-dispatcher-not-working?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) | [#741](https://github.com/microcks/microcks/issues/741) | FALLBACK dispatcher always returns default response — incorrect JSON rules format |

Each mission walks through diagnosis, fix, and verification steps with commands you can run against your cluster.

## Mission Source

The mission definition is an open-source JSON file in the [console-kb](https://github.com/kubestellar/console-kb/blob/master/solutions/cncf-install/install-microcks.json?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) repository. PRs to improve the Microcks mission steps, add validation checks, or update versions are welcome.

## References

- [Microcks official documentation](https://microcks.io/documentation/)
- [Microcks Helm chart on ArtifactHub](https://artifacthub.io/packages/helm/microcks/microcks)
- [KubeStellar Console](https://console.kubestellar.io?utm_source=github&utm_medium=pr&utm_campaign=cncf_outreach&utm_term=microcks) — multi-cluster Kubernetes dashboard with 186 install missions for CNCF projects
Loading