Document that 'kind:' field on ClientIntents is optional and add refe…

…rence to workload identity and resolution docs (#284)
otterize · Feb 10, 2025 · 8ca36ed · 8ca36ed
1 parent 72980a4
commit 8ca36ed
Show file tree

Hide file tree

Showing 3 changed files with 2,074 additions and 2,146 deletions.
diff --git a/docs/reference/ClientIntents CRD/README.mdx b/docs/reference/ClientIntents CRD/README.mdx
@@ -25,11 +25,11 @@ metadata:
 spec:
   workload:
     name: checkoutservice # Name of the workload initiating calls
-    kind: Deployment # Type of workload (e.g., Deployment, StatefulSet, etc.)
+    kind: Deployment # Type of workload (e.g., Deployment, StatefulSet, etc.); Optional, omit to auto-detect pod identity
   targets:
     - kubernetes:
         name: emailservice # Target Kubernetes resource name
-        kind: Service # Kind of the Kubernetes resource
+        kind: Service # Kind of the Kubernetes resource; Optional, omit to auto-detect pod identity
     - service: # Equivalent to kubernetes target with kind: Service
         name: orderservice # Target Service name
         http:

diff --git a/docs/reference/ClientIntents CRD/migrateToV2.mdx b/docs/reference/ClientIntents CRD/migrateToV2.mdx
@@ -45,7 +45,7 @@ workload:
 
 **Fields**:
   - `name`: Name of the client workload initiating requests.
-  - `kind`: The type of workload, such as `Deployment` or `StatefulSet`.
+  - `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).
 
 **Changes**:
   - The field is renamed from `service` to `workload`.
@@ -103,7 +103,7 @@ targets:
 **Fields**:
   - `kubernetes`: Target is a Kubernetes resource.
     - `name`: The name of the target Kubernetes resource.
-    - `kind`: The kind of Kubernetes resource (e.g., `Deployment`, `StatefulSet`).
+    - `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).
   - `service`: Target is a Kubernetes Service. It's equivalent to the `kubernetes` target with `kind: Service`.
     - `name`: The name of the target Service.
 
@@ -376,15 +376,15 @@ targets:
 ---
 
 ### Summary
-| Feature             | `v1alpha3`                     | `v2beta1`                    |
-|---------------------|---------------------------------|--------------------------------|
-| Client Workload     | `service.name`                 | `workload.name`, `workload.kind` |
-| Target Field        | `calls`                        | `targets`                     |
-| HTTP Resources      | `HTTPResources`                | `http`                        |
-| Kafka               | `kafkaTopics`                  | `topics`                      |
-| SQL Databases       | `databaseResources`            | `sql.privileges`              |
-| AWS                 | `name`, `awsActions`           | `arn`, `actions`              |
-| Azure               | `name`, `azureRoles`           | `scope`, `actions`, `dataActions` |
-| GCP                 | `name`, `gcpPermissions`       | `resource`, `permissions`     |
-| Internet            | `internet`                     | `internet`                    |
+| Feature         | `v1alpha3`               | `v2beta1`                         |
+|-----------------|--------------------------|-----------------------------------|
+| Client Workload | `service.name`           | `workload.name`, `workload.kind`  |
+| Target Field    | `calls`                  | `targets`                         |
+| HTTP Resources  | `HTTPResources`          | `http`                            |
+| Kafka           | `kafkaTopics`            | `topics`                          |
+| SQL Databases   | `databaseResources`      | `sql.privileges`                  |
+| AWS             | `name`, `awsActions`     | `arn`, `actions`                  |
+| Azure           | `name`, `azureRoles`     | `scope`, `actions`, `dataActions` |
+| GCP             | `name`, `gcpPermissions` | `resource`, `permissions`         |
+| Internet        | `internet`               | `internet`                        |