Skip to content

Commit e0a38db

Browse files
committed
linter
Signed-off-by: Scott Nichols <[email protected]>
1 parent 3fcc447 commit e0a38db

File tree

8 files changed

+210
-185
lines changed

8 files changed

+210
-185
lines changed

content/master/get-started/get-started-with-mrds.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ that, by default, activates **all** managed resources with a `"*"` pattern.
3636

3737
{{< hint "important" >}}
3838
The default `"*"` activation pattern defeats the performance benefits of
39-
SafeStart by activating all resources. For this tutorial, we work with the
39+
safe-start by activating all resources. For this tutorial, the guide works with the
4040
default behavior, but production setups should use more selective activation.
4141
{{< /hint >}}
4242

@@ -46,7 +46,7 @@ Check if you have a default activation policy:
4646
kubectl get mrap crossplane-default-activation-policy -o yaml
4747
```
4848

49-
You can modify the default activation policy directly:
49+
You can edit the default activation policy directly:
5050

5151
{{< tabs >}}
5252
{{< tab "Edit Existing Policy" >}}
@@ -62,7 +62,7 @@ kubectl patch mrap crossplane-default-activation-policy --type='merge' \
6262

6363
{{< hint "note" >}}
6464
Changes to the default policy are permanent. After the policy exists, Crossplane
65-
won't modify it, even if you change Helm values.
65+
doesn't change it, even if you change Helm values.
6666
{{< /hint >}}
6767
{{< /tab >}}
6868

@@ -85,9 +85,9 @@ Learn more about configuring default activation policies during installation
8585
and best practices in the [MRD activation policies guide]({{< ref "../guides/mrd-activation-policies#default-activation-policy" >}}).
8686
{{< /hint >}}
8787

88-
## Install a SafeStart provider
88+
## Install a provider with safe-start capability
8989

90-
Now install a provider that supports SafeStart. This provider creates MRDs
90+
Now install a provider that supports safe-start. This provider creates MRDs
9191
that activation policies control.
9292

9393
```yaml
@@ -123,7 +123,7 @@ NAME INSTALLED HEALTHY PACKAGE
123123
provider-aws True True xpkg.upbound.io/crossplane-contrib/provider-aws 2m
124124
```
125125

126-
## Examine the MRDs
126+
## Examine the managed resource definitions
127127

128128
List the MRDs created by the provider:
129129

@@ -146,7 +146,7 @@ clusters.eks.aws.crossplane.io Active 2m
146146
# ... many more, all Active
147147
```
148148

149-
The default policy activates all MRDs, so SafeStart providers behave like
149+
The default policy activates all MRDs, so safe-start providers behave like
150150
traditional providers.
151151
{{< /tab >}}
152152

@@ -162,14 +162,14 @@ clusters.eks.aws.crossplane.io Inactive 2m
162162
# ... many more, all Inactive
163163
```
164164

165-
This demonstrates true SafeStart behavior where resources must be explicitly
165+
This demonstrates true safe-start behavior where resources must be explicitly
166166
activated.
167167
{{< /tab >}}
168168
{{< /tabs >}}
169169

170170
{{< hint "note" >}}
171-
For the rest of this tutorial, we assume you have default activation
172-
disabled to demonstrate selective activation. If you have default activation
171+
For the rest of this tutorial, the guide assumes you have default activation
172+
disabled to show selective activation. If you have default activation
173173
enabled, the MRDs are already active.
174174
{{< /hint >}}
175175

@@ -195,7 +195,7 @@ spec:
195195
type: string
196196
```
197197
198-
## Verify CRD creation behavior
198+
## Verify resource creation behavior
199199
200200
The presence of CRDs depends on whether MRDs are active:
201201
@@ -207,8 +207,8 @@ Because MRDs are active due to the default `"*"` policy, CRDs exist:
207207
kubectl get crds | grep aws.crossplane.io | wc -l
208208
```
209209

210-
This shows many CRDs (100+), demonstrating that active MRDs
211-
create CRDs immediately.
210+
This shows 100+ CRDs, demonstrating that active MRDs
211+
create CRDs.
212212
{{< /tab >}}
213213

214214
{{< tab "With Disabled Default Activation" >}}
@@ -288,9 +288,9 @@ dbinstances.rds.aws.crossplane.io Active 5m
288288
# ... other RDS resources
289289
```
290290

291-
## Verify CRDs are created
291+
## Verify custom resource definition creation
292292

293-
Now that MRDs are active, CRDs should exist:
293+
Now that MRDs are active, CRDs exist:
294294

295295
```shell
296296
kubectl get crds | grep -E "(instances.ec2|buckets.s3|rds)" | head -5
@@ -321,8 +321,8 @@ spec:
321321
```
322322
323323
{{< hint "note" >}}
324-
This example assumes you have AWS credentials configured. See the
325-
[AWS Provider documentation]({{< ref "../guides/aws-provider" >}}) for
324+
This example assumes you have AWS credentials configured. See
325+
[ProviderConfig documentation]({{< ref "../managed-resources/managed-resources#providerconfigref" >}}) for
326326
authentication setup.
327327
{{< /hint >}}
328328
@@ -428,16 +428,16 @@ status:
428428
Compare the resource usage with traditional provider installation:
429429

430430
**Without MRDs (traditional):**
431-
- All ~200 AWS CRDs created immediately
431+
- All ~200 AWS CRDs created when provider installs
432432
- Higher memory usage in kube-apiserver
433433
- Longer provider installation time
434434

435435
**With MRDs and selective activation:**
436-
- Only activated CRDs created (~10-20 in this example)
436+
- Only activated CRDs created (10 to 20 in this example)
437437
- Lower memory footprint
438438
- Faster resource discovery and management
439439

440-
Check the number of AWS CRDs currently in your cluster:
440+
Check the number of AWS CRDs in your cluster:
441441

442442
```shell
443443
kubectl get crds | grep aws.crossplane.io | wc -l
@@ -463,7 +463,7 @@ spec:
463463
EOF
464464
```
465465

466-
The activations from both policies are combined, giving you fine-grained
466+
Both policies combine their activations, giving you fine-grained
467467
control over resource availability.
468468

469469
## Clean up
@@ -522,9 +522,9 @@ Now that you understand MRDs and activation policies, you can:
522522
* **Optimize cluster performance** by using selective activation
523523
* **Improve resource discovery** through MRD connection details documentation
524524
* **Implement environment-specific policies** for different deployment stages
525-
* **Plan provider adoption** using SafeStart-capable providers
525+
* **Plan provider adoption** using safe-start-capable providers
526526
527527
Learn more about:
528528
* [MRD activation policies best practices]({{< ref "../guides/mrd-activation-policies" >}}) - Comprehensive guide including default policy configuration
529529
* [Managed Resource Definitions concepts]({{< ref "managed-resource-definitions" >}})
530-
* [Provider capabilities and SafeStart]({{< ref "../packages/provider-capabilities" >}})
530+
* [Provider capabilities and safe-start]({{< ref "../packages/provider-capabilities" >}})

0 commit comments

Comments
 (0)