Skip to content

Commit 8ca36ed

Browse files
authored
Document that 'kind:' field on ClientIntents is optional and add reference to workload identity and resolution docs (#284)
1 parent 72980a4 commit 8ca36ed

File tree

3 files changed

+2074
-2146
lines changed

3 files changed

+2074
-2146
lines changed

docs/reference/ClientIntents CRD/README.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ metadata:
2525
spec:
2626
workload:
2727
name: checkoutservice # Name of the workload initiating calls
28-
kind: Deployment # Type of workload (e.g., Deployment, StatefulSet, etc.)
28+
kind: Deployment # Type of workload (e.g., Deployment, StatefulSet, etc.); Optional, omit to auto-detect pod identity
2929
targets:
3030
- kubernetes:
3131
name: emailservice # Target Kubernetes resource name
32-
kind: Service # Kind of the Kubernetes resource
32+
kind: Service # Kind of the Kubernetes resource; Optional, omit to auto-detect pod identity
3333
- service: # Equivalent to kubernetes target with kind: Service
3434
name: orderservice # Target Service name
3535
http:

docs/reference/ClientIntents CRD/migrateToV2.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ workload:
4545

4646
**Fields**:
4747
- `name`: Name of the client workload initiating requests.
48-
- `kind`: The type of workload, such as `Deployment` or `StatefulSet`.
48+
- `kind`: The type of workload, such as `Deployment` or `StatefulSet`; Optional, omit to auto-detect pod identity. More info on [Workload identity and resolution](/reference/workload-identities).
4949

5050
**Changes**:
5151
- The field is renamed from `service` to `workload`.
@@ -103,7 +103,7 @@ targets:
103103
**Fields**:
104104
- `kubernetes`: Target is a Kubernetes resource.
105105
- `name`: The name of the target Kubernetes resource.
106-
- `kind`: The kind of Kubernetes resource (e.g., `Deployment`, `StatefulSet`).
106+
- `kind`: The kind of Kubernetes resource (e.g., `Deployment`, `StatefulSet`); ; Optional, omit to auto-detect pod identity. More info on [Workload identity and resolution](/reference/workload-identities).
107107
- `service`: Target is a Kubernetes Service. It's equivalent to the `kubernetes` target with `kind: Service`.
108108
- `name`: The name of the target Service.
109109

@@ -376,15 +376,15 @@ targets:
376376
---
377377

378378
### Summary
379-
| Feature | `v1alpha3` | `v2beta1` |
380-
|---------------------|---------------------------------|--------------------------------|
381-
| Client Workload | `service.name` | `workload.name`, `workload.kind` |
382-
| Target Field | `calls` | `targets` |
383-
| HTTP Resources | `HTTPResources` | `http` |
384-
| Kafka | `kafkaTopics` | `topics` |
385-
| SQL Databases | `databaseResources` | `sql.privileges` |
386-
| AWS | `name`, `awsActions` | `arn`, `actions` |
387-
| Azure | `name`, `azureRoles` | `scope`, `actions`, `dataActions` |
388-
| GCP | `name`, `gcpPermissions` | `resource`, `permissions` |
389-
| Internet | `internet` | `internet` |
379+
| Feature | `v1alpha3` | `v2beta1` |
380+
|-----------------|--------------------------|-----------------------------------|
381+
| Client Workload | `service.name` | `workload.name`, `workload.kind` |
382+
| Target Field | `calls` | `targets` |
383+
| HTTP Resources | `HTTPResources` | `http` |
384+
| Kafka | `kafkaTopics` | `topics` |
385+
| SQL Databases | `databaseResources` | `sql.privileges` |
386+
| AWS | `name`, `awsActions` | `arn`, `actions` |
387+
| Azure | `name`, `azureRoles` | `scope`, `actions`, `dataActions` |
388+
| GCP | `name`, `gcpPermissions` | `resource`, `permissions` |
389+
| Internet | `internet` | `internet` |
390390

0 commit comments

Comments
 (0)