Skip to content

Commit 8df1adc

Browse files
committed
move around a bit of content. Trim down how much MRDs are on the front page docs
Signed-off-by: Scott Nichols <[email protected]>
1 parent b1f70b3 commit 8df1adc

File tree

4 files changed

+27
-157
lines changed

4 files changed

+27
-157
lines changed

content/master/guides/implementing-safestart.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -97,55 +97,6 @@ rules:
9797
verbs: ["get", "list", "watch"]
9898
```
9999

100-
### Step 3: Add connection details documentation
101-
102-
Document connection details in your MRDs to help users understand resource
103-
capabilities:
104-
105-
```yaml
106-
# Example generated MRD with connection details
107-
apiVersion: apiextensions.crossplane.io/v1alpha1
108-
kind: ManagedResourceDefinition
109-
metadata:
110-
name: databases.rds.aws.example.io
111-
spec:
112-
group: rds.aws.example.io
113-
names:
114-
kind: Database
115-
plural: databases
116-
scope: Namespaced
117-
118-
# safe-start-specific fields
119-
connectionDetails:
120-
- name: endpoint
121-
description: "The RDS instance connection endpoint"
122-
type: string
123-
fromConnectionSecretKey: endpoint
124-
- name: port
125-
description: "The port number for database connections"
126-
type: integer
127-
fromConnectionSecretKey: port
128-
- name: username
129-
description: "The master username for the database"
130-
type: string
131-
fromConnectionSecretKey: username
132-
- name: password
133-
description: "The master password for the database"
134-
type: string
135-
fromConnectionSecretKey: password
136-
- name: ca_certificate
137-
description: "The CA certificate for SSL connections"
138-
type: string
139-
fromConnectionSecretKey: ca_certificate
140-
141-
# Standard CRD specification
142-
versions:
143-
- name: v1alpha1
144-
served: true
145-
storage: true
146-
# ... rest of CRD spec
147-
```
148-
149100
## Testing safe-start implementation
150101

151102
### Integration testing

content/master/managed-resources/managed-resource-definitions.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,22 +123,42 @@ resources.
123123
apiVersion: apiextensions.crossplane.io/v1alpha1
124124
kind: ManagedResourceDefinition
125125
metadata:
126-
name: instances.ec2.aws.crossplane.io
126+
name: databases.rds.aws.crossplane.io
127127
spec:
128+
group: rds.aws.crossplane.io
129+
names:
130+
kind: Database
131+
plural: databases
132+
scope: Namespaced
133+
134+
# Connection details documentation
128135
connectionDetails:
129136
- name: endpoint
130-
description: The connection endpoint for the database
137+
description: "The RDS instance connection endpoint"
131138
type: string
139+
fromConnectionSecretKey: endpoint
132140
- name: port
133-
description: The port number for connections
141+
description: "The port number for database connections"
134142
type: integer
143+
fromConnectionSecretKey: port
135144
- name: username
136-
description: The master username for the database
145+
description: "The master username for the database"
137146
type: string
147+
fromConnectionSecretKey: username
138148
- name: password
139-
description: The master password for the database
149+
description: "The master password for the database"
140150
type: string
141151
fromConnectionSecretKey: password
152+
- name: ca_certificate
153+
description: "The CA certificate for SSL connections"
154+
type: string
155+
fromConnectionSecretKey: ca_certificate
156+
157+
# Standard CRD specification follows...
158+
versions:
159+
- name: v1alpha1
160+
served: true
161+
storage: true
142162
```
143163
144164
The `connectionDetails` field documents:

content/master/whats-crossplane/_index.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,13 @@ involved in writing a controller.
4646

4747
## Crossplane components
4848

49-
Crossplane has four major components:
49+
Crossplane has three major components:
5050

