Skip to content

Commit 1ff6ca3

Browse files
committed
chore: camel monitor renaming
1 parent c349d1d commit 1ff6ca3

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

docs/modules/ROOT/pages/installation/advanced/advanced.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ The following environment variables can be configured on the operator Deployment
6767
|`false`
6868
|When set to `true`, enables synthetic Integration support for managing external workloads.
6969

70-
|`CAMEL_DASHBOARD_APP_LABEL`
71-
|`camel.apache.org/app`
72-
|If it exists, the operator add this label beside regular Camel K labels in order to let the Camel Dashboard discover and monitor the application.
70+
|`CAMEL_MONITOR_OPERATOR_LABEL`
71+
|`camel.apache.org/monitor`
72+
|If it exists, the operator add this label beside regular Camel K labels in order to let the Camel Monitor operator discover and monitor the application.
7373

7474
|`LOG_LEVEL`
7575
|`info`

docs/modules/ROOT/pages/observability/dashboard.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
= Camel Dashboard
1+
= Camel Monitor Operator
22

3-
https://camel-tooling.github.io/camel-dashboard/[Camel Dashboard] is a Kubernetes operator that you can use to monitor your fleet of Camel applications deployed in the cloud. Whether you use Camel K to deploy or not, the Dashboard is a great tool that you can use to monitor your Camel fleet.
3+
https://camel-tooling.github.io/camel-dashboard/docs/installation-guide/advanced/operator/[Camel Monitor operator] is a Kubernetes operator that you can use to **monitor your fleet of Camel applications** deployed in the cloud. Whether you use Camel K to deploy or not, the Camel Monitor operator is a great tool that you can use to monitor your Camel fleet.
44

55
NOTE: the project is in developer preview mode.
66

