kubero-dev / kubero-dev/kubero

[docs] Order of operations for install documentation - metrics stack requires operator

Open
#637 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
4.4k
Forks
213
PR merge metrics
No merged PRs in 30d

Description

### Which component(s) is affected?

Documentation

### Describe the bug

Just a quick heads up as I try things out: the order of operations for the install has the metrics stack being installed before the operator, which results in an error.

### Steps to reproduce

```sh
...
⬢ [kubero] ╰─λ kubero install -c certmanager [ 18:54:46 ]
No config file found; using defaults
Error while loading credentialsConfig file: Config File "credentials" Not Found in "[/etc/kubero /home/max/.kubero]"

Check for required binaries
✓ kubectl is installed
✓ kind is installed
⚠ gcloud is not installed (only required if you want to install a GKE cluster)

? 6) Install SSL Certmanager [y,n] y : y
run command : kubectl create -f https://github.com/cert-manager/cert-manager/releases/latest/download/cert-manager.yaml
✓ Cert Manager installed

? 6.1) Letsencrypt ACME contact email noreply@yourdomain.com : fwsch84@gmail.com

? 6.2) Clusterissuer Name letsencrypt-prod :
✓ Cert Manager Cluster Issuer created

⬢ [kubero] ╰─λ kubero install -c monitoring [ 18:56:21 ]
No config file found; using defaults
Error while loading credentialsConfig file: Config File "credentials" Not Found in "[/etc/kubero /home/max/.kubero]"

Check for required binaries
✓ kubectl is installed
✓ kind is installed
⚠ gcloud is not installed (only required if you want to install a GKE cluster)

? 7) Enable longterm metrics [y/n] y : y
✓ Namespace kubero created

? 7.1) Create local Prometheus instance [y/n] y : y
run command : kubectl apply -n kubero -f https://raw.githubusercontent.com/kubero-dev/kubero-operator/main/config/samples/application_v1alph
a1_kuberoprometheus.yaml
✗ Failed to run command. Try runnig this command manually: kubectl apply -f https://raw.githubusercontent.com/kubero-dev/kubero-operator/main/
config/samples/application_v1alpha1_kuberoprometheus.yaml
2025/04/16 18:58:02 exit status 1

# note this is an attempt to circumvent the error with recommended action
[🔴]⬢ [kubero] × kubectl apply -f https://raw.githubusercontent.com/kubero-dev/kubero-operator/main/config/samples/application_v1alpha1_kuber
oprometheus.yaml
error: resource mapping not found for name: "kubero-prometheus" namespace: "" from "https://raw.githubusercontent.com/kubero-dev/kubero-operat
or/main/config/samples/application_v1alpha1_kuberoprometheus.yaml": no matches for kind "KuberoPrometheus" in version "application.kubero.dev/
v1alpha1"
ensure CRDs are installed first

⬢ [kubero] ╰─λ kubero install -c kubero-operator [ 18:59:32 ]
No config file found; using defaults
Error while loading credentialsConfig file: Config File "credentials" Not Found in "[/etc/kubero /home/max/.kubero]"

Check for required binaries
✓ kubectl is installed
✓ kind is installed
⚠ gcloud is not installed (only required if you want to install a GKE cluster)

3) Install Kubero Operator
run command : kubectl apply -f https://raw.githubusercontent.com/kubero-dev/kubero-operator/main/deploy/operator.yaml
✓ Kubero Operator installed sucessfully

⬢ [kubero] ╰─λ kubero install -c monitoring [ 19:00:02 ]
No config file found; using defaults
Error while loading credentialsConfig file: Config File "credentials" Not Found in "[/etc/kubero /home/max/.kubero]"

Check for required binaries
✓ kubectl is installed
✓ kind is installed
⚠ gcloud is not installed (only required if you want to install a GKE cluster)

? 7) Enable longterm metrics [y/n] y : y
✓ Namespace kubero exists

? 7.1) Create local Prometheus instance [y/n] y : y
run command : kubectl apply -n kubero -f https://raw.githubusercontent.com/kubero-dev/kubero-operator/main/config/samples/application_v1alph
a1_kuberoprometheus.yaml
✓ Prometheus installed sucessfully

? 7.2) Enable Kubemetrtics [y/n] y : y
run command : kubectl patch kuberoes kubero -n kubero --type=merge
✓ Metrics enabled sucessfully
```

### Expected behavior

A typical user will expect the documentation to be in the correct order.

### Screenshots

_No response_

### Additional information

If I have a minute in the next couple days, I'll conjure a PR.

### Debug information

_No response_

Contributor guide

Open the contributing guide

Research direction

Locate the installation documentation covering `kubero install -c monitoring` and the `kubero-operator` installation command. Check that the operator is installed before applying the KuberoPrometheus resource, then verify the documented sequence against the commands shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation, infrastructure
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.