5151
* [Composition](#composition)
5252
* [Managed resources](#managed-resources)
53-
* [Managed Resource Definitions](#managed-resource-definitions)
5453
* [Package manager](#package-manager)
5554

56-
You can use all four components to build your control plane, or pick only the
55+
You can use all three components to build your control plane, or pick only the
5756
ones you need.
5857

5958
### Composition
@@ -224,51 +223,6 @@ GCP, Terraform, Helm, GitHub, etc to support Crossplane v2 soon.
224223
<!-- vale gitlab.FutureTense = YES -->
225224
{{</hint>}}
226225

227-
### Managed resource definitions
228-
229-
Managed Resource Definitions (MRDs) provide selective activation and improved
230-
documentation for managed resources.
231-
232-
**MRDs solve performance problems with large providers.** Installing a provider
233-
like AWS creates hundreds of custom resource definitions (CRDs), even if you
234-
only need some resources. This can overload your Kubernetes API server.
235-
236-
With MRDs, providers create lightweight resource definitions that aren't
237-
activated until you need them. You use activation policies to control which
238-
resources become available in your cluster.
239-
240-
```mermaid
241-
flowchart LR
242-
provider(Provider Package)
243-
mrd1(S3 MRD)
244-
mrd2(RDS MRD)
245-
mrd3(EC2 MRD)
246-
policy(Activation Policy)
247-
crd1(S3 CRD)
248-
crd2(RDS CRD)
249-
250-
provider --> mrd1
251-
provider --> mrd2
252-
provider --> mrd3
253-
254-
policy -.->|activates| mrd1
255-
policy -.->|activates| mrd2
256-
mrd3 -.->|inactive|
257-
258-
mrd1 --> crd1
259-
mrd2 --> crd2
260-
261-
style mrd1 fill:#c8e6c9
262-
style mrd2 fill:#c8e6c9
263-
style mrd3 fill:#ffcdd2
264-
```
265-
266-
MRDs also document what connection details each managed resource provides,
267-
making it easier to understand resource capabilities before you use them.
268-
269-
Follow [Get Started with MRDs]({{<ref "../get-started/get-started-with-mrds">}})
270-
to see how managed resource definitions work.
271-
272226
### Package manager
273227

274228
The Crossplane package manager lets you install new managed resources and

content/master/whats-new/_index.md

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -172,61 +172,6 @@ deprecate and remove cluster scoped MRs at a future date.
172172
Read more about Crossplane v2's [backward compatibility](#backward-compatibility).
173173
{{</hint>}}
174174

175-
## Managed resource definitions
176-
177-
Crossplane v2 introduces Managed Resource Definitions (MRDs) that provide
178-
selective resource activation and improved resource discovery.
179-
180-
**MRDs solve performance and usability challenges with large providers.**
181-
Installing a provider like AWS traditionally creates hundreds of CRDs, even if
182-
you only need some resources. MRDs let you activate only the resources you
183-
actually use.
184-
185-
```mermaid
186-
flowchart LR
187-
provider(Provider Package)
188-
mrd1(S3 Bucket MRD)
189-
mrd2(EC2 Instance MRD)
190-
mrd3(RDS DB MRD)
191-
crd1(S3 Bucket CRD)
192-
crd2(EC2 Instance CRD)
193-
policy(Activation Policy)
194-
195-
provider --> mrd1
196-
provider --> mrd2
197-
provider --> mrd3
198-
199-
policy -.->|activates| mrd1
200-
policy -.->|activates| mrd2
201-
mrd3 -.->|inactive|
202-
203-
mrd1 --> crd1
204-
mrd2 --> crd2
205-
206-
style mrd1 fill:#c8e6c9
207-
style mrd2 fill:#c8e6c9
208-
style mrd3 fill:#ffcdd2
209-
style crd1 fill:#e8f5e8
210-
style crd2 fill:#e8f5e8
211-
```
212-
213-
### Key managed resource definition benefits
214-
215-
**Performance optimization** - Only create CRDs for resources you need, reducing
216-
cluster overhead and improving provider installation speed.
217-
218-
**Connection details discovery** - MRDs document what connection details each
219-
managed resource provides, making it easier to understand resource capabilities.
220-
221-
**Policy-based activation** - Use ManagedResourceActivationPolicy (MRAP) to
222-
activate resources with flexible pattern matching.
223-
224-
**safe-start providers** - Providers can opt into safe-start capability, starting
225-
with all MRDs inactive for better performance.
226-
227-
Learn more about [Managed Resource Definitions]({{<ref "../managed-resources/managed-resource-definitions">}})
228-
and [get started with MRDs]({{<ref "../get-started/get-started-with-mrds">}}).
229-
230175
## Compose any resource
231176

232177
Crossplane v2 isn't opinionated about using composition together with managed

0 commit comments

Comments
 (0)