Skip to content

Commit 9789462

Browse files
authored
Fix 'service' terms references to workloads in Workload identity and resolution page (#287)
1 parent 03f6831 commit 9789462

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/reference/workload-identities/README.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Workload identity and resolution
55
Otterize supports two approaches for specifying workload identity in Kubernetes: explicit and implicit.
66

77
## Explicitly specifying `Kind`
8-
This approach requires specifying both the name, possibly with a namespace, and the kind of the service in the intent, ensuring precise identification.
8+
This approach requires specifying both the name, possibly with a namespace, and the kind of the workload in the intent, ensuring precise identification.
99
```yaml
1010
apiVersion: k8s.otterize.com/v2beta1
1111
kind: ClientIntents
@@ -24,17 +24,17 @@ This approach requires specifying both the name, possibly with a namespace, and
2424
- service:
2525
name: server.example-ns
2626
```
27-
In the YAML above, the service `client` is a `Deployment` in the namespace `otterize-tutorial-istio-mapping`, and it intends to call the service `server` is a `Service` in the namespace `example-ns`.
27+
In the YAML above, the workload `client` is a `Deployment` in the namespace `otterize-tutorial-istio-mapping`, and it intends to call the workload `server`, which is a `Service`, in the namespace `example-ns`.
2828

2929

3030
### Kubernetes workload identity resolution
3131
How do Otterize operators decide what is the identity of the workload that runs within the pod? The algorithm is as follows:
3232

33-
1. If the pod has an `intents.otterize.com/workload-name` annotation, its value is used as the service name. (You can change which annotation is used by setting `global.serviceNameOverrideAnnotationName` — see the [docs](/reference/otterize-chart#global-parameters).) This allows developers and
34-
automations to explicitly name services, if needed. The value must not contain a period `.` as a period is used to separate service name and namespace, when the service is from a different namespace: `svcname.namespace`.
33+
1. If the pod has an `intents.otterize.com/workload-name` annotation, its value is used as the workload name. (You can change which annotation is used by setting `global.workloadNameOverrideAnnotationName` — see the [docs](/reference/otterize-chart#global-parameters).) This allows developers and
34+
automations to explicitly name workloads, if needed. The value must not contain a period `.` as a period is used to separate workload name and namespace, when the workload is from a different namespace: `server.namespace`.
3535
2. If there is no `intents.otterize.com/workload-name` annotation, a recursive look-up is performed for the Kubernetes resource owner of
36-
the pod, until the root resource is reached, and its name is used as the service name. For example, if you have
36+
the pod, until the root resource is reached, and its name is used as the workload name. For example, if you have
3737
a `Deployment` named `checkoutservice`, which then creates and owns a `ReplicaSet`, which then creates and owns
38-
a `Pod`, then the service name for that pod is `checkoutservice` - same as the name of the `Deployment`. This is
39-
intended to capture the likely-more-meaningful "human name" of the service. If the resulting service name contains
40-
a period `.`, it is replaced with an underscore `_`. Periods are used in service names to denote namespaces, e.g. `svcname.namespace`.
38+
a `Pod`, then the workload name for that pod is `checkoutservice` - same as the name of the `Deployment`. This is
39+
intended to capture the likely-more-meaningful "human name" of the workload. If the resulting workload name contains
40+
a period `.`, it is replaced with an underscore `_`. Periods are used in workload names to denote namespaces, e.g. `server.namespace`.

0 commit comments

Comments
 (0)