7-
The Camel Dashboard was originally born as a spin off from Camel K Synthetic Integrations features and matured into a brand new operator whose goal is to provide a meaningful set of information about typical KPIs of your fleet of Camel workloads running on the cloud.
7+
The Camel Monitor operator (and the GUI exposed via https://camel-tooling.github.io/camel-dashboard/[Camel Dashboard]) was originally born as a spin off from Camel K Synthetic Integrations feature and matured into a brand new operator whose goal is to provide a meaningful set of information about typical KPIs of your fleet of Camel workloads running on the cloud.
88

9-
From Camel K version 2.10.0 onward, the applications deployed by the operator will be automatically instructed with the labels required by the Dashboard to discover and monitor. This is controlled via a Kubernetes label injected to the Deployments (or CronJob or KnativeService) configured on the operator side with the environment variable `CAMEL_DASHBOARD_APP_LABEL` (set by default to `camel.apache.org/app`).
9+
From Camel K version 2.10.0 onward, the applications deployed by the operator will be automatically instructed with the labels required by the Camel Monitor operator to discover and monitor. This is controlled via a Kubernetes label injected to the Deployments (or CronJob or KnativeService) configured on the Camel K operator side with the environment variable `CAMEL_MONITOR_OPERATOR_LABEL` (set by default to `camel.apache.org/monitor`).
1010

11-
On the Camel Dashboard side, any application containing the label will be watched and monitored providing a set of useful Camel metrics (for example, health, number of exchanges succeeded, failed, ...).
11+
On the Camel Monitor side, any application containing the label will be watched and monitored providing a set of useful Camel metrics (for example, health, number of exchanges succeeded, failed, ...).
1212

1313
You will need to include the `camel-observability-services` component into your application in order to get the full power of this monitoring tool. As an example:
1414

@@ -30,16 +30,16 @@ spec:
3030
simple: "Hello!"
3131
- to: "log:myLogger"
3232
traits:
33-
# We need a provide any version supporting camel-observability-services
33+
# We need a provide any version supporting camel-observability-services (introduced in Camel 4.9.0)
3434
camel:
3535
runtimeProvider: plain-quarkus
3636
runtimeVersion: 3.30.8
3737
```
3838

39-
The information will be stored in a Custom Resource provided by the Camel Dashboard installation procedure: `CamelApp`. Here a basic example:
39+
The information will be stored in a Custom Resource provided by the Camel Monitor installation procedure: `CamelMonitor` (or abbreviated to `cmon`). Here a basic example:
4040

4141
```bash
42-
$ kubectl get camelapp -w
42+
$ kubectl get cmon -w
4343

4444
NAME IMAGE PHASE REPLICAS HEALTHY MONITORED INFO EXCHANGE SLI LAST EXCHANGE
4545
camel-sample 10.104.35.69/camel-k/camel-k-kit-d67egl6snmec... Running 1 True True Quarkus - 3.30.8 (4.16.0) 4m3s
@@ -48,11 +48,11 @@ camel-sample 10.104.35.69/camel-k/camel-k-kit-d67egl6snmec... Running 1
4848
More in detail, the specific info are stored in the custom resource status:
4949

5050
```bash
51-
$ kubectl get camelapp -o yaml
51+
$ kubectl get cmon -o yaml
5252
apiVersion: v1
5353
items:
5454
- apiVersion: camel.apache.org/v1alpha1
55-
kind: CamelApp
55+
kind: CamelMonitor
5656
metadata:
5757
annotations:
5858
camel.apache.org/imported-from-kind: Deployment
@@ -99,6 +99,6 @@ items:
9999
samplingInterval: 60000000000
100100
```
101101

102-
NOTE: Camel K won't require the availability of Camel Dashboard to work, neither Camel Dashboard would require Camel K, they are independent projects which can cooperate to provide a Build and Monitoring tool.
102+
NOTE: Camel K won't require the availability of Camel Monitor operator to work, neither Camel Monitor operator would require Camel K. They are independent projects which can cooperate to provide a Build and Monitoring tool respectively.
103103

104104
Learn more by reading the official https://camel-tooling.github.io/camel-dashboard/[Camel Dashboard documentation].

pkg/resources/config/manager/operator-deployment.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ spec:
7272
valueFrom:
7373
fieldRef:
7474
fieldPath: metadata.namespace
75-
# Used to automatically enable Camel Dashboard project monitoring
76-
# Keep the default value or change it to the same label used by the dashboard
75+
# Used to automatically enable Camel Monitor operator project monitoring
76+
# Keep the default value or change it to the same label used by the project
7777
# Note: remove the variable to disable the feature.
78-
- name: CAMEL_DASHBOARD_APP_LABEL
79-
value: "camel.apache.org/app"
78+
- name: CAMEL_MONITOR_OPERATOR_LABEL
79+
value: "camel.apache.org/monitor"
8080
livenessProbe:
8181
httpGet:
8282
path: /healthz

pkg/trait/deployment_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ func createNominalDeploymentTest() (*deploymentTrait, *Environment) {
325325
}
326326

327327
func TestApplyDeploymentWithCamelDashboardLabel(t *testing.T) {
328-
t.Setenv(kubernetes.CamelDashboardAppLabelEnvVar, "my-dashboard-label")
328+
t.Setenv(kubernetes.CamelMonitorOperatorLabelEnvVar, "my-dashboard-label")
329329

330330
deploymentTrait, environment := createNominalDeploymentTest()
331331
err := deploymentTrait.Apply(environment)

pkg/util/kubernetes/labels.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ import (
2323
v1 "github.com/apache/camel-k/v2/pkg/apis/camel/v1"
2424
)
2525

26-
const CamelDashboardAppLabelEnvVar = "CAMEL_DASHBOARD_APP_LABEL"
26+
const CamelMonitorOperatorLabelEnvVar = "CAMEL_MONITOR_OPERATOR_LABEL"
2727

2828
// DeploymentLabels returns the fixed labels assigned to each Camel workload.
2929
func DeploymentLabels(integrationName string) map[string]string {
3030
labels := map[string]string{
3131
// Required by Camel K
3232
v1.IntegrationLabel: integrationName,
3333
}
34-
camelDashboardLabel, ok := os.LookupEnv(CamelDashboardAppLabelEnvVar)
34+
camelDashboardLabel, ok := os.LookupEnv(CamelMonitorOperatorLabelEnvVar)
3535
if ok && camelDashboardLabel != "" {
3636
// Will automatically enable App discovery by Camel Dashboard
3737
labels[camelDashboardLabel] = integrationName

0 commit comments

Comments
 (0)