@@ -24,7 +24,11 @@ The following flags are available for all commands.
24
24
25
25
{{< /table >}}
26
26
27
+ <!-- vale Google.Headings = NO -->
28
+ <!-- vale Microsoft.Headings = NO -->
27
29
## version
30
+ <!-- vale Google.Headings = YES -->
31
+ <!-- vale Microsoft.Headings = YES -->
28
32
29
33
The ` crossplane version ` command returns the version of Crossplane CLI
30
34
and the control plane.
@@ -35,7 +39,9 @@ Client Version: v1.17.0
35
39
Server Version: v1.17.0
36
40
```
37
41
42
+ <!-- vale Google.Headings = NO -->
38
43
## render
44
+ <!-- vale Google.Headings = YES -->
39
45
40
46
The ` crossplane render ` command previews the output of a
41
47
[ composite resource] ({{<ref "../composition/composite-resources">}}) after applying
@@ -167,21 +173,25 @@ spec:
167
173
168
174
The schema of the resource isn't validated and may contain any data.
169
175
170
- # ## Mock Extra Resources
176
+ # ## Mock extra resources
171
177
172
178
Extra Resources allow a Composition to request Crossplane Objects on the cluster that aren't
173
179
part of the Composition. The `--extra-resources` option points at a directory containing
174
180
YAML manifests of resources to mock. Use Extra Resources in combination with a function like
175
181
[function-extra-resources](https://github.com/crossplane-contrib/function-extra-resources) or the
176
182
built-in support in [function-go-templating](https://github.com/crossplane-contrib/function-go-templating?tab=readme-ov-file#extraresources).
177
183
184
+ <!-- vale Google.Headings = NO -->
178
185
# # xpkg
186
+ <!-- vale Google.Headings = YES -->
179
187
180
188
The `crossplane xpkg` commands create, install and update Crossplane
181
- [packages]({{<ref "../packages/configurations">}}) as well as enable authentication
189
+ [packages]({{<ref "../packages/configurations">}}) and enable authentication
182
190
and publishing of Crossplane packages to a Crossplane package registry.
183
191
192
+ <!-- vale Google.Headings = NO -->
184
193
# ## xpkg build
194
+ <!-- vale Google.Headings = YES -->
185
195
186
196
Using `crossplane xpkg build` provides automation and simplification to build
187
197
Crossplane packages.
@@ -243,7 +253,7 @@ Include YAML files demonstrating how to use the package with `--examples-root`.
243
253
# ### Include a runtime image
244
254
245
255
Functions and Providers require YAML files describing their dependencies and
246
- settings as well as a container image for their runtime.
256
+ settings and a container image for their runtime.
247
257
248
258
Using `--embed-runtime-image-name` runs a specified image and
249
259
includes the image inside the function or provider package.
@@ -258,7 +268,9 @@ Use `docker pull` to download a missing image.
258
268
The `--embed-runtime-image-tarball` flag includes a local OCI image tarball
259
269
inside the function or provider package.
260
270
271
+ <!-- vale Google.Headings = NO -->
261
272
# ## xpkg init
273
+ <!-- vale Google.Headings = YES -->
262
274
263
275
The `crossplane xpkg init` command populates the current directory with
264
276
files to build a package.
@@ -279,14 +291,18 @@ The `<template>` value may be one of four well known templates:
279
291
Instead of a well known template the `<template>` value can be a git repository
280
292
URL.
281
293
294
+ <!-- vale Google.Headings = NO -->
282
295
# ### NOTES.txt
296
+ <!-- vale Google.Headings = YES -->
283
297
284
298
If the template repository contains a `NOTES.txt` file in its root directory,
285
299
the `crossplane xpkg init` command prints the contents of the file to the
286
300
terminal after populating the directory with the template files. This can be
287
301
useful for providing information about the template.
288
302
303
+ <!-- vale Google.Headings = NO -->
289
304
# ### init.sh
305
+ <!-- vale Google.Headings = YES -->
290
306
291
307
If the template repository contains an `init.sh` file in its root directory, the
292
308
` crossplane xpkg init` command starts a dialog after populating the
@@ -305,7 +321,9 @@ personalize the template.
305
321
{{< /table >}}
306
322
307
323
324
+ <!-- vale Google.Headings = NO -->
308
325
# ## xpkg install
326
+ <!-- vale Google.Headings = YES -->
309
327
310
328
Download and install packages into Crossplane with `crossplane xpkg install`.
311
329
@@ -375,7 +393,9 @@ Read more about
375
393
[package revisions]({{< ref "../packages/configurations#configuration-revisions" >}})
376
394
in the package documentation.
377
395
396
+ <!-- vale Google.Headings = NO -->
378
397
# ## xpkg login
398
+ <!-- vale Google.Headings = YES -->
379
399
380
400
Use `xpkg login` to authenticate to registries that host Crossplane packages.
381
401
@@ -430,7 +450,9 @@ Authenticate to a registered organization in the Upbound Marketplace with the
430
450
For example,
431
451
` crossplane xpkg login --account=Upbound --username=my-user --password -` .
432
452
453
+ <!-- vale Google.Headings = NO -->
433
454
# ## xpkg logout
455
+ <!-- vale Google.Headings = YES -->
434
456
435
457
Use `crossplane xpkg logout` to invalidate the current `crossplane xpkg login`
436
458
session.
@@ -440,7 +462,9 @@ Using `crossplane xpkg logout` removes the `session` from the
440
462
` ~/.crossplane/config.json` file, but doesn't delete the configuration file.
441
463
{{< /hint >}}
442
464
465
+ <!-- vale Google.Headings = NO -->
443
466
# ## xpkg push
467
+ <!-- vale Google.Headings = YES -->
444
468
445
469
Push a Crossplane package file to a package registry.
446
470
@@ -478,7 +502,9 @@ DockerHub organization `crossplane-docs/my-package:v0.14.0` use:
478
502
| `-f` | `--package-files=PATH` | A comma-separated list of xpkg files to push. |
479
503
{{< /table >}}
480
504
505
+ <!-- vale Google.Headings = NO -->
481
506
# ## xpkg update
507
+ <!-- vale Google.Headings = YES -->
482
508
483
509
The `crossplane xpkg update` command downloads and updates an existing package.
484
510
@@ -499,7 +525,9 @@ For example, to update to the latest version of the
499
525
` crossplane xpkg update provider xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.21.1`
500
526
501
527
528
+ <!-- vale Google.Headings = NO -->
502
529
# # beta
530
+ <!-- vale Google.Headings = YES -->
503
531
504
532
Crossplane `beta` commands are experimental. These commands may change the
505
533
flags, options or outputs in future releases.
@@ -508,7 +536,9 @@ Crossplane maintainers may promote or remove commands under `beta` in future
508
536
releases.
509
537
510
538
539
+ <!-- vale Google.Headings = NO -->
511
540
# ## beta convert
541
+ <!-- vale Google.Headings = YES -->
512
542
513
543
As Crossplane evolves, its APIs and resources may change. To help with the
514
544
migration to the new APIs and resources, the `crossplane beta convert` command
@@ -547,7 +577,9 @@ By default the function name is "function-patch-and-transform."
547
577
{{< /table >}}
548
578
549
579
580
+ <!-- vale Google.Headings = NO -->
550
581
# ## beta top
582
+ <!-- vale Google.Headings = YES -->
551
583
552
584
The command `crossplane beta top` shows CPU and memory usage of Crossplane
553
585
related pods.
@@ -591,7 +623,9 @@ running the `top` command may produce an error, for example,
591
623
`crossplane : error: error adding metrics to pod, check if metrics-server is running or wait until metrics are available for the pod: the server is currently unable to handle the request (get pods.metrics.k8s.io crossplane-contrib-provider-helm-b4cc4c2c8db3-6d787f9686-qzmz2)`
592
624
593
625
626
+ <!-- vale Google.Headings = NO -->
594
627
# ## beta trace
628
+ <!-- vale Google.Headings = YES -->
595
629
596
630
Use the `crossplane beta trace` command to display a visual relationship of
597
631
Crossplane objects. The `trace` command supports XRs, compositions,
@@ -826,7 +860,9 @@ Configuration/platform-ref-aws v0.9.0 True
826
860
# Removed for brevity
827
861
` ` `
828
862
863
+ <!-- vale Google.Headings = NO -->
829
864
# ## beta validate
865
+ <!-- vale Google.Headings = YES -->
830
866
831
867
The `crossplane beta validate` command validates
832
868
[compositions]({{<ref "../composition/compositions">}}) against provider or XRD
@@ -953,7 +989,9 @@ crossplane render xr.yaml composition.yaml function.yaml --include-full-xr | cro
953
989
Total 5 resources: 0 missing schemas, 4 success cases, 1 failure cases
954
990
` ` `
955
991
992
+ <!-- vale Google.Headings = NO -->
956
993
# ### Validate Common Expression Language rules
994
+ <!-- vale Google.Headings = YES -->
957
995
958
996
XRDs can define [validation rules](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation-rules) expressed in the Common Expression Language
959
997
([CEL](https://kubernetes.io/docs/reference/using-api/cel/)).
0 commit comments