Add missing className docs (#443)

Signed-off-by: Kevin Fox <[email protected]>
spiffe · Nov 4, 2024 · e2bbdf6 · e2bbdf6
1 parent b7ee203
commit e2bbdf6
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/docs/clusterspiffeid-crd.md b/docs/clusterspiffeid-crd.md
@@ -28,6 +28,7 @@ The definition can be found [here](../api/v1alpha1/clusterspiffeid_types.go).
 | `downstream`                | OPTIONAL | Indicates that the entry describes a downstream SPIRE server. |
 | `autoPopulateDNSNames`      | OPTIONAL | Indicates whether or not to auto populate service DNS names. |
 | `fallback`                  | OPTIONAL | Apply this ID only if there are no other matching non fallback ClusterSPIFFEIDs. |
+| `className`                 | OPTIONAL | The class name of the SPIRE controller manager. |
 
 ## ClusterSPIFFEIDStatus
 

diff --git a/docs/clusterstaticentry-crd.md b/docs/clusterstaticentry-crd.md
@@ -21,6 +21,7 @@ The definition can be found [here](../api/v1alpha1/clusterstaticentry_types.go).
 | `admin`                     | OPTIONAL | Indicates whether the target workload is an admin workload (i.e. can access SPIRE administrative APIs) |
 | `downstream`                | OPTIONAL | Indicates that the entry describes a downstream SPIRE server. |
 | `storeSVID`                 | OPTIONAL | Indicates whether the issued SVID must be stored through an SVIDStore plugin. |
+| `className`                 | OPTIONAL | The class name of the SPIRE controller manager. |
 
 ## ClusterStaticEntryStatus
 

diff --git a/docs/spire-controller-manager-config.md b/docs/spire-controller-manager-config.md
@@ -16,3 +16,5 @@ the following fields are defined:
 | `gcInterval`                         | OPTIONAL | `10s`                                            | How often the SPIRE state is reconciled when the controller is otherwise idle. This impacts how quickly SPIRE state will converge after CRDs are removed or SPIRE state is mutated underneath the controller. |
 | `spireServerSocketPath`              | OPTIONAL | `/spire-server/api.sock`                         | The path the the SPIRE Server API socket                                                                                                                                                                      |
 | `logLevel`                           | OPTIONAL | `info`                                           | The log level for the controller manager. Supported values are `info`, `error`, `warn` and `debug`.                                                                                                           |
+| `className`                          | OPTIONAL |                                                  | Only sync resources that have the specified className set on them.                                                                                                                                            |
+| `watchClassless`                     | OPTIONAL |                                                  | If className is set, also watch for resources that do not have any className set.                                                                                                                             |