From 245bc720dc7ef1f0dc48cf60238bcc2394613949 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Mon, 8 Jun 2020 22:29:25 -0700 Subject: [PATCH 01/11] add upgrading docs --- docs/deployment/upgrade/overview.md | 81 +++++++++++++++++++++++++++++ docs/getting-started/quickstart.md | 13 ++--- sidebars.js | 4 ++ src/css/custom.css | 5 ++ 4 files changed, 97 insertions(+), 6 deletions(-) create mode 100644 docs/deployment/upgrade/overview.md diff --git a/docs/deployment/upgrade/overview.md b/docs/deployment/upgrade/overview.md new file mode 100644 index 00000000..46466820 --- /dev/null +++ b/docs/deployment/upgrade/overview.md @@ -0,0 +1,81 @@ +--- +title: Adding or upgrading components +sidebar_label: Upgrading +--- + +Before adding features or upgrading your cluster, we highly recommend you back up your `params.yaml` file. You can optionally commit it into a private repository and encrypt it with [BlackBox](https://github.com/StackExchange/blackbox) or similar tools. + +:::tip +We also highly recommend to try these steps on a copy of the production cluster first. +::: + +## Adding components +To add additional features to Onepanel: + +1. Run `opctl init` with additional flags. For example if you initially ran: + +```bash +opctl init --provider gke +``` + +You can enable https and cert-manager by running: + +```bash +opctl init --provider gke --enable-https --enabl-cert-manager --dns-provider clouddns +``` + +2. Review your `params.yaml` file and complete the new fields accordingly. + +:::tip +See [configuration files](/docs/deployment/configuration/files) for additional information. +::: + +3. Apply your changes: + +```bash +opctl apply +``` + +:::note +If the application is not loading after these updates, visit our [Troubleshooting](/docs/deployment/troubleshooting/overview) page for some steps that can help resolve most issues. If you are still having issues, join our [Slack community](https://join.slack.com/t/onepanel-ce/shared_invite/zt-eyjnwec0-nLaHhjif9Y~gA05KuX6AUg) or open an issue in [GitHub](https://github.com/onepanelio/core/issues). +::: + + +## Upgrading components +When upgrading Onepanel, it is best to upgrade one minor version at a time (e.g. 0.9.0 => 0.10.0). + +To upgrade Onepanel: + +1. Check the current version of `opctl`: + +```bash {3} +opctl version + +CLI version: 0.10.0 +Manifest version: v0.10.0 +API version: v0.10.0 +Web UI version: v0.10.0 + +``` + +2. Download the next version up of `opctl` for your operating system from [our release page](https://github.com/onepanelio/core/releases). + +3. Run `opctl init` with the initial flags you used, for example: + +```bash +opctl init --provider gke +``` + +:::important +Run `opctl init` only with the initial flags, you can add additional flags after the upgrade completes. +::: + +4. Apply your changes: + +```bash +opctl apply +``` + +:::note +If the application is not loading after these updates, visit our [Troubleshooting](/docs/deployment/troubleshooting/overview) page for some steps that can help resolve most issues. If you are still having issues, join our [Slack community](https://join.slack.com/t/onepanel-ce/shared_invite/zt-eyjnwec0-nLaHhjif9Y~gA05KuX6AUg) or open an issue in [GitHub](https://github.com/onepanelio/core/issues). +::: \ No newline at end of file diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 97c66baa..2b9b7654 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -8,13 +8,14 @@ import TabItem from '@theme/TabItem'; It's easy to get started with Onepanel. First, you install the CLI (`opctl`) and then using `opctl`, you generate a `params.yaml` file and update it to configure your deployment. Once complete, you can access your deployment from any browser using your Kubernetes authentication token. Finally, you can run a Workflow or create a Workspace. :::important -The steps in the Quick start allow you to quickly setup a Onepanel cluster for testing. To setup a production cluster with TLS and auto scaling enabled see [instructions for your cloud provider](/docs/deployment/overview#installing-on-public-cloud) +The steps in the Quick start allow you to quickly setup a Onepanel cluster for testing. To setup a production cluster with TLS and auto scaling enabled see [instructions for your cloud provider](/docs/deployment/overview#installing-on-public-cloud). + +You can also [add components](/docs/deployment/upgrade/overview) to make this cluster production ready. ::: -## Step 0: Understand the concepts -First, take a look at [concepts](/docs/getting-started/concepts/namespaces) to understand the different components in Onepanel. +Before getting started, take a look at [concepts](/docs/getting-started/concepts/namespaces) to understand the different components in Onepanel. -## Step 1: Create a Kubernetes cluster +## Step 0: Create a Kubernetes cluster Next, create a Kubernetes cluster in one of the following cloud providers: --zone -## Step 2: Install Onepanel +## Step 1: Install Onepanel 1. Download the latest `opctl` for your operating system from [our release page](https://github.com/onepanelio/core/releases/latest). @@ -227,7 +228,7 @@ If the application is not loading, visit our [Troubleshooting](/docs/deployment/ opctl auth token ``` -## Step 3: Create a simple Workflow +## Step 2: Create a simple Workflow Let's first create a simple Directed Acyclic Graph (DAG) Workflow Template: 1. Click **Workflows** in the top menu. diff --git a/sidebars.js b/sidebars.js index 3014f50a..51d65820 100644 --- a/sidebars.js +++ b/sidebars.js @@ -91,6 +91,10 @@ module.exports = { 'deployment/configuration/tls', ] }, + { + type: 'doc', + id: 'deployment/upgrade/overview' + }, { type: 'doc', id: 'deployment/troubleshooting/overview' diff --git a/src/css/custom.css b/src/css/custom.css index 9b460e4b..30be72d4 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -18,6 +18,11 @@ --ifm-navbar-link-hover-color: var(--ifm-color-secondary-lightest); --ifm-heading-color: var(--ifm-color-primary-darker); --ifm-font-size-base: 16px; + --ifm-list-left-padding: 1.25rem; +} + +ol > li::marker { + font-weight: bold; } .header-icon-link { From 66baae619892479aa1cc903132c34d438957578d Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Mon, 8 Jun 2020 22:35:25 -0700 Subject: [PATCH 02/11] style: update favicon --- static/img/favicon.png | Bin 1106 -> 12394 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/static/img/favicon.png b/static/img/favicon.png index a5616e5cb6045eea16b3d3ca5e0885482205aae6..08d15aada1138540227bcf117dfa43b683b89ad4 100644 GIT binary patch literal 12394 zcmd^lcT`i$_b*oz8$}S0k*Wcum;gb#SRoLlHw{H3jV8rV1Qk(15I6x03W^jlAYDx; z0YyQ|i6G4g(h&_+5D`I|DDT93@9+10Z~fL=>;3&$aLPV=e`dFt*)vS6wWX=Z7O5=) z0s|erfi^V&%?J}L0Ei{oxgif2qAzXaE$Cvr0hQ7OYorBQV8UW z)Fz4{Eb-IJ9v_6aFgGCi`>GN6JZho7=V5690mCDq=Lw{9l%U;2iielqA>>R|4RW^^ z`4IB7wuOepc_WIa7w%F3#qN@&J?YXpl0F%EA!s z0Dk6^)segZumqhug#246yoL2{BmV%(Zf&&#Xp#m7vs*_;4Wp&4qk}>1*3`ggs%yZ% zI%tfRfwqo;rta>4evoi$0c3XrTVs=d+JfH>Aw7eF&Ksz!hlGTvg&a`x5AaaO=ZGtm#K#m&Z}e8G}L{4`F8!`4h*uT{I?qaBX^+v#q$((TS}mRZ~zI8hr7bR!m#iD z?+yLSNGAOk-}&GGpFehzN$M0IiZ8`4C=gZ(^G73Ca|5dYFF1e%A7g(~F#qcb<3q^c zU@x+Pwy~y$p1!7*{(<8r#>X)jeT>#IJ#Bpr;{zCN4Lu`0eq(%q{}hBNYGhbeUqch4 zhc&?(Y49bn`g$;sp1!V*j>drlx_Ua=|H_{53k)LoktqB|`LbUBEo=OLl{GL5pb&!m z1ML0%ef~|A6Fxq{fk6R$@@^v|esbvURzB_JNA?d1RN+VSAAKnSUKc22lK_9;-G9Pi z;PpRfp@GqZlTBAkLswHnM-PM1)6_hsudSm>nS7*iKwfm zhb9ws_0d{-S_CwKOeCT)`np67qOPvHyN)|j9ae};G6?bt@}c~btH*qT{(188;^&Kj z55dm^b_|+KaVG@(1R)P&4xIHRkcj^N=gtzm0x*W^{Dk!Jf~EdE{SBc0AFzMO|B=D} za>Ct$|M*}15q|lv9!>FsyKw;AUsdh$2jO8rz}nm%`|R!T&(&XXPg|$H{qRh!>mU7^ zQrT${%{GZByY#3js<@4u@@i^!p_tR3UiH3paOyp8dU)#lkt?j}xg|8Uu>SpsPRL_P zw=8DU2c&myAvEy1XUzCoX)^oW7RU6_>G}D^mG28HjOuPq&qVr*?z6Y6U%VS(H4aLV z8J)bZavnL3i7!&0cM+0njINdzzaH!x`(}BQ{iN}Os((Si1J13|w=qxJkA|1{rPWuo z^BAvsKYadf7xyf$zCW+F$3Fv#C}0NwExmz1q)Vj|n@8jfm2ikMP%TIs*Uemt_Uw^yOUrc{r{P=lxX=T;uTItbn zmf>ZlO>D*DGVGY&-{zM_zs#MyQT}=6NB8jbuiwAt7M7P+R#$$ma)+h{$G<&q|Kxh> z#odYylZa9g=Zp{I->hRQeADWF!LmP=#a$mbfX`0HKl4qiH;XD?So%5sbw1`vYkqxS z>%ixvGOk~G{le0UO>Cvd-I|~*sD1GB>aSn+;Iqz8UuJ(S-zaMSv9$7aZgJ)3ubsq) z%RhhZAY?W7P5fB;`Q`iKwlkTg5oM(J?3(NLkWqHd`U>0X$X5K!oa(w2; z!1!$SyWzo!+4jLnN^*73!`F$W?`k@RJ9yJo+!4idx$izsNmH`t7MH6#Mky)P2ZD>0 zeDgWoV;NOl)$e#YueyEH8)&SzCCwj)zs%46SjwyGy;ISd^QuSQGpBoG#ww5ebqR=wrD9s0ukFv%U7gnGugAE!+t%bah$Jd;%YX=*OJw(s+|h0ae? z52|}=-;ddY&x0ASH3Ey8`aUO=aM#w>HsRCY>w8MjM*)Gq1cGcW?cmq{pMM1G7B}t{ z5Kx*vVSLO!wC~HHM_4+P@rruNMEP15URv55we|HiD0TPikj}`XukPGHtuLEAQ$l{W z(`R5myH=>Trzf}K+ULDD<%&CwQ@<6UpSLXWWXw<7BjT@qC$EqP9+~6I?JYBl z2|G8>rDmufuyULZkBd<(leas11BbW$@@EN@EW@9+20qz$=d9$)f>7n?3?b&!kx6pJd}+Lx^czgl#Iq@L3trS z_HosDEYdsbXN)-w^<^xwmSI+Iu|Fy2ygVIyuxn17z+JK3ZsmXL&3W}(B10(4IVyqs z?yI{0wx{R)=_2(?vn&Gl3DL+q$wYsEbhG&L$VEk9+OxCd23>e@eQL~EXk#q4)c+mr ziPpfUpK|+a200t!unI+o_ISnC9}+EAn*UZyu?L#1Hkb%Cf9rw<=DH7sTxIo$SB0592HxXV&MY-so+a5xP0rr=8T z?QKJ&m2R8O1VD*G=MjyD5PdaO!X7tF-|&0(pAbAQS-!INuc@ zw#jTa!fW7#CwvSt(3tjCR&=Q<@MGsjhEf7GMHC1=HE`W{<}9<2@)yCzZuIDU6IBn~ z1pcmiU>fTrXYjpSmNoH|;Bd6Ffik#kTY4;9_C<$((u<(n#40kxL1fimv2?F=&i8tx1UCk& zC?UnFv^sm7u_@k)#GU;eV~mmNCU8HU49!%Yyhu6-XUokaOl1oaLj)9MdrM1f@E+)j zz`ic5UKe{@yUmKgeYEA4GM@AoaFKTGxL<*2J!5(*r}oivBnBoZC^Ny z!7~xYBrUZD1~mQgI5)qUW6JXM>ek)E)rhy4VtJD0=$=`e4fry(@Wb5BNN*YNly=NG zLg>g)KEya=Vani2onv~QP|(Yix@tX0!)}dBMsnB1KYEPUdbtBvW;~2TNe!Y0N?8+f zmKdNlUiZV7ca__~=u>rvq^G`qDkE_lyl*uQi=ei6s-`g>Ig@08*2z*_*{R_jc&&U( z9c)nr#}XCr2ivi`C#Lcz|H+)gDE2$bD3!`1*x0sO2O&rY z04V5?e_v%hrZ*b93!+cF-~^yf#+?1RZ@30WiGo&6D!)^sCEsQteCu!FssBR)KbpO+f? zr1TPTjm%fj_x*d)wa?s59MSNNM)WeG%lS*1*zRZa>-P@G15rMC!@(7;2Sn^qkWEvceN^To^LJ6Pwu)nL1^ z)`-?Q+c0eqvE~^4I0Sbq-pw3k7cd#$;<7GIQj@bDH~!mu6(r4!Rp~)hwk0E)Sxe!I$LPq0N>Ok|XH%S{3dadm-9c8iZ9tIl zBdxkg*TumXeny(8eauGnYqy1IATxBcqh$;{E?s6@V1!`K@IF3K9*@xMfSVb2>kO2J1&w8>^ z{Fw8|jg#rNSUl|*9aY=oU5T~KC!6hXcSdPt2uX=j9-M^ujV+7~1D1%O*ynV~x*n=aANCiszf>5`f)+fiz;&Kq?&9wN+5Sl&YX zCNPqPv&4sCU%;V~&fWxCxzS}Evl5)}kgl-I5@3vJ;x>p(*ob~}n-f}`gH!wNu z@Q8JC09q6_GEawd7jn9R)Q`3)ggRKb1V`FdIATPSB!MLWj-*37km%#|9t0Ne5{V6X z%X|DCb>SF2z2TmO2i4%g7JbKfE%0_P(8P_$>}w$&c(7T&k5YmvLBq-jgFavbN4XB! zk7QxqFdNx8A2^r(w@*ZxFI{E`;T(k@NtOHcl=O8#n)fgO`5@ZM=7tv3OtpA(o9r%7*xdIm^Ui8HZ2_v=%t3 zWj?fUwAyPV*A>V!CbQz6DfJZ|MYk;axq6K{-@X5R!-Rq%2qc~!8D^1{O1M3#9x61C7I8( z60f_im8RnmY=-Q_R=**uGvaaBiV7(3op^{(g5V*Y$?KW*gK1f4%YZ(fnXc)}26=r{-gUVJ zT&Lj6<-K`mHPKq$Udy%duaAR9eyQeN|E;=my?S*1q~op#Y+eOaPvWZ2q93#nvK|ab z{5ndy8Hf|<;1T&eW`XuH}-~~7FBp@R(I4nBmC#SU1d;#rL%bsHpsl|x|{+j%W`e`Ci%=Oz{B9m z7rnkad(}pcNSPjd>BQdP!=2vvORNdc8!icx2xDgwQ!EyB}!3!)j1(Gk6P9 zgy+pG&?)P^XD#!TDi)8U#@&&dS{h;v0xx->-Ma#9~oIOpK9tHK0U*v09pWylW_6 zo{!s-w|!kn<5N#Jaj+IfC~HhqgUQQI<{OAqygDCkRZ2VtGT8^fyrrC@r~qRK2?#!S zYia*mn-{P)uXyXmcEI1OKK}*hz9eb(W3k{N1n4enJ6F;ZkHr8FS`6MQv6MMP^D1cS zo&yFDYczN($W+et>O=3lXO96AVFm@3a_)@_pp4BZ{>7!^DOAf!DbW3l#u$mU5ez`( zt|d{@ubv>;BtSpzqrc0FoB&>vca0-ZTPD}H0=>XqNAtDNSA^es@z{FN0=!liFJ4e| z&IIM;LsbQ^jxyh9Xn+~~U^x!q4cRR`7pl*Pb$eOT1M>^#6)m1}IElm11MRe(iV25D9nC8~ zlzKgw^?jbF9gn^E-m|Px+<^fFU24|9?5dq`$OB}~5-{CH-fch!{*D(WBO!j7@VSWc zlJYd=_jz;kfeB{*AW^ndoJ3=c%W{k~T&a%j}*OMLzX;OU2*pAOB`=W%WexSwKjBsjM6PVOzY`oXKSPfQfb= zk96>-@cD5PUh6xb@*LC4bCf;H5{w z4;#J6#Fa-*tGXxycUD^JcJEnJxXTe+ZbQdf(yhTGwG7se(2|~}hRx+mdr(r&50yYM zP3m!UxGc!gX}t~YPt|(}bQrNby*Ff{zVFm&a55AJb9G+d#>#ocl!tboLiPQy76jqa zOFj{cdOmpF7PTNlx&a9~YT||S59Hv@uljzx9)6so-0s%ohRI6ULBcer1m@F@$u%c& ziI^yCf!XS`t>ABZ=Vnczi^^suAcUCf%5&^)tnIlpe^g<|?7>gnEySjIR?lQDPjT$A ze|wHdZRoWd;)m-aKKB#F0D1Sml?&H*gP(i6eu>R1ZWerTZ9_+elNhiyl`Y&&m{TOY zSkdC%?7VoB<+h^J9|@)1V++gP(OExCPGP+1Rb6dBO3dBxh#&%i?nLA~Jj;U>CU8Zi5_3&8<&!;f^x+`P>SGn4Nie7_x2Z z2@(Si-eb4itfA(*8DicL;;S+qC9w`3!jF`vg{vNHm!v(#hGZUoN{dQ*rU(RI2z#ka zllPnS&#Fn75I6rdi;_S^cf7?gG}@+i4j0K!#<>}iqDzdK2&Wyxlku;5epbwV-E`4P zru)_RSHyhZ=SxN1ers*mW954vZ6?ihS;=Uv9`JXOJU-MLK3(JbBKFaBY;)iJu6q|uU<(3JsT5tS84rZ;!X_x&EUBB3aE{#J{vHxk08SXoH~!f3$^Un3Qyp@Hqumok zqJRRRf~SRC69*L;8Qt)W3~=nkJW7g7@$py%Ot>hm4xKv(SLCJpwhp(tm1TRQ?tkz) z4THjrx|yUBCJw0)E=N1%_{II*2!VE;yGp$1>_d1r5*)N25&u*g^dk(koxU{9YTWhS zhxXvFY;6zwuY;SQd+V~#E&4H)%bxNZMR3-h-+`5ieHE&Jc+709`V??bLBxbK_svgl zC{XO0E4;s2R(T!|v~&AIq~`UN%+V^5}u=_wp)` zz0y!wl$N+DG<_9N1&n4^zg$Y(#LMG_i`0b^$;lyC$fO~bOma&1 zy&9GY6LE5F5O|MVn_9jiWVe91j+l}sCc9y7B+SJ5(TBqB??QB}wOnzI=O+(s`axVk z{Mna{+i1gn9tGqtmSVt84c}A)6<}KGLHFY6!8e=}4NH>e_L4dd;a?60Cvm|&@*KM9)IRz{g@A+H&~$D5pe#1L0d=qX z{UxSetk+Zr0VBSX_%hlpEP6*r1tf>!++!bhXv7bb;O;4M^+UE*(HNA^}$A5tO3p6zP?rgO#Q9z^;xVsw*Hv*2YILC8!9{44n3 zdGMWvTw_u#qX@XH`^z;6+6uD;brEL*;ey}_Fs?xra{6-RYam{7K*kDKW<=A0%QwRj zV8H%w-o73fKE*`@pkWPvj%SxZF~-8qAnbuMmv3x zjl>pI*pM<&r{=8d?ZKcM*kVH8{leXH5s0;Z9G~t(Z3U#;IUtO!J-|wS~~)_Embt?HsC6PYCN^oh$|?n|bd0w!xKcr{q~ciCPQm>HXZr z@Bb=K1wT z3^p6pMwWu_L#>@|m^Lk#sapC;E$@d6tO0h&v=gq1M&Q1W7hVd0uMG@GAnyPjzPEdq z;a3I!lvF-30C-!UkAFBZ|FIJ)fNz)3mc%v zx3_`X=1Opd_e=`z=c$%3?i^dsAsh0Bi{J+0dDBkAzjfHcS`yd}i(c}nJ_XwK@?DnL zPs}(4@{NN&^2o`&~F z_-+xi=S4E##)QbB^5@q77%os==P!;O!*7 zu5-P>&W&U`pBd38u6-5M{zJ{*rvZv7!HS{As?qQ|$cEpsgg?f>vwSGObkWy^S4>Z8 z}TSY5L01V&S6a$f#@>*)BSFvp;uw^laqGFyH0 zMd6BZou0EU4DgOv+T3yQ)OzS*g@^p-*NVdP+wv0g;Z-J;(IGt?qKKL;4M0q!NeEp^ z=;$Z;+&b9`knL|?#ydO|IJSIRkKdB)v4_P(w|u_==*`jKfGtx z=Z))4n$pgI0kWTMxT5n>{TZ%G`;W8qdZ!mZ{_eOl=-zd}CSfi<-p?OoS)&S1=6O8x zak*o*`qj|n(&un){9HRJ!&UKRvZ@TI`|Kqq<%;T#Ub~3lIjPUZml;wM-z@y>%>6{0 z7;{$_#>$?Wme#F3R2ia&FLo+(o{g@1y%Sd*;unTbA6~Jy()*_S>FKw`uV+)%a23_R z@jb&Yrpn`=JWc#?*{BrXtbXp!jw@5+dk%lN7cw%abWwKlgi`ogBq4q-VR}(AS-(c_ z(rw>|jw50*H66L9kI0@RDJ{uA5o zBit-s1AUt8|U~z78yvE=k#0-eEo3A2VI{92x% z`4R5r*2K3wRUH$?A{$!Sgf3h!&)?2cJqhpmL{1FCNoorYyxjBs%D71))as_Vau9m0 zz;5K=MlL&dl2|e{<0@s*!~vwV0)5EW<~FoWLt^jgO-w#RpmQgMsx7}>f9SY4u*_8< zIu`>38;kMm-LH#mG*O%$MANJ<%OM8)zUAgI%aGJ0B2`mbLH{M1(|{+F6xrB4KrbTJ z*CraPV?uP6B*JR<0F?jZlWX-J(;}O9s0%Di((QiY$#iVF5N%{Ph9%Nn%JLPR zMz;PQk>hVQ!g1(lYy zJ&gNJ8;#q_EKacT?HpX24=8QyY;SdqF7vR`sfpbfC=viMlKiL|h^EbPPh%=zvwgth zD7B3W`bTFS1yO}2hm}jJw@@OWBG}p$Ulz0p^wvf+1;lMl-UU3nVl+@GPNYg9n!Mu@ zrARi~vs5~ytrCcGg&PC>L3k54e=L$-{HXG1Dw*D|+Ym3k2Y4!|;CPb1?|boQH0rTU zsyizxo?bivRK=I(yTadavnMH;Sihldx_&qC#W2B?)qn%NMdf83O=evwxsaB$0`>R~ z0{te9ybF@$IE`5CyzP*z8VGM8!mav(@J6-$sGH(B<-_^r?8c(=WQ!edd_atjNeS86 zM|*&=qKRnQ64!j^Gob${X@|Dz9Qr~jCTT-Iv1J{YZX3J3a2r^7CoxI*seLbj1;*2b zhXA`2ynX#EoQa*xLmyWD*fqLvZs^mJ*T|t+rQ2xLG!zg)r#-@ZBx8T9M>JW-6(yem z9Cpa7?s7~nY2_*Em}mw#^LO&gg=ys7P-RIwY2-3Qw%_r_6$~Rqn)d;AfU|vun<7aWP)$P@?yto~Te}o~VduNU zjc4iE_4?8CXyj-tr3TvTrYNWk9CWjJxz0qwidq&>%TQgXusKi9^%;R~X2K)d#6W;X zl4snHHoSdvEiOXE(&j6E1WlDNpY<6{!hRjPg^$C&L4$=!V(`C99=Vh@TGi59d@*Bi zdWzB%ZxQnX+8IuNnMjyYa{{=GO9C`S8ZT@#7yEvbi3FB){FyiX?k8LdcJv9>HCo|> z-6Kz(Tgq$|lxUB!hOM&Xxg9_)&RVOEaes@+mULo9 z9TKrQj)R9|l5( zHq(;*JAjLVH`iOk=B!sZ#&rWH!!?pj;@bD4E<;3%ZqOkJ8d$~9##eH^Lz~8*5 z^>op=&D^2^VX#n=Hj+jxsAEJg?Vx@)qtfdbDTlY3e8t+Q@aD!xnJmZ0#qHeC4yT$tqFU%oV$N zNiz$_K91waF@;e+BJ|2>i^-c*;`KV>H4(To&ZFwdU|9EqfE;`g6LCK9S;k5IfuoO4 z;f1S3HEe-6+33e!cIfYgdX$HiwggO$+u7h<{TGnz21Z;Y_hQ`W77+P7Q$9M- znHcc0j&bLH?Suy8KDU#J1>S3E7?@FS)-j5I7Fc)&*%CX*u>C(_`*-%SLeZu9UDvtK z(sVLl1T*a{u1cIp7wXIuN>y8mCTg?Fu48<3s*D1y>Uv`T6J2=B!L!VS=*G4wh;TmNq(5_u05i zynPBW z%)~mh$~Vweso_op?&DL`?WQB>G(hQec0Z6jc_Pc^UW0L3_Bn1acrw|ZVRNhD%>|Fs zNFe!nqH`h9FH@8nDodnqlriMIV&wQ8C5=er=~oM}VoVf?;_)|(QSM*&X_+9Y>&?VK zPh%v!!fe!CtH0BumAv;R6rR>|jdM#;N3wJPJ{po8_ZATWAG|_;rzns^OvNXH-pvpJ6p!`31&XwnU8K@*OIfjc@3XXNR)SBrC>tlo(r8N*O>VS z!e4RI8UoQiOo|nIlpkD|a?T2cx#2OdR%9 z4PQP;+|&FQ$USv>#PBt_Bqm!0z?PA(*UQ{)+F*uXhriQNSZf(zzHej2w@)M+r-D(x z!R8bDq~)yUSR@X>M zudzJs%l8+e=I)uFdi?QnEncgX%}q`THQ%@26h6rWF}U$@O2Uix%=huKmv*x}v8+AX zClro-mHGi@tS)T;&{My^+h!Z?yZvbN_EHbi)2kr1S!!hFR+UK)v-sZl5^HTFXn{(VAKIs#n=JulsJ0SV3-CzsH~|pd*?E{PSD-|WBn^+!6dtUL;Sxb@&BxRO7uRx$$Bu=)X@Js=S-6#xzWM$|=+Ehz=)=PU z$x1t?3l*0AWc}BMoA$S7h(FMIRGPzn94IE}v3DNy8;Q5sF`rMCI z^^f0N?Ryjc;3?0JAI`tN+V^_T;EfMxR?`SG>K$nYO}m=5bS7xHeT1QvK8Om{)D=m<8$*9$yHSb%=}n-#*ZmULl_umIgH zQ=RZ=aH-wt@NynZcP7t9Y6|8MezV5i-i7XL5gza_u_w<)P~Z=1q_u+y1m(AHAVrLA zL(K(33R+f>22_U`zgpqhm?|qKK#I~?_{kDso|^gJZO|{bZJtb^rfcAL7-fy{^*QOn zlEZIOjO`GnyW$g59K|`Uy^>yJ)t{dRzgQrAbB=wlxDClSmRQu9c39ZaKVI|WSaOO!q_F^FnrTu2{A`I} zWJg5!m|ER4SDW7xOaO*DQWkKjrU$tk(^Fio=?Mj#B;Opzo}@`MV|XH=0KPMmt_x?} z?NjJ#6;pl6G_vxnJkCW_nwj~RoXl?So$`<01L8}S#`m_6%aw!;Dp&p&IWEj%y zOw*)vx`SwOlGK7GXY^j?Me8?6k(nRk)XIMfxQ3G5(Dzu7RUs|SG&Fx9e)Bv>jCfWAna7a z20+oFM^M~bJ&Fmm_Fnzs`31CLB4Nl=i~-?CGkkWT8+PaOJM(gXH4YB`MWiOHym(Lf#Qd+m>9pBl_^)zXw1|9@I7e YCwvN(Yl5o*N&o-=07*qoM6N<$f^B{o*Z=?k From 9b03bfd3b6a183a06c8f67740ce16031765bcf54 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Mon, 8 Jun 2020 23:26:56 -0700 Subject: [PATCH 03/11] add windows cli instruction --- docs/getting-started/quickstart.md | 12 ++++++++++-- src/css/custom.css | 16 ++++++++++++++++ 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 2b9b7654..7685aff7 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -121,13 +121,14 @@ gcloud container clusters get-credentials --zone values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'macos', }, + { label: 'Windows', value: 'windows', }, ] }> ```bash # Download the binary -curl -sLO https://github.com/onepanelio/core/releases/download/latest/opctl-linux-amd64 +curl -sLO https://github.com/onepanelio/core/releases/latest/download/opctl-linux-amd64 # Make binary executable chmod +x opctl-linux-amd64 @@ -144,7 +145,7 @@ opctl version ```bash # Download the binary -curl -sLO https://github.com/onepanelio/core/releases/download/latest/opctl-macos-amd64 +curl -sLO https://github.com/onepanelio/core/releases/latest/download/opctl-macos-amd64 # Make binary executable chmod +x opctl-macos-amd64 @@ -156,6 +157,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl opctl version ``` + + + +:::info +Download the [latest executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable. +::: + diff --git a/src/css/custom.css b/src/css/custom.css index 30be72d4..30c44203 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -216,6 +216,22 @@ ol > li::marker { fill: #f1c40f; } +.admonition-info { + background-color: transparent; + border-left: 8px solid; + border-color: var(--ifm-toc-border-color); + color: var(--ra-color-text-dark); +} + +.admonition-info h5 { + color: var(--ifm-toc-border-color); +} + +.admonition-info .admonition-icon svg { + stroke: var(--ifm-toc-border-color); + fill: var(--ifm-toc-border-color); +} + .integrations.grid-container { display: grid; grid-template-columns: auto auto auto auto; From fbee21b30b12096485c73fb8ab5d867d0e941fd8 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Mon, 8 Jun 2020 23:28:38 -0700 Subject: [PATCH 04/11] update text --- docs/getting-started/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 7685aff7..50a4f85a 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -10,7 +10,7 @@ It's easy to get started with Onepanel. First, you install the CLI (`opctl`) and :::important The steps in the Quick start allow you to quickly setup a Onepanel cluster for testing. To setup a production cluster with TLS and auto scaling enabled see [instructions for your cloud provider](/docs/deployment/overview#installing-on-public-cloud). -You can also [add components](/docs/deployment/upgrade/overview) to make this cluster production ready. +You can also [add components](/docs/deployment/upgrade/overview) at later time to make this cluster production ready. ::: Before getting started, take a look at [concepts](/docs/getting-started/concepts/namespaces) to understand the different components in Onepanel. From 89ed06d8703a26e3b34b3887dd8d0ea18a50a6d7 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Tue, 9 Jun 2020 09:55:47 -0700 Subject: [PATCH 05/11] windows instructions --- docs/getting-started/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 50a4f85a..9eacbb8f 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -161,7 +161,7 @@ opctl version :::info -Download the [latest executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable. +Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable. ::: From 34af6df897aa2967be24c6ca534b05096f735eb7 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Tue, 9 Jun 2020 10:01:03 -0700 Subject: [PATCH 06/11] add Windows CLI instructions --- docs/deployment/public/aks.md | 9 +++++++++ docs/deployment/public/eks.md | 8 ++++++++ docs/deployment/public/gke.md | 8 ++++++++ 3 files changed, 25 insertions(+) diff --git a/docs/deployment/public/aks.md b/docs/deployment/public/aks.md index f9496fce..8e434185 100644 --- a/docs/deployment/public/aks.md +++ b/docs/deployment/public/aks.md @@ -80,6 +80,7 @@ az aks get-credentials --resource-group --name - values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'macos', }, + { label: 'Windows', value: 'windows', }, ] }> @@ -116,6 +117,14 @@ opctl version ``` + + +:::info +Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable. +::: + + + 2. Run the following command to initialize a `params.yaml` template for AKS: diff --git a/docs/deployment/public/eks.md b/docs/deployment/public/eks.md index 8001c99e..1b75bb9f 100644 --- a/docs/deployment/public/eks.md +++ b/docs/deployment/public/eks.md @@ -55,6 +55,7 @@ If you are not the person that created the cluster, you will need to be [added t values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'macos', }, + { label: 'Windows', value: 'windows', }, ] }> @@ -90,6 +91,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl opctl version ``` + + + +:::info +Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable. +::: + diff --git a/docs/deployment/public/gke.md b/docs/deployment/public/gke.md index 3d3f087c..23b41fbf 100644 --- a/docs/deployment/public/gke.md +++ b/docs/deployment/public/gke.md @@ -51,6 +51,7 @@ gcloud container clusters get-credentials --zone values={[ { label: 'Linux', value: 'linux', }, { label: 'macOS', value: 'macos', }, + { label: 'Windows', value: 'windows', }, ] }> @@ -86,6 +87,13 @@ mv ./opctl-macos-amd64 /usr/local/bin/opctl opctl version ``` + + + +:::info +Download the [attached executable](https://github.com/onepanelio/core/releases/latest/download/opctl-windows-amd64.exe), rename it to `opctl` and move it to a folder that is in your PATH environment variable. +::: + From 835cad4b84a9e229737fb86dfb5551fa79233e71 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Tue, 9 Jun 2020 10:48:48 -0700 Subject: [PATCH 07/11] collapsible sidebar --- docusaurus.config.js | 1 - sidebars.js | 2 +- src/css/custom.css | 4 ++++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 0fe839a4..9f4e283b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -8,7 +8,6 @@ module.exports = { projectName: 'core-docs', // Usually your repo name. themeConfig: { disableDarkMode: true, - sidebarCollapsible: false, navbar: { title: '', logo: { diff --git a/sidebars.js b/sidebars.js index 51d65820..0c9ad028 100644 --- a/sidebars.js +++ b/sidebars.js @@ -43,7 +43,7 @@ module.exports = { items: [ { type: 'category', - label: 'Image/video auto annotation', + label: 'Auto annotation with CVAT', items: [ { type: 'doc', diff --git a/src/css/custom.css b/src/css/custom.css index 30c44203..2e0100b9 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -25,6 +25,10 @@ ol > li::marker { font-weight: bold; } +.menu__link--sublist:after { + background-size: 1.25rem 1.25rem; +} + .header-icon-link { padding: 8px; } From 848775373f8cea7caa9ecca7d92f6c66136ff919 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Tue, 9 Jun 2020 10:52:58 -0700 Subject: [PATCH 08/11] use double colon for pseudo-elemenet --- src/css/custom.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/css/custom.css b/src/css/custom.css index 2e0100b9..8de87ae0 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -25,7 +25,7 @@ ol > li::marker { font-weight: bold; } -.menu__link--sublist:after { +.menu__link--sublist::after { background-size: 1.25rem 1.25rem; } From 5f5e3101ec398fb8de4a46520dadeb616835057f Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Tue, 9 Jun 2020 11:14:20 -0700 Subject: [PATCH 09/11] fix hovers --- src/css/custom.css | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/css/custom.css b/src/css/custom.css index 8de87ae0..30a8f604 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -19,6 +19,8 @@ --ifm-heading-color: var(--ifm-color-primary-darker); --ifm-font-size-base: 16px; --ifm-list-left-padding: 1.25rem; + --ifm-navbar-link-hover-color:rgb(255,255,255); + --ifm-navbar-link-color: rgb(255,255,255, 0.8); } ol > li::marker { @@ -31,13 +33,14 @@ ol > li::marker { .header-icon-link { padding: 8px; + opacity: 0.8; } -.header-github-link:hover { - opacity: 0.6; +.header-icon-link:hover { + opacity: 1; } -.header-github-link:before { +.header-github-link::before { content: ''; width: 24px; height: 24px; @@ -46,11 +49,7 @@ ol > li::marker { no-repeat; } -.header-slack-link:hover { - opacity: 0.6; -} - -.header-slack-link:before { +.header-slack-link::before { content: ''; width: 24px; height: 24px; From cd8f5d4d2260ae0fb2ec2afe3673d832f2903859 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Tue, 9 Jun 2020 11:19:12 -0700 Subject: [PATCH 10/11] fix Codacy review issues --- src/css/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/css/custom.css b/src/css/custom.css index 30a8f604..08e2d596 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -19,8 +19,8 @@ --ifm-heading-color: var(--ifm-color-primary-darker); --ifm-font-size-base: 16px; --ifm-list-left-padding: 1.25rem; - --ifm-navbar-link-hover-color:rgb(255,255,255); - --ifm-navbar-link-color: rgb(255,255,255, 0.8); + --ifm-navbar-link-hover-color: rgb(255 , 255, 255); + --ifm-navbar-link-color: rgb(255 , 255, 255, 0.8); } ol > li::marker { From d8a8ddfd9e85513b7bdc25f884341fea5eaacafb Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Tue, 9 Jun 2020 11:22:28 -0700 Subject: [PATCH 11/11] fix Codacy review issues --- src/css/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/css/custom.css b/src/css/custom.css index 08e2d596..7e82f0f6 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -19,8 +19,8 @@ --ifm-heading-color: var(--ifm-color-primary-darker); --ifm-font-size-base: 16px; --ifm-list-left-padding: 1.25rem; - --ifm-navbar-link-hover-color: rgb(255 , 255, 255); - --ifm-navbar-link-color: rgb(255 , 255, 255, 0.8); + --ifm-navbar-link-hover-color: rgb(255, 255, 255); + --ifm-navbar-link-color: rgb(255, 255, 255, 0.8); } ol > li::marker {