Skip to content

Commit b435490

Browse files
authored
Merge pull request #356 from guettli/patch-1
📖 README: Added AddonProvider.
2 parents 5669f73 + 6aa5022 commit b435490

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ kubectl delete infrastructureprovider azure
242242

243243
## Overview
244244

245-
The Cluster API Operator introduces new API types: `CoreProvider`, `BootstrapProvider`, `ControlPlaneProvider`, and `InfrastructureProvider`. These four provider types share common Spec and Status types, `ProviderSpec` and `ProviderStatus`, respectively.
245+
The Cluster API Operator introduces new API types: `CoreProvider`, `BootstrapProvider`, `ControlPlaneProvider`, `InfrastructureProvider`, and `AddonProvider`. These five provider types share common Spec and Status types, `ProviderSpec` and `ProviderStatus`, respectively.
246246

247247
The CRDs are scoped to be namespaced, allowing RBAC restrictions to be enforced if needed. This scoping also enables the installation of multiple versions of controllers (grouped within namespaces) in the same management cluster.
248248

@@ -296,7 +296,18 @@ type InfrastructureProvider struct {
296296
}
297297
```
298298

299-
The following sections provide details about `ProviderSpec` and `ProviderStatus`, which are shared among all the provider types: Core, Bootstrap, ControlPlane, and Infrastructure.
299+
*AddonProvider*
300+
```golang
301+
type AddonProvider struct {
302+
metav1.TypeMeta `json:",inline"`
303+
metav1.ObjectMeta `json:"metadata,omitempty"`
304+
305+
Spec AddonProviderSpec `json:"spec,omitempty"`
306+
Status AddonProviderStatus `json:"status,omitempty"`
307+
}
308+
```
309+
310+
The following sections provide details about `ProviderSpec` and `ProviderStatus`, which are shared among all the provider types.
300311

301312
## Provider Spec
302313

0 commit comments

Comments
 (0)