-
Notifications
You must be signed in to change notification settings - Fork 596
/
reference.md
1245 lines (1015 loc) · 37.6 KB
/
reference.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# OLM Descriptor Reference
#### [specDescriptors](#specDescriptors-1):
1. [podCount](#1-podcount)
2. [resourceRequirements](#2-resourcerequirements)
3. [k8sResourcePrefix](#3-k8sResourcePrefix)
4. [booleanSwitch](#4-booleanswitch)
5. [checkbox](#5-checkbox)
6. [text](#6-text)
7. [number](#7-number)
8. [password](#8-password)
9. [updateStrategy](#9-updatestrategy)
10. [imagePullPolicy](#10-imagepullpolicy)
11. [nodeAffinity](#11-nodeaffinity)
12. [podAffinity](#12-podaffinity)
13. [podAntiAffinity](#13-podantiaffinity)
14. [selector](#14-selector)
15. [_DEPRECATED_ fieldGroup](#fieldGroup)
16. [_DEPRECATED_ arrayFieldGroup](#arrayFieldGroup)
17. [select](#17-select)
18. [advanced](#18-advanced)
19. [endpointList](#19-endpointList)
20. [fieldDependency](#20-fielddependency)
21. [hidden](#21-hidden)
---------------------------------------
#### [statusDescriptors](#statusDescriptors-1):
1. [podStatuses](#1-podStatuses)
2. [w3Link](#2-w3Link)
3. [conditions](#3-conditions)
4. [text](#4-text)
5. [k8sPhase](#5-k8sPhase)
6. [k8sPhaseReason](#6-k8sPhaseReason)
7. [k8sResourcePrefix](#7-k8sResourcePrefix)
---------------------------------------
#### [DEPRECATED Descriptors](#deprecated-descriptors-1)
15. [fieldGroup](#fieldGroup)
16. [arrayFieldGroup](#arrayFieldGroup)
## specDescriptors
A specDescriptor is for describing the property of a `spec` field in your Custom Resource. Each entry should contain the following:
* `displayName` - _The user-friendly name of the field_
* `description` - _Concise information about what the field represents_
* `path` - _The dot-delimited path of the field in the object_
* `x-descriptors` (Optional) - _UI component information about the field capabilities_
You can customize how a field is presented in the UI with a specDescriptor. Use a user-friendly `displayName` and concise `description` to overwrite the field name and potentially lengthy description of a field in the schema based on where the `path` is pointing to. This applies to any schema property and in any level of the nested structures.
The `x-descriptors` is used to determine which "capabilities" this descriptor has and which UI component to use on different views in the OpenShift Console.
For example, some `x-descriptors` also provides a "DISPLAY VIEW" that allows you to expose the specified schema property on Operand's Details view in the console as well as on the Creation Form. A canonical list of React UI `x-descriptors` for OpenShift can be found below.
You can see more information on [Operand's Creation Forms](../../descriptors#create-operand-form).
### x-descriptors
#### 1. podCount
**x-descriptors**
This descriptor allows you to specify the number of pods for your instance. See example from [[CSV] etcd Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/etcd/0.9.4/etcdoperator.v0.9.4.clusterserviceversion.yaml#L48-L52):
```yaml
…
- displayName: Size
description: The desired number of member Pods for the etcd cluster.
path: size
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:podCount'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/1-1_pod-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/1-2_pod-dis.png" /></td>
</tr>
<tr valign="top">
<td width="50%">MODIFY VIEW
<img src="img/spec/1-3_pod-mod.png" /></td>
</tr>
</table>
#### 2. resourceRequirements
**x-descriptors**
This descriptor allows you to specify the mini/max amount of compute resources required/allowed. See example from [[CSV] etcd Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/etcd/0.9.4/etcdoperator.v0.9.4.clusterserviceversion.yaml#L53-L58):
```yaml
…
- description: Limits describes the minimum/maximum amount of compute resources
required/allowed
displayName: Resource Requirements
path: pod.resources
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:resourceRequirements
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/2-1_resrc-req-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/2-2_resrc-req-dis.png" /></td>
</tr>
<tr valign="top">
<td width="50%">MODIFY VIEW - Resource Limits
<img src="img/spec/2-3_resrc-req-mod.png" /></td>
<td width="50%">MODIFY VIEW - Resource Requests
<img src="img/spec/2-4_resrc-req-mod.png" /></td>
</tr>
</table>
#### 3. k8sResourcePrefix
**x-descriptors**
This descriptor allows you to specify the prerequisite kubernetes object (e.g. _Secrets, ServiceAccount, Service, ConfigMap, Namespace, etc_) for your instance. See example from
[[CSV] Couchbase Operator](https://github.com/operator-framework/community-operators/blob/1591b5e18d47129ed14e83ac2f9832d6cb41bb40/upstream-community-operators/couchbase-enterprise/1.2.2/manifests/couchbase-v1.2.2.clusterserviceversion.yaml#L100-L105):
```yaml
…
- description: The name of the secret object that stores the server's TLS
certificate.
displayName: Server TLS Secret
path: tls.static.member.serverSecret
x-descriptors:
- urn:alm:descriptor:io.kubernetes:Secret
…
```
With optional label selector being specified:
```yaml
…
x-descriptors:
- urn:alm:descriptor:io.kubernetes:Deployment?tier!=frontend,environment in (production, qa)'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/3-1_k8s-obj-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/3-2_k8s-obj-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2" >MODIFY VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Modify View”. Users would have to edit the content of the actual kubernetes object being specified.</i></small></h6>
</td>
</tr>
</table>
#### 4. booleanSwitch
**x-descriptors**
This descriptor allows you to specify the _true_ or _false_ value for the configuration. See example from [[CSV] Eclipse Che Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/eclipse-che/7.8.0/eclipse-che.v7.8.0.clusterserviceversion.yaml#L78-L82):
```yaml
…
- description: TLS routes
displayName: TLS Mode
path: server.tlsSupport
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/4-1_switch-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/4-2_switch-dis.png" /></td>
</tr>
<tr valign="top">
<td width="50%">MODIFY VIEW
<img src="img/spec/4-3_switch-mod.png" /></td>
</tr>
</table>
#### 5. checkbox
**x-descriptors**
This descriptor allows you to specify the _true_ or _false_ value for the configuration. See example for Business Automation Operator:
```yaml
…
- displayName: ImageRegistry Insecure
description: A flag used to indicate the specified registry is insecure.
path: imageRegistry.insecure
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:checkbox'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/5-1_checkbox-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/5-2_checkbox-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><i><b>* </b>Display View also serves as the Modify view.</i></small></h6>
</td>
</tr>
</table>
#### 6. text
**x-descriptors**
This descriptor allows you to specify a text input for a _string_ data type. See example from [[CSV] Portworx Operator](https://github.com/operator-framework/community-operators/blob/master/upstream-community-operators/portworx/1.1.0/portworxoperator.v1.1.0.clusterserviceversion.yaml#L243-L247):
```yaml
…
- path: image
displayName: Image
description: The docker image name and version of Portworx Enterprise.
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:text'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/6-1_text-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/6-2_text-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Modify View”. Users would have to edit the content with YAML editor.</i></small></h6>
</td>
</tr>
</table>
#### 7. number
**x-descriptors**
This descriptor allows you to specify a number input for a _number_ data type. See example from [[CSV] KEDA Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/keda/2.3.0/manifests/keda.v2.3.0.clusterserviceversion.yaml#L269L273):
```yaml
…
- displayName: Cooldown Period
description: Cooldown Period
path: cooldownPeriod
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:number'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/7-1_num-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/7-2_num-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Modify View”. Users would have to edit the content with YAML editor.</i></small></h6>
</td>
</tr>
</table>
#### 8. password
**x-descriptors**
This descriptor allows you to specify a text input for a _password_ data type. See example for Grafana Operator:
```yaml
…
- displayName: Admin Password
description: The Admin Password of Grafana.
path: adminPassword
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:password'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/8-1_passwd-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/8-2_passwd-dis.png" />
<img src="img/spec/8-3_passwd-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Modify View”. Users would have to edit the content with YAML editor.</i></small></h6>
</td>
</tr>
</table>
#### 9. updateStrategy
**x-descriptors**
This descriptor allows you to specify the strategy of your pods being replaced when a new version of the deployment exist. See example for Portworx Operator:
```yaml
…
- displayName: Update Strategy
description: The update strategy of the deployment
path: updateStrategy
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:updateStrategy'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/9-1_updatestrategy-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/9-2_updatestrategy-dis.png" />
<h6><small><b>[TODO]</b><i> Missing the display of "Max Unavailable" and "Max Surge"</small></i></p>
</tr>
<tr valign="top">
<td width="50%">MODIFY VIEW
<img src="img/spec/9-3_updatestrategy-mod.png" /></td>
</tr>
</table>
#### 10. imagePullPolicy
**x-descriptors**
This descriptor allows you to specify the policy for pulling your container image. See example from [[CSV] Appsody Operator](https://github.com/operator-framework/community-operators/blob/master/upstream-community-operators/appsody-operator/0.3.0/appsody-operator.v0.3.0.clusterserviceversion.yaml#L49-L53):
```yaml
…
- description: image pull policy for container image
displayName: Pull Policy
path: pullPolicy
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:imagePullPolicy
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/10-1_imgpullpolicy-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/10-2_imgpullpolicy-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>[TODO]</b><i> * Currently Missing - The DISPLAY VIEW should be a text link to be able to access MODIFY VIEW that renders widget on the modal.
</i></small></h6>
</td>
</tr>
</table>
#### 11. nodeAffinity
**x-descriptors**
This descriptor allows you to specify which nodes your pod is eligible to be scheduled on based on _labels on the node_. See example for Prometheus Operator:
```yaml
…
- displayName: Node Affinity
description: Node affinity is a group of node affinity scheduling
path: affinity.nodeAffinity
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:nodeAffinity'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/11-1_nodeaff-new.png" />
<td width="50%">DISPLAY VIEW
<img src="img/spec/11-2_nodeaff-dis.png" />
<h6><small><b>[TODO]</b><i> cannot display the configuration</small></i></p></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>[TODO]</b><i> * Currently Missing - The DISPLAY VIEW should be a text link to be able to access MODIFY VIEW that renders widget on the modal.
</i></small></h6>
</td>
</tr>
</table>
#### 12. podAffinity
**x-descriptors**
This descriptor allows you to specify which nodes your pod is eligible to be scheduled based on _labels on pods_ that are already running on the node. See example for Prometheus Operator:
```yaml
…
- displayName: Pod Affinity
description: Pod affinity is a group of inter pod affinity scheduling rules.
path: affinity.podAffinity
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:podAffinity'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/12-1_podaff-new.png" />
<td width="50%">DISPLAY VIEW
<img src="img/spec/12-2_podaff-dis.png" />
<h6><small><b>[TODO]</b><i> cannot display the configuration</small></i></p></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>[TODO]</b><i> * Currently Missing - The DISPLAY VIEW should be a text link to be able to access MODIFY VIEW that renders widget on the modal.
</i></small></h6>
</td>
</tr>
</table>
#### 13. podAntiAffinity
**x-descriptors**
This descriptor allows you to specify which nodes your pod is eligible to be scheduled based on _labels on pods_ that are already running on the node. See example for Prometheus Operator:
```yaml
…
- displayName: Pod Anti Affinity
description: Pod anti affinity is a group of inter pod anti affinity scheduling rules.
path: affinity.podAntiAffinity
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:podAntiAffinity'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/13-1_podantiaff-new.png" />
<td width="50%">DISPLAY VIEW
<img src="img/spec/13-2_podantiaff-dis.png" />
<h6><small><b>[TODO]</b><i> cannot display the configuration</small></i></p></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>[TODO]</b><i> * Currently Missing - The DISPLAY VIEW should be a text link to be able to access MODIFY VIEW that renders widget on the modal.
</i></small></h6>
</td>
</tr>
</table>
#### 14. selector
**x-descriptors**
This descriptor allows you to specify labels for identifying a set of objects via a _label selector_ (The label selector is the core grouping primitive in Kubernetes). See example from [[CSV] Prometheus Operator](https://github.com/operator-framework/community-operators/blob/master/upstream-community-operators/prometheus/0.27.0/prometheusoperator.0.27.0.clusterserviceversion.yaml#L41L45):
```yaml
…
- description: A selector for the ConfigMaps from which to load rule files
displayName: Rule Config Map Selector
path: ruleSelector
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:selector:core:v1:ConfigMap
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<h6><small><b>[TODO]</b><i> * Currently Missing - The CREATION VIEW should allow users to define “a set of labels” for “matchLabels”, similar to Console’s “Search” view.
</i></small></h6></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/14-2_selector-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>[TODO]</b><i> Currently Missing</i></small></h6>
</td>
</tr>
</table>
See Kubernetes doc for details in
[resources-that-support-set-based-requirement](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#resources-that-support-set-based-requirements).
#### 15. fieldGroup
This x-descriptor has been __deprecated__. See the [entry in the deprecated](#fieldGroup) section.
#### 16. arrayFieldGroup
This x-descriptor has been __deprecated__. See the [entry in the deprecated](#arrayFieldGroup) section.
#### 17. select
**x-descriptors**
This descriptor allows you to specify a set of predefined options (e.g. `enum:` type) for a dropdownUI component. See example from [[CSV] Strimzi Apache Kafka Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/strimzi-kafka-operator/0.17.0/strimzi-cluster-operator.v0.17.0.clusterserviceversion.yaml#L343-L349):
```yaml
…
- description: The type of storage used by Kafka brokers
displayName: Kafka storage
path: kafka.storage.type
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:select:ephemeral
- urn:alm:descriptor:com.tectonic.ui:select:persistent-claim
- urn:alm:descriptor:com.tectonic.ui:select:jbod
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/17-1_select-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/17-2_select-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Modify View”. Users would have to edit the content of the actual kubernetes object being specified.</i></small></h6>
</td>
</tr>
</table>
#### 18. advanced
**x-descriptors**
This descriptor allows you to specify fields as "Advanced Configurations" for any schema property. The advanced fields will be displayed within a collapsible section at the bottom of the parent schema structure. See example for Business Automation Operator:
```yaml
…
- description: Selected if the image registry is insecure.
displayName: Insecure
path: imageRegistry.insecure
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:booleanSwitch'
- 'urn:alm:descriptor:com.tectonic.ui:advanced'
- description: >- Image registry's base 'url:port'. e.g. registry.example.com:5000.
Defaults to 'registry.redhat.io'.
displayName: Registry
path: imageRegistry.registry
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:text'
- 'urn:alm:descriptor:com.tectonic.ui:advanced'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/18-1_advanced-new.png" /></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/18-2_advanced-dis.png" />
<h6><small><b>[TODO]</b><i> * Currently Missing.</i></small></h6></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Modify View”.</i></small></h6></td>
</tr>
</table>
#### 19. endpointList
**x-descriptors**
This descriptor is created specifically for Prometheus Operator to specify a list of endpoints allowed for the ServiceMonitor it manages. See example from [[CSV] Prometheus Operator](https://github.com/operator-framework/community-operators/blob/master/upstream-community-operators/prometheus/0.27.0/prometheusoperator.0.27.0.clusterserviceversion.yaml#L82L86):
```yaml
…
- description: A list of endpoints allowed as part of this ServiceMonitor
displayName: Endpoints
path: endpoints
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:endpointList
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Creation View”.</small></i></p></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/19-2_endpoints-dis.png" /></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>* </b><i> Currently, this descriptor does not provide “Modify View”. Users would have to edit the content with YAML editor.</i></small></h6>
</td>
</tr>
</table>
#### 20. fieldDependency
**x-descriptors**
This descriptor allows you to specify a field as the dependent of a Control Field and shows the Dependent Field when the current value of the Control Field is equal to the expected value:
```yaml
'urn:alm:descriptor:com.tectonic.ui:fieldDependency:CONTROL_FIELD_PATH:EXPECTED_VALUE'
```
**Usage**
1. Add "fieldDependency" to 'x-descriptors' array of the Dependent Field(s).
2. Replace "CONTROL_FIELD_PATH" with the 'path' property of the Control Field object.
3. Replace "EXPECTED_VALUE" with the actual expected value.
**Requirements**
1. The Dependent Field will be exposed right after the Control Field on the form (_ignores the rules mentioned in [Ordering of Form Fields](../../descriptors#ordering-of-form-fields)_).
2. The Dependent Field doesn't have to be a "leaf" in the schema.
The Dependent Field(s) will be displayed only when the current value of the Control Field is equal to the expected value.
**Example**
```yaml
…
- displayName: Enable Upgrades
description: >-
Set true to enable automatic micro version product upgrades, it is disabled by default.
path: upgrades.enabled
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:booleanSwitch'
- displayName: Include minor version upgrades
description: >-
Set true to enable automatic minor product version upgrades, it is
disabled by default. Requires spec.upgrades.enabled to be true.
path: upgrades.minor
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:fieldDependency:upgrades.enabled:true'
- 'urn:alm:descriptor:com.tectonic.ui:booleanSwitch'
…
```
**UI**
<table style="width:100%">
<tr valign="top">
<td width="50%">CREATION VIEW
<img src="img/spec/20-1_fielddependency-new.png" />
<br>
<h6><small><b>* </b> When "Enable Upgrades" (CONTROL FIELD) is set to "TRUE":</small></h6>
<img src="img/spec/20-2_fielddependency-new.png" />
</td></td>
<td width="50%">DISPLAY VIEW
<img src="img/spec/20-2_fielddependency-dis.png" />
<h6><small><b>[TODO]</b><i> cannot display the dependency</small></i></p></td>
</tr>
<tr valign="top">
<td colspan="2">MODIFY VIEW
<h6><small><b>* </b><i>Currently, this descriptor does not provide “Modify View”.</i></small></h6>
</td>
</tr>
</table>
#### 21. hidden
**x-descriptors**
This descriptor allows you to exclude non-user facing fields from the "auto-generated creation form" by specifying them as "hidden" schema fields. See example for Portworx Operator:
```yaml
…
- displayName: HIDDEN FIELDS - Network and all its children fields
description: >-
HIDDEN FIELDS - The network related fields to be used by Portworx for data traffic.
path: network
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:hidden'
- displayName: HIDDEN FIELDS - Start Port
description: >-
HIDDEN FIELDS - It is the starting port in the range of ports used by Portworx.
path: startPort
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:hidden'
…
```
**Usage**
1. You can apply "hidden" to any schema property path (doesn't have to be a "leaf" in the schema). All the children properties, if any, will be hidden as well.
2. The descriptor will hide the target property and all of its child fields.
3. The field(s) will be hidden on the UI but can still be accessed through the YAML editor.
---------------------------------------
## statusDescriptors
A statusDescriptor is for describing the property of a `status` field in your Custom Resource. The structure of the statusDescriptors is similar to specDescriptors and includes the same fields. The only difference is the set of valid `x-descriptors` described below.
### x-descriptors
#### 1. podStatuses
**x-descriptors**
This descriptor allows you to expose the status of pods for your instance. It expects the output format in the status block of your instance in:
```yaml
…
status:
[PATH_TO_THE_FIELD]:
[STATE_1]:
- [FIELD_MEMBER_NAME]
- [FIELD_MEMBER_NAME]
- [FIELD_MEMBER_NAME]
[STATE_2]:
- [FIELD_MEMBER_NAME]
- [FIELD_MEMBER_NAME]
[STATE_3]:
- [FIELD_MEMBER_NAME]
…
```
**Example**
See example from [[CSV] 3Scale Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/3scale-community-operator/0.4.0/3scale-community-operator.v0.4.0.clusterserviceversion.yaml#L61-L65):
```yaml
…
- displayName: Deployments
description: API Manager Deployment Configs
path: deployments
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:podStatuses'
…
```
The status block of the field being specified:
```yaml
…
status:
deployments:
ready:
- apicast-staging
- system-memcache
- system-redis
- zync-database
starting:
- apicast-production
- backend-cron
- backend-listener
- backend-redis
- backend-worker
- system-mysql
- system-sidekiq
- system-sphinx
- zync
- zync-que
stopped:
- system-app
…
```
**On the DISPLAY VIEW:**
<table style="width:100%">
<tr valign="top">
<td width="50%">
<img src="img/status/1-1_podStatuses.png" />
<h6><small>Hover over to see the number of members in "ready" state.</small></h6>
</td>
<td width="50%">
<img src="img/status/1-2_podStatuses.png" />
<h6><small>Hover over to see the number of members in "starting" state.</small></h6>
</td>
</tr>
</table>
#### 2. w3Link
**x-descriptors**
This descriptor allows you to expose an external link of your instance. It expects the output format in the status block of your instance in:
```yaml
…
status:
[PATH_TO_THE_FIELD]: [FIELD_VALUE]
…
```
**Example**
See example from [[CSV] Eclipse Che Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/eclipse-che/7.8.0/eclipse-che.v7.8.0.clusterserviceversion.yaml#L84-L88):
```yaml
…
- description: Route to access Eclipse Che
displayName: Eclipse Che URL
path: cheURL
x-descriptors:
- urn:alm:descriptor:org.w3:link
…
```
The status block of the field being specified:
```yaml
…
status:
…
cheURL: 'http://che-tony.apps.rhamilto.devcluster.openshift.com'
…
```
**On the DISPLAY VIEW:**
<table style="width:100%">
<tr valign="top">
<td width="50%">
<img src="img/status/2-1_w3Link.png" />
<h6><small>Click on the link sends users to target URL.</small></h6>
</td>
<td width="50%">
<img src="img/status/2-2_w3Link.png" />
<h6><small>Hover over displayName shows descriptions on tooltip.</small></h6>
</td>
</tr>
</table>
#### 3. conditions
**x-descriptors**
This descriptor allows you to expose an array of PodConditions of your instance. It expects the output format in the status block of your instance in:
```yaml
…
status:
[PATH_TO]:
conditions:
- lastTransitionTime: [VALUE]
lastUpdateTime: [VALUE]
message: [VALUE]
reason: [VALUE]
status: [VALUE]
type: [VALUE]
…
```
**Example**
See example from [CSV] Nexus Operator:
```yaml
…
- displayName: Deployment Conditions
description: Nexus server deployment conditions
path: deploymentStatus.conditions
x-descriptors:
- 'urn:alm:descriptor:io.kubernetes.conditions'
…
```
The status block of the field being specified:
```yaml
…
status:
deploymentStatus:
conditions:
- lastTransitionTime: '2020-02-22T01:00:10Z'
lastUpdateTime: '2020-02-22T01:00:10Z'
message: Deployment does not have minimum availability.
reason: MinimumReplicasUnavailable
status: 'False'
type: Available
- lastTransitionTime: '2020-02-22T01:00:10Z'
lastUpdateTime: '2020-02-22T01:00:10Z'
message: ReplicaSet "nexus3-5dc585f884" is progressing.
reason: ReplicaSetUpdated
status: 'True'
type: Progressing
…
```
**On the DISPLAY VIEW:**
<table style="width:100%">
<tr valign="top">
<td width="50%">
<img src="img/status/3-1_conditions.png" />
<h6><small>Hover over displayName shows descriptions on tooltip.</small></h6>
</td>
<td width="50%">
</td>
</tr
<tr valign="top">
<td colspan="2">
<img src="img/status/3-2_conditions.png" />
<h6><small><i><b>* </b>Note that Openshift Console shows `status.conditions` in a full-width table at the bottom of the object details view by default even without this "conditions" statusDescriptor.</i></small></h6>
</td>
</tr>
</table>
#### 4. text
**x-descriptors**
This descriptor allows you to expose the status field of your instance in plain text.
**Example**
See example from [[CSV] Spark Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/spark-gcp/2.4.0/sparkoperator.v2.4.0.clusterserviceversion.yaml#L69-L73):
```yaml
…
- displayName: Application State
description: Current state of the application.
path: applicationState.state
x-descriptors:
- urn:alm:descriptor:text
…
```
The status block of the field being specified:
```yaml
…
status:
applicationState:
state: SUBMITTED
…
```
**On the DISPLAY VIEW:**
<table style="width:100%">
<tr valign="top">
<td width="50%">
<img src="img/status/4-1_text.png" />
<h6><small>Hover over displayName shows descriptions on tooltip.</small></h6>
</td>
<td width="50%">
</td>
</tr>
</table>
#### 5. k8sPhase
**x-descriptors**
This descriptor allows you to expose the status phase of your instance in plain text.
**Example**
See example from [[CSV] KEDA Operator](https://github.com/operator-framework/community-operators/blob/master/community-operators/keda/1.4.1/manifests/keda.v1.4.1.clusterserviceversion.yaml#L129L133):
```yaml
…
- path: phase
description: Phase
displayName: Phase
x-descriptors:
- 'urn:alm:descriptor:io.kubernetes.phase'
…
```