From 96821f773b58eb68dcc9d282f3eec3a05003b0fb Mon Sep 17 00:00:00 2001 From: "dsoni@redhat.com" Date: Thu, 27 Oct 2022 15:39:33 +0530 Subject: [PATCH] RHDEVDOCS-4281: Adding content for enabling or disabling Developer catalogs or sub-catalogs --- images/odc_customizing_developer_catalog.png | Bin 0 -> 7551 bytes ...developer-catalog-or-its-sub-catalogs.adoc | 30 +++++++++ .../odc_con_example-yaml-file-changes.adoc | 63 ++++++++++++++++++ ...-its-sub-catalogs-using-the-form-view.adoc | 32 +++++++++ ...-its-sub-catalogs-using-the-yaml-view.adoc | 49 ++++++++++++++ web_console/customizing-the-web-console.adoc | 8 +++ 6 files changed, 182 insertions(+) create mode 100644 images/odc_customizing_developer_catalog.png create mode 100644 modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc create mode 100644 modules/odc_con_example-yaml-file-changes.adoc create mode 100644 modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc create mode 100644 modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc diff --git a/images/odc_customizing_developer_catalog.png b/images/odc_customizing_developer_catalog.png new file mode 100644 index 0000000000000000000000000000000000000000..8fd236feb74b574a21f68e6154a35cb5c1326d29 GIT binary patch literal 7551 zcmc(EbzGBw^e>2rK}a_!BHc*GL^_oa>D~ZoMt8S>AUW6+5u{5xCQ7HYEYoKJjD4Lckkdn zd2iPq;=XQ!U#J`0#aYl@yExo$dM{-oFMT(Vm#?)a5YOJ#%>~F0w)F%8UBM1+Ui$=a zc|1I3a&;vI1HZi8MPI*nXl(DHeUuVASB>H(X4;}&b&{qlS$mf}f}vt;y1c!6sV<>Z zPt4@W*LGD~H|nSL6zWQzA)$Heef?7Eq!gX|r%eJg8Q>B7C1mi(eKt3eL*?Wo9Po1owl-&XZ!J%M^1f;{UyqDJ#rC!VyKO@J90NoCkgzL-1-wj7(V%RggMJB#Hb$x0n!z zGc~q4+@52;5@C-d6&So1=V&5Wj6%oOXq9)u8X8ApKLAHdGO7! zEQUnC?~t5{AKv`ty6Uv6|M%Wi?R2YqU0Z>zf95>qdCg>8%PCU^$y}G^YsFMa_aY98 z-7jf)#VZRo9tyhNzCOPHBt(IBl#+$~5QCxo3xPkuQ?*;R1ad4K7ydzdWJAFoE=l2q&$9Hc z(QG_~ z`{1&41xc(c6tvj9+Y~_i)7w*1zuBmg|HzNe@ITV!q?K|S%hHwc#&F!V zJ>H(YW`UVK-d~Hg=N0~i!945Hy{?;BS|mSZhAf_Qz`>P#{P~vQb+sfOct)_>TS-o3 z4>}qzgHm_3cjFN~JpkQEVQKC9@7xrZ2)EP1P&}lY<3BIz&JnG*zPk}MC?-&S6Ik#6 zy_mQm<0dH^m=L^ob%56PF_W=lnyAp9q?=$Fxl}9~vWg3;A^9&7$r`D*ZRR6+i{LUe zE^1bhu#&W53M(z9TZ~sjn-SN|tn^Xa%bg2tLBHObJ8i9&sQpR$xd5$!4ZEngA7BW1 z-Z{jV`3g_NjtM?$)|965P%pHRmYDxpCTOsf?fca6;QL6jXSy_{&h4nE>LRoOshLcF zHfzv3=7m<(u1(}a8kNsAi+4q$UTt4Cq>7V-i;_}GIxvSTigR>jcje}ZuMl5A> zzxfUN)`2YxYh4*>BWw|cRD80G={MRoIZjd=xoy!CzDhL;g?aOyQ3%TjWHwt8oqnfyF!Aaxnf(x1$Lf}OdO;np`isT^Wa(PNcK|a9Wkf0&s%X0^b%tgCpCLMJ5JsCRLpMR2W@?>M+d?t zFa68v^`vq3qCZ`scJFjp*#W!_bgIt*{^-%nfM@6JDJHkC-y&5Pq@sAnml`ebBFNabi4WB5c}vrKvFWhe)GohabIe9iaB_$>3^M5BtCZ{J0G6@v1Ebk*;cj& z{yqcf64(tXSY4D#-gDiH`Zr`7BZc?9^#9!X z56}NOal`*t&JyPKN*lJhkmU#C({pv9EJ1UPEo(KVN<`C0dMao9oU2|QZM<03%$oJD z&xI@zzc+?TMAhY@Zqr_|OP0hQsI+1?@bP^K(gNt%j$jh<;dH-_of3kL;%r!H3e+mE zir_>iSGm6qgysT+t?Mm5Gn`6!9vnC^m*Ep!w*~6UhjN2-&VUnD@Ubtz-Wll_fVeC0 zusr%O^MOADhC#&^LQW7XGUMx`M~1AwXwheNwP=6uu-oHp!Cn~GclXB=nDGhg1f)9D zMQSO9Rq~8M#l~DOKP42=qFhfwZCQdXqzlAW23t6V>dtcuFShuI>dwEsPlRUvsM0^s zM9ZiByRNuuayo*$?jra)^EN|HTwCeiO^5-BV+CP<4%R5Wc4oUz&|kT2SITGBG~ML; z(VI>TU&aWr$9Ymd3HhAZLZ_-dD*jXY3hAdeM9s9PLk|@yC|;)r&~bRTZRwT-tQE4v zC?RF6-?jmz{en9)z=xK*8e7+a?g)I0?=HmddfsMuoHe}=kz_226#XcnL&|MgdIO=+ zq|lu7Nu#ZEzM+slI|I%12TOAJs%2@|O_PUM#etH2Q12Z`A8yAMKX+~})2LM@9A z4%~@-V%V8~LU@#GSN*2ZL7SK=2F)d!s+RmEkVkj^xs9Hh`&}t;JIqLt@;&=Wk7amu zcbb3VVYyKvKO@X?$$5Rb+aC*7Qc@Ax7{s6C(SLV{NU0BKmgC}z3zzFC&|5wl$`Mag zW5fSlYfUMpVOV6gly=2PclWu2AKltCPjbHCb0B%Bzsy_$3n*w%AHxIwnq~m7` z1rdMlVAjdXWIp8ESGeSGX$tObqB*(wOmyOm$UnN!7#sST2(}-|-GZS3sudzrUkwY` zL^&>QRR^L3wwhSfm5*q6MjCYIlAKXgR7_=~P*uQz(#*ysavgYgV6 zn}a#S8Z0VGUKcTt@XlBdC%gvPl7vtUeP^-MZFTl8&G@PY8`?kO2feJI@i1C=oXRtEB;U&Bn|>>{e1nwuIF_Ob^I0<7R*H9$e*&j> z#RMXju8Y=u%uRjQi>b>F`QAh#dy`FF(AK}62;@m=rid^3WtLe7-2CYvcy@g77uh0I z!9Ic@5IynL(|qokgSB`3Cwu~M(Qtt?l!AEULM$bMl|TqwD+r}_(*3Lj6tHY24nv3o zTE6Y{Ro^H&Onf99mThbDyNNIk#9<)PgqC1hXh%F7*>I^pakhCYsL?m^YEIm_KL!?p z4~4bnn|l4R_#;;~U!bAuJAuTZ;l6dQ{@qV@^fX@^qEbOO9U3X0AJSJNkOhfX8f!?T$8`d`$f39>|K0m+n5% zvHg&k%V@UCRq!?qCmE~#b9B`K4y$7FWzhZ;E4dEE9pO`*@66I-ZmJmtdoA`#?D6fV z_mtdU2^rVgfqo{xOFDlmq@bVxs={I>0+^VYXPbO^o8>VNV^_KP<~C;PB{oG1?YsBO z?p>i+UPeIOPkxaH^=es<NOML!QN(RVn1y`AmFgNvXYvWOJ zGSSDEu}~^*-4EuRXyG1TreGQL3gQyY-}BJ@*e$c%T!(01X9y~kAHAJbxBFY*#ful& z;yu|rvcv&OjhXp}GR?I6^73Yq$14)YDyJUj-yfGmy0UY!VMO1{;}ck-khsql6b=~%goCLYFTr@Q##xEgr^ z- ztIXWDY~E|{LylQ%&^y*pY|d-V5UUh~YobUmDGTuE$7T{ts(+=4&#=@lZ(gMGq6@U1 zHv7zZuRBH#!fjSqJtg93K7OFyv7lxCERrNp90G+0BXK0B!e%)6bZ5S9reLWr{AYH9 zjd-LADF++dkCjtGQB+MRT0R8Ol5WPjy4sVmjYq|2lAQrDtn=R&?+K9^Ft{0r*7QSf zj}+7oI<76oJhmhecN)DM+#}AHjG$Q4%;}+TugE2l8=iX*c=iG6(pIwgRRBt|eI&F& zE??0)9=h>dc5Axu4aC*MRmSOs;tS(%AnrSn;qi+6Sr#K^B9JpV>70hfic872EW)UV z=C~w14mDFssR|r#2+>?9du_Kg5PiZt2m2HZujgU~2ljCCWIF$@n`MJ`QES#V1A!Aa z06I~pTakgGib{4-j&0EZUYmq6-NPVUB=h9JnU-j`wO+tr#^2rA>EH$|%M~goJC&+e_&Xz+Ug?ShC^djE!q!nc~Duo}L`r;-q<@ zlY73{j-T=Xq<@GPTv#_w8ZEwy{ke11>T|&WA$6-`h)iad9XQWPFL#X%gM?0Wwx)B( zbUQzRKo|)VsX-t1jl_3mlOluf>$g93%Ial6bOvY6GI2pRs$L{e{n?=pO~?qkiP_$KofU}Q8*2mECVb$Fc-%8JEf>cB;^5Ejxs*!EvIMUVb!NUZ{rYMboM)bQQLZG6SBvUX*t_MAWI`_V*E#G@ zyia(|gP+Rj#v;$FzY@J}+~G+$Aq^bGK$&KJ6BvSsKztTu+D>FYLu75*rb05EufmOyMZ&f}ywYq{2L)V) zx1yr~K*R{ZSke}MWJIS>9g+zy9;R%lLA2zD-u3^kRg)g&`ZDW)5TFmI{W_pM7x}qN2-faqw?TCbn1oF!s z(I*C>>Mn;u@TAcJH^Y}1iCHa}wE(SFMPCi#QCRK8wb4+?Ig*MZL^mtJ*(Y3v9jotDIny1*6i9f=MB}j{O z8T4MNl;VyiqswBi?r|RkkTT0u0QM0MIWN^~=ZR#4i$9I}GMMrBz~ZCwMfUu$a(5E0 z^yA#NYH-tT)*1L+EBnK9HBlK^{nWs`@RV? zk!*?+K;W5MnImM~dH%e07(8TI{;1h=Jz(uZrJnqYZekDaS-WL*HKbl-ODMEGIwzGs zFcx3x?Q}4>1(WjLVSf_TTMIfQJIAh#1|j?n%Jura_VT5C?$7Y$Y{;DRLRF$Dsi>6D zhCOFCJs;oJSM*W~LAS?jjhtPK%7|)u(K_i+|b^G`!sNCX;@AUxuc_d<2&!cf7Xk>$T3z zq;O&41&110>BDuUPj`|6yYJJC+7Isa;7Eeuc3a=o_a-vg_AQfL`|s|^#$w;S#pOil z;S!??ip_~H1XhP97lm4zedFGPH9wPq4>H|XsxKhgXL(Xh8=*@do`-pun!$sn$``ti zY5Oxp1M`qtS?hA*JHH*oGk2tFAuh3lv;t{z#TSQ2E7+|W;z}(jfCObQA`GeLS@*ct z7=@^aq`j9@_2Drnd5%!9?4AQ9P;uYIaSB=x zG)i{)=K9iZC{=jGvtb9haopswnLEowky~+0Fu&6OH)LprzWrDqckCE}$+QELJ%sd( zTg?@g7Z{G#>K`skLKZ(QvvC>h96P#yI(SC8ri^;fQ+Ah(RrZl>Oj6$3MHXvK50`|5 z#s}{HX%dJODl{4YNyqYfhSRyrtWKXT@^#)qJDDPs8kxxjL?d?Fi(* zoh8(5k85vt78(e`4vJr@Ut2KL%^*e(M$)jBj)$ySIcx}NQ0c^eK1nGmyD@~D@(%CqT%X@(aKE2!)jk)!U;0t zwvOvhiRp}L9Oys2jNra9wjPIPWzwey`Gevf;TRE4KPHKdiNUuLqVuD;xklQ_9KE@VHT1*K>6qoDbL>v}t%FG%F;&`HOXy-DgH+@vhla=LPwtcpiu z?&6uX`%F1Qb&nIJ8h=0A|26Oy0JyH6`(`k>G{VxVCc~7^^m$l@iqqa+|Hb+F`?dW` z2^U1#rfu;GHVbfvc;|3lyE3oYeK;@Ne**Q8oW66|R3hh@Gt=;VeG)kD?@%^;Vp}sd zXx5Oc=E3t_RHirN;H1=Ex6!(+=LEf}%KqN@+JzU*Di>E*mEF6R)||K^D}c;>34KAR zrOADE)$y|&YRiK>ONvYS^Lxzp+~v5=K?bOydh6D$a)I9J^_<5MxS0?B94fLsdE%i1 znJdsjiVvR`sfOYn{5t1O3IQnm`^2wTOiWDfUVhD%9_l$FPs8zjg{`U`whwKO*LbgE z$=HAzoOjT|9ACw@r$F;D6+27KiD9kyJLk5o%9kZf`F?`!!v5_cNa-1YT+Y+7tZOwK z?Nr1B$Eq&o7L^%|E#4CfnP4KPx1NwsmQTqBt2y8T$^tJ~$FTtxLO{b`HjviWr$&tB zhxuckB^56pBBIQzj0rlfJs)dAEcV)(wb9K=?QU&qfGQD$ z*x(y-1{M|EoKG+$MFGrYiMCH0=m=kZGY~%8yGkdf7qx;7LC0ZPz_kMERbIXCI}3>n z`jZzkh+B?eTrwE|^WDJy`+>r@6Xzdz`yGKOt_7t>&W(79kwa?tEhA-eF6f`VoiDbDuXFaX{obrMOnPZWv$G6k8g9LBaZ@3+O~AEQi^#8+{@T(KuBz~50(YI90fQ=SG-;lENP>#k)C$P>b1PGoW;y~@kJd(2>kD9Y{)<&n-QZ}Bbq{}s(1my- zv*QxuDvnd0na<*TiIRzI&gm&RIWEhO&x&>OR#4PV+oWJi!zmgRL0Rw1V@n{-a%SP_zt-Y|8~|intDa+eN`g1cHPEE#e(Z6X9MnzxxXIy{=a&vm781?Ga2yu1BR?e_If5J-ZLOC0n`~OUNCV=~gdfsv@UUVEgi%evv6{cm? zk^&9k^RI;Yx|PnHR&Sy}oW!h(Mb5?!Q@F+o@N`8KCq;em6gwM~6*& zu#V6EoVnoodX1$k!A5qCRquNt6k1!~95ZD9Dz5!9p_HePl@SDf(xneo3Jc)J<7fgo z44MrBG1Vi}WY-xf$uq8g>!C-ch|_wP9+~`L|EILqj8ky@r|CLsJo={scY*%DIDe(< o)XB*IUOYBNR{n1t`G$-HdG#PTKyMBA1{F_TSx2ezg;m7=0P3{w%K!iX literal 0 HcmV?d00001 diff --git a/modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc b/modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc new file mode 100644 index 0000000000..b58c402f61 --- /dev/null +++ b/modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc @@ -0,0 +1,30 @@ +// Module included in the following assembly: +// +// * web_console/customizing-the-web-console.adoc + +:_content-type: CONCEPT + +[id="odc_con_customizing-a-developer-catalog-or-its-sub-catalogs_{context}"] += Developer catalog and sub-catalog customization + +As a cluster administrator, you have the ability to organize and manage the Developer catalog or its sub-catalogs. You can enable or disable the sub-catalog types or disable the entire developer catalog. + +The `developerCatalog.types` object includes the following parameters that you must define in a snippet to use them in the YAML view: + +* `state`: Defines if a list of developer catalog types should be enabled or disabled. +* `enabled`: Defines a list of developer catalog types (sub-catalogs) that are visible to users. +* `disabled`: Defines a list of developer catalog types (sub-catalogs) that are not visible to users. + +You can enable or disable the following developer catalog types (sub-catalogs) using the YAML view or the form view. + +* `Builder Images` +* `Templates` +* `Devfiles` +* `Samples` +* `Helm Charts` +* `Event Sources` +* `Event Sinks` +* `Operator Backed` + + + diff --git a/modules/odc_con_example-yaml-file-changes.adoc b/modules/odc_con_example-yaml-file-changes.adoc new file mode 100644 index 0000000000..dbb3d53238 --- /dev/null +++ b/modules/odc_con_example-yaml-file-changes.adoc @@ -0,0 +1,63 @@ +// Module included in the following assembly: +// +// * web_console/customizing-the-web-console.adoc + +:_content-type: CONCEPT + +[id="con_example-yaml-file-changes_{context}"] += Example YAML file changes + +You can dynamically add the following snippets in the YAML editor for customizing a developer catalog. + +Use the following snippet to display all the sub-catalogs by setting the _state_ type to *Enabled*. +[source,yaml] +---- +apiVersion: operator.openshift.io/v1 +kind: Console +metadata: + name: cluster +... +spec: + customization: + developerCatalog: + categories: + types: + state: Enabled +---- + +Use the following snippet to disable all sub-catalogs by setting the _state_ type to *Disabled*: +[source,yaml] +---- +apiVersion: operator.openshift.io/v1 +kind: Console +metadata: + name: cluster +... +spec: + customization: + developerCatalog: + categories: + types: + state: Disabled +---- + +Use the following snippet when a cluster administrator defines a list of sub-catalogs, which are enabled in the Web Console. +[source,yaml] +---- +apiVersion: operator.openshift.io/v1 +kind: Console +metadata: + name: cluster +... +spec: + customization: + developerCatalog: + categories: + types: + state: Enabled + enabled: + - BuilderImage + - Devfile + - HelmChart + - ... +---- \ No newline at end of file diff --git a/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc new file mode 100644 index 0000000000..4756f9b4d4 --- /dev/null +++ b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc @@ -0,0 +1,32 @@ +// Module included in the following assembly: +// +// * web_console/customizing-the-web-console.adoc + +:_content-type: PROCEDURE + +[id="odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view_{context}"] += Customizing a developer catalog or its sub-catalogs using the form view + +You can customize a developer catalog by using the form view in the Web Console. + +.Prerequisites + +* An OpenShift web console session with cluster administrator privileges. + +.Procedure + +. In the *Administrator* perspective, navigate to *Administration* -> *Cluster Settings*. +. Select the *Configuration* tab and click the *Console (operator.openshift.io)* resource. +. Click *Actions* -> *Customize*. +. In the respective sections, enable or disable the items in the list. ++ +.Verification +After you have customized the developer catalog, your changes are automatically saved in the system and take effect in the browser after a refresh. ++ +image::odc_customizing_developer_catalog.png[] + +[NOTE] +==== +You can use a similar procedure to customize Web UI items such as Quick starts, Cluster roles, and Actions. +==== + diff --git a/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc new file mode 100644 index 0000000000..a7f2041724 --- /dev/null +++ b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc @@ -0,0 +1,49 @@ +// Module included in the following assembly: +// +// * web_console/customizing-the-web-console.adoc + +:_content-type: PROCEDURE + +[id="odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view_{context}"] += Customizing a developer catalog or its sub-catalogs using the YAML view + +You can customize a developer catalog by editing the YAML content in the YAML view. + +.Prerequisites + +* An OpenShift web console session with cluster administrator privileges. + +.Procedure + +. In the *Administrator* perspective of the web console, navigate to *Administration* -> *Cluster Settings*. +. Select the *Configuration* tab, click the *Console (operator.openshift.io)* resource and view the *Details* page. +. Click the *YAML* tab to open the editor and edit the YAML content as needed. ++ +For example, to disable a developer catalog type, insert the following snippet that defines a list of disabled developer catalog resources: ++ +[source,yaml] +---- +apiVersion: operator.openshift.io/v1 +kind: Console +metadata: + name: cluster +... +spec: + customization: + developerCatalog: + categories: + types: + state: Disabled + disabled: + - BuilderImage + - Devfile + - HelmChart +... +---- + +. Click *Save*. + +[NOTE] +==== +By default, the developer catalog types are enabled in the Administrator view of the Web Console. +==== \ No newline at end of file diff --git a/web_console/customizing-the-web-console.adoc b/web_console/customizing-the-web-console.adoc index 2386eee0ef..7aa95145ef 100644 --- a/web_console/customizing-the-web-console.adoc +++ b/web_console/customizing-the-web-console.adoc @@ -32,3 +32,11 @@ include::modules/odc-customizing-user-perspectives.adoc[leveloffset=+1] include::modules/odc-customizing-a-perspective-using-YAML-view.adoc[leveloffset=+2] include::modules/odc-customizing-a-perspective-using-form-view.adoc[leveloffset=+2] + +include::modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc[leveloffset=+1] + +include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc[leveloffset=+2] + +include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc[leveloffset=+2] + +include::modules/odc_con_example-yaml-file-changes.adoc[leveloffset=+3] \ No newline at end of file