Skip to content

Commit 2c55063

Browse files
committed
update readme
1 parent 3cc44c3 commit 2c55063

File tree

1 file changed

+39
-19
lines changed

1 file changed

+39
-19
lines changed

README.md

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -54,44 +54,63 @@ This can be useful for tracking additional dimensions of the resource, such as f
5454
The projections are then translated to dimensions in the metric.
5555

5656
```yaml
57-
apiVersion: metrics.cloud.sap/v1alpha
57+
apiVersion: metrics.cloud.sap/v1alpha1
5858
kind: Metric
5959
metadata:
6060
name: comp-pod
6161
spec:
6262
name: comp-metric-pods
6363
description: Pods
6464
target:
65-
resource: pods
65+
kind: Pod
6666
group: ""
6767
version: v1
68-
frequency: 1 # in minutes
68+
interval: "1m"
6969
projections:
7070
- name: pod-namespace
7171
fieldPath: "metadata.namespace"
7272
---
7373
```
7474

75+
### Managed Metric
76+
77+
Managed metrics are used to monitor crossplane managed resources. They automatically track resources that have the "crossplane" and "managed" categories in their CRDs.
78+
79+
```yaml
80+
apiVersion: metrics.cloud.sap/v1alpha1
81+
kind: ManagedMetric
82+
metadata:
83+
name: managed-metric
84+
spec:
85+
name: managed-metric
86+
description: Status metric created by an Operator
87+
kind: Release
88+
group: helm.crossplane.io
89+
version: v1beta1
90+
interval: "1m"
91+
---
92+
```
93+
7594
### Federated Metric
7695
Federated metrics deal with resources that are spread across multiple clusters. To monitor these resources, you need to define a `FederatedMetric` resource.
7796
They offer capabilities to aggregate data as well as filtering down to a specific cluster or field using projections.
7897
```yaml
79-
apiVersion: metrics.cloud.sap/v1beta1
98+
apiVersion: metrics.cloud.sap/v1alpha1
8099
kind: FederatedMetric
81100
metadata:
82101
name: xfed-prov
83102
spec:
84103
name: xfed-prov
85104
description: crossplane providers
86105
target:
87-
group: pkg.crossplane.io
88-
resource: providers
106+
kind: Provider
107+
group: pkg.crossplane.io
89108
version: v1
90-
frequency: 1 # in minutes
109+
interval: "1m"
91110
projections:
92111
- name: package
93112
fieldPath: "spec.package"
94-
federateCaRef:
113+
federateClusterAccessRef:
95114
name: federate-ca-sample
96115
namespace: default
97116
---
@@ -104,15 +123,15 @@ The pre-condition here is that if a resource comes from a crossplane provider, i
104123

105124

106125
```yaml
107-
apiVersion: metrics.cloud.sap/v1beta1
126+
apiVersion: metrics.cloud.sap/v1alpha1
108127
kind: FederatedManagedMetric
109128
metadata:
110129
name: xfed-managed
111130
spec:
112131
name: xfed-managed
113132
description: crossplane managed resources
114-
frequency: 1 # in minutes
115-
federateCaRef:
133+
interval: "1m"
134+
federateClusterAccessRef:
116135
name: federate-ca-sample
117136
namespace: default
118137
---
@@ -121,14 +140,15 @@ spec:
121140
## Remote Cluster Access
122141

123142

124-
### Cluster Access
125-
The Metrics Operator can monitor both the cluster it's deployed in and remote clusters. To monitor a remote cluster, define a `ClusterAccess` resource:
143+
### Remote Cluster Access
144+
145+
The Metrics Operator can monitor both the cluster it's deployed in and remote clusters. To monitor a remote cluster, define a `RemoteClusterAccess` resource:
126146

127-
This cluster access resource can be used by `CompoundMetric` resources to monitor resources in the remote cluster.
147+
This remote cluster access resource can be used by `Metric` and `ManagedMetric` resources to monitor resources in the remote cluster.
128148

129149
```yaml
130-
apiVersion: metrics.cloud.sap/v1beta1
131-
kind: ClusterAccess
150+
apiVersion: metrics.cloud.sap/v1alpha1
151+
kind: RemoteClusterAccess
132152
metadata:
133153
name: remote-cluster
134154
namespace: <monitoring-namespace>
@@ -147,17 +167,17 @@ spec:
147167
To monitor resources across multiple clusters, define a `FederatedClusterAccess` resource:
148168

149169
```yaml
150-
apiVersion: metrics.cloud.sap/v1beta1
170+
apiVersion: metrics.cloud.sap/v1alpha1
151171
kind: FederatedClusterAccess
152172
metadata:
153173
name: federate-ca-sample
154174
namespace: default
155175
spec:
156176
target:
177+
kind: ControlPlane
157178
group: core.orchestrate.cloud.sap
158-
resource: controlplanes #plural always, lowecase only
159179
version: v1beta1
160-
kubeConfigPath: spec.target.kubeconfig #case sensitive
180+
kubeConfigPath: spec.target.kubeconfig
161181
```
162182

163183

0 commit comments

Comments
 (0)