From ffb3145bf430e8e1138921d80722d2e7354d2e81 Mon Sep 17 00:00:00 2001 From: Ahmad Nassri Date: Wed, 20 Jan 2016 02:36:39 -0500 Subject: [PATCH] Add Kong, Open-source Microservice & API Management layer --- kong/README-short.txt | 1 + kong/content.md | 91 ++++++++++++++++++++++++++++++++++++++++++ kong/github-repo | 1 + kong/license.md | 1 + kong/logo.png | Bin 0 -> 8744 bytes 5 files changed, 94 insertions(+) create mode 100644 kong/README-short.txt create mode 100644 kong/content.md create mode 100644 kong/github-repo create mode 100644 kong/license.md create mode 100644 kong/logo.png diff --git a/kong/README-short.txt b/kong/README-short.txt new file mode 100644 index 000000000..75a78adc3 --- /dev/null +++ b/kong/README-short.txt @@ -0,0 +1 @@ +Open-source Microservice & API Management layer built on top of NGINX. \ No newline at end of file diff --git a/kong/content.md b/kong/content.md new file mode 100644 index 000000000..3b7ed8338 --- /dev/null +++ b/kong/content.md @@ -0,0 +1,91 @@ +# What is Kong? + +Kong was built to secure, manage and extend Microservices & APIs. If you're building for web, mobile or IoT (Internet of Things) you will likely end up needing to implement common functionality on top of your actual software. Kong can help by acting as a gateway for any HTTP resource while providing logging, authentication and other functionality through plugins. + +Powered by NGINX and Cassandra with a focus on high performance and reliability, Kong runs in production at Mashape where it has handled billions of API requests for over ten thousand APIs. + +Kong's documentation can be found at [getkong.org/docs](http://getkong.org/docs). + +%%LOGO%% + +# How to use this image + +First, Kong requires a running Cassandra or PostgreSQL cluster before it starts. You can either use the official Cassandra/PostgreSQL containers, or use your own. + +## 1. Link Kong to either a Cassandra or PostgreSQL container + +It's up to you to decide which datastore between Cassandra or PostgreSQL you want to use, since Kong supports both. + +### Cassandra + +Start a Cassandra container by executing: + +```shell +$ docker run -d --name kong-database \ + -p 9042:9042 \ + cassandra:2.2 +``` + +### Postgres + +Start a PostgreSQL container by executing: + +```shell +docker run -d --name kong-database \ + -p 5432:5432 \ + -e "POSTGRES_USER=kong" \ + -e "POSTGRES_DB=kong" \ + postgres:9.4 +``` + +### Start Kong + +Once the database is running, we can start a Kong container and link it to the database container, and configuring the `DATABASE` environment variable with either `cassandra` or `postgres` depending on which database you decided to use: + +```shell +$ docker run -d --name kong \ + -e "DATABASE=cassandra" \ + --link kong-database:kong-database \ + -p 8000:8000 \ + -p 8443:8443 \ + -p 8001:8001 \ + -p 7946:7946 \ + -p 7946:7946/udp \ + --security-opt seccomp:unconfined \ + mashape/kong +``` + +**Note:** If Docker complains that `--security-opt` is an invalid option, just remove it and re-execute the command (it was introduced in Docker 1.3). + +If everything went well, and if you created your container with the default ports, Kong should be listening on your host's `8000` ([proxy][http://getkong.org/docs/latest/configuration/#proxy_port]), `8443` ([proxy SSL](http://getkong.org/docs/latest/configuration/#proxy_listen_ssl)) and `8001` ([admin api](http://getkong.org/docs/latest/configuration/#admin_api_port)) ports. Port `7946` ([cluster](http://getkong.org/docs/latest/configuration/#cluster_listen)) is being used only by other Kong nodes. + +You can now read the docs at [getkong.org/docs](http://getkong.org/docs) to learn more about Kong. + +## 2. Use Kong with a custom configuration (and a custom Cassandra/PostgreSQL cluster) + +This container stores the [Kong configuration file](http://getkong.org/docs/latest/configuration/) in a [Data Volume](https://docs.docker.com/userguide/dockervolumes/). You can store this file on your host (name it `kong.yml` and place it in a directory) and mount it as a volume by doing so: + +```shell +$ docker run -d \ + -v /path/to/your/kong/configuration/directory/:/etc/kong/ \ + -p 8000:8000 \ + -p 8443:8443 \ + -p 8001:8001 \ + -p 7946:7946 \ + -p 7946:7946/udp \ + --security-opt seccomp:unconfined \ + --name kong \ + mashape/kong +``` + +When attached this way you can edit your configuration file from your host machine and restart your container. You can also make the container point to a different Cassandra/PostgreSQL instance, so no need to link it to a Cassandra/PostgreSQL container. + +## Reload Kong in a running container + +If you change your custom configuration, you can reload Kong (without downtime) by issuing: + +```shell +$ docker exec -it kong kong reload +``` + +This will run the [`kong reload`](http://getkong.org/docs/latest/cli/#reload) command in your container. diff --git a/kong/github-repo b/kong/github-repo new file mode 100644 index 000000000..c474bb687 --- /dev/null +++ b/kong/github-repo @@ -0,0 +1 @@ +https://github.com/Mashape/kong \ No newline at end of file diff --git a/kong/license.md b/kong/license.md new file mode 100644 index 000000000..3576710ac --- /dev/null +++ b/kong/license.md @@ -0,0 +1 @@ +View [license information](https://getkong.org/license/) for the software contained in this image. diff --git a/kong/logo.png b/kong/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..2f85949cff807cff35fb7f7439e30ccbd693a5f0 GIT binary patch literal 8744 zcmZX4bzD87>G!Wl6kMMslD2J_rONQGcea3zU7pt_;2l9G^ei za{>xHdnFAe5U48Q!Ic$0aDK;2R}BWL_{q2hoUqzF)71chUUPy#VJHyj61Wt$2?F^D zgFxGsAdpNt2t@NLyIDsL_<+FrxtcQQ_P^~@TTv2lh3M5Y6EC2A_CLF7zq34W$8&XM zC4K+dy-BGs7fix@X_xkW1_+}zi;;W%zqFNO~eJi8CnnrYe?7ock+H;# z=ejwXY#@eR2P$9tuD2$xkOTb)=P7u|hPOX#zs`$-V3fm&$nn@Zd;eurJ*q7FqQyve zHuS5PY0n@bb4OFoyEfmrm34wX)+|(}(Rc3ba#jWfVZ&pe$cu^69$-fiS<$UmvE5tD zkgajo@5#4or6i+q$-IJWw{}-naA>!xI$oz`Xxv&yVjd4Ta5DGVvf<6sJpmVPs_W`acN8Y zG7q)DN@V(_AP|_%)pd`{!gb;J+nqeo%@fJD(bnWJiGwF!S2`;-;&6mlhTxsp!j!Cz ze;1oEY65RG3pq4sEbqOGTRo@8zdHB~;{D^G6g-PdkW-i_@2D+CwvLLM}cg>&Dlh zhf@>Jt~+vD{U60#lwOHPT4|a$2A%iJY$g3L(YrC!^|Z4~m3EopzN=^w8Ak{GH9TBb z_pTx7qi9XF%7*2AZoF5&!$LyZ+g)2tOUIFRNG^_|`KBZt?}o<0!XG^z$+|Jh%fBrT z_SUHA$LiGd^_7*=vr0=(l7iJ8w+edrQkhhF3^4jtB3O9A=LOZV1KTfO3S-)9Etcfp z+_^ENc*-;CAVz0m($9mTqs#Dn|2(sLYjgAW&I%}#B%wZi7-C){d*4|Uzdi%H&3G^LtD_utV9hS1MY_{^{#FjRnVGh8lhmW zYfS=*KkuzyMD~6sjbmmvO@m}+rTHD7t%PRFp%XJOliR{SK()KdUdhH7eF6f!p6@?m zLp@y*irpyqf)-bkC%!*lBIhS2gJbl0gF`Q>GlV)O+#dC6WnZ~W&Qg!RF)^90xE!MY z-c4(7YxkYy`uaGd#zea5b=%@cjr*Wa$yT(4gi*zP(M3NJ82zSgH86r> zW}0D3F?z|6I*gfZ&!;=rbMDj?K_2}SD|@?xPmB1^ zJ~yafUeye|IB+Dna6VoDByRB~TB7mTT2r$PUmD^%&E!3{ht|uNVhW>m;Cs8fiy_X~ zuX!Q@%tYab*NeF~7waFLCEYT83i1!c-^(j>{Jti;ZFAatjYhaLToZqLjA*aM?P$zD zr9G^xtJ{%qd0BsTJyhm`a)~j5659yV*1ODAT}9mTR60xr$FUC%2=QZzQK5S>##(qV zjc;rAVvwR*9pG{v^|&1d+um=aJsrph82V#UjcG2sHCW zR{O%~ObO6dePFx7)$!4vM>sM=DIXsnzNxag^OJR%h_1-QaR6XYzYi17Z?6vE<%ZLJ zf!~UDuV4|_^WrhnSk7_uJR!zd2JN;sJEAu>MyDzVmJ3)$HPzUgm{O=MCsdf8HMQ5* zyLwQ7FC-JFi1_LOYihlhy*bM4ODQ`{{rNUFWZK`=0RIPn8IB3t7=VF=qOy$J-?BSx)C zjB-7tEWrQHK?Z+?`miVK2TYE}VneIgC{;3(dhaUuB=ijzhd}UJ=80)}y?8l0$}$!S z&8V!@vQ_p!EAHzI1Ervu9L)fqWz<`7=1Qrl*0Ys&=S{Ui_4M$ld5!|8y zF`eWU&Cgfky2ThG#n`z~cZfHnj^Th^7jO5h#h z$QHi?L}T*#j(abFfYJLAN?>vNJsJzw?eWsIqM|4gMiFAK_1y~rvj!oP)tizn;_{g;1&}MHGa6>|T>0hNFlnh$%TGQ?dYXg8#HKRXD8&nK0C@Cuu3mq>u z=8UI2nPKBoD#O!;S1E!qMi0RtWe9tpa5VA`AI6BkCp{&G;sv;nWKF3}>HTBfPTlS- zhxa&=H(d_hWUwkvPcNe~gqeu}l1B;_9Thc4c+f^UDKJ*Oe4!x3tl$Ap26FW`VanXs zo?Wey-LR*bCGj;iNtFp_op-Ktvt*Dvr)XK<159aY&4fUtmD_@*%<*8QmtBVwgGKV# zo@~bf_KDMcI@i9MJR#}r$K-7G5`$#jR3w)Mt-@`bv{hc7#&7_Q{YGb4SZ^emtk?dP zed$zT!IER&{$td+f1pOTaL8nlJaGwYNSl^@zI1$gdg(H0s)Wg0|$N>a%S3o_~r3P=&zX= zwMh<&{^G=hi}Ul=y5j{ib#)NP&#!^2H$K2|)+>?xk4EofCrER_8+Qj12!@Vr+ERzD&-(OfL*eHR`;`PCIP^b-t-8|N% zusaKZJ~&*B9yc3`am4v}w!8XcY-{$_^5@xRnXor7L9)YBk{t@h-)k$j2i!@|cs>y% zReh~JcN*9$3zviO;Du2T*N8u_i0e~bXLQ=*)OOMMO^aY?)y9C zt~CIbf37I2Eqlgua{MY+(l0(DB0}8uE5EGs`rrno;NyZX#uX*1`CCEVxmxjc!2&k4 z>zfCm$D7Rm)o0RB$V<)vzys>R&u9JEn}js;HbL4KULdYP!YF0AQ7?eVVTNYBcuBe* z%8G)&{k#=)=gt>nVP~pv;lhJXuFosGw(viT;YhBxf~P;(LX@i72&qd41-X`1@k6u| zKKTl4u1I&;E~_3V@bL3!4*zt)l7^2S$^WeLWK2UR@il*F zYH4b_-LFPGX>QOlFP${3uO@A7l!}TnsY#qCz6oi+2??R1a(W&&v2#pCwM}qds0&Ma>LfX$hs^%hiCcO!>TI-c`>y)q6t-w%#L)y_*c{i}S|BkDRIm z1rwT>-E9``q~}>qR6iPPzkDq$ykEQDqXZ7f;o}p4PKc9|ry^}V9ce5=xdNjKVMWQl zCuH9G&B52#e|C7bnD)Ncdx+pX-4L=_DzrB2GTZ>Qr%IJ(+Y7f!pZW`+c6g`RI2h*e zpCfxXemWLD zrxMUGxm~TgU`;DqpevYy<-{5jfR1s&v}Xr&;2i z(ve{aEuIo<<2R!$ZFm5}VGom{R~=vpqI=>s=Sw%rUb@&gXFSx`W;puQy0HP$WMI$Pkw;RwhK*HOd@?15 zMsuk-K;R}VxWWCg1St>rMRva>RD#5W9PUiwL;HY~H$}CSi|ja_o**y3H{{lLE?$Bd zzv-o5;yV-@D~di&bqUvl7r(+=%Bv!qg`_L+5p1LTW0mJFU}{;Z8{;eYO*oCBlJQ1- zF;o3HMjyI-jX#;PO_-Gt0Rj<6#Bx5u8wC`GMjR0-q}%kVxuF%ptLdv?MUILJGVpZQ zU`AGH)Uzy$uwzVfZG$D*|KhdjEE7h5ij@M-YH@)*4l!LzU7(*ot^<0($VGWXwojS< z0U$#xvNvkZ_>8-IOiYZ*8tgtu10C!_e7lahiGi`d(FDVXL8=NtCNI4oadc0vzdL?9 zAz9hprgxt8@bO6OU;FGr{qSMQWJ-O^e;nxd&ek1>ATOUl1^2kb89kUS%?&ZVS$l}s z?ZoyYuf90m%a7_1JIei&*jD0HBKBIKz2Q#;(bQ&Linsx^>2HQ(O=KMH(eZ@Q%I1N158ri^L{Xug#q@8}DoY0(oUc zfY$@9ndW~1SL10yC(mcv9BeQ1XA&$B7^k9T1E)qeyUI114J*o-nVAKDYNoodqu#xL z?l#}d!K>$0c#reTmPN}B=UtFg@h$=_BcIQ@HyX1fo#Tuf$o?FzAeh}tE6I;|@|q;b z<45bSKQ z89_89XHNdrz6awLklfi=Q6o4erW0wrzH-xnz`~pH+8bOjQ7tWN*6$z#LjyP7Yuf`Q zyo1fq41QjyZmkKt3%e4kUpzUbXT97Ah)KFQRS|Z_XVbsqe;R{8l9JO%cY)KRqc#@V zuHi`zDXHk_Efm&P#{WFJ%hCbYHh`c4)V=`pvzfC0Hw%4R)cf~dbIk@zT{?MPTJh0_ zM(=w)H4$(r4-utCNr8;t7zw>R;S4q}??_NX zV=aH`LiH56H5x-WZgz>V^S%*XzxTHfyHO(5@hz5i>`Y8di->Cf(=sEw;UE+5MW}sF z(8b9*^-%#`1Ocfw_e1MCZBNgE_UouJu601t7is2FnUB&DkkCtYW{%6IZq5~*g$KCz ztwFQOT{2!sI4FiggM zQ(){iY~dh~66EgzHT{e7dDDAVVF_sth#YZ6aGQkJkMk-U5NO=OKV&ufPx)HY!PQMv zL{x&YJfJb`jUA#L1m1iYHfuo31y9k#$HorIO#d}$Rs!>zK~`*5g82?e56Bfz$K~rr z_ixrwfDVj4t?sfkt_k_JRyusz$3YPT(0ng1DQTGjWB9Qb@tm?&?2EZ#p@(;cHNnfK#ke}>;4-Me>}KPp*z*ze?$ zWV&L>0oOM{C4;^6O4 z?CNqCwCZ`$eQ~=v-jX&f306}@_5M(9plPZa-at5yHH6PG)=>w97aPa9Xt^xRnGVU15zX{RbZVHr0axp$ z>Xztp{~%@f^Jm#EKzMWpo2S;eN8$b_>lC1pw=7<^(2U|dQ)A=f{&$lc1qA}k8bMA$ z{>I#HDw}WLsyt5>xIJ9TorlBStQ2r^x#*;S7c>^b=!U}|!)E0L_kkX1KfJ1O&7Q6y z01P?zj=H|#;ovwp*MJ?hH>dwMKMiz@3K2HAB2~sF9QagZ2Yz$avJ->f^ z>gDH4a!SUnlO{SGJhE?P9&s;7cEV*Y9T+D74LjXa;BLnHZv9R1VQ9ZPBRuF|i(_yF zNKp+Sc5ZIe7<)~oU|=8*0@DAMB2=uzOj+4DJt|5zBE4k0WT-6rOLFq^^2bOsQ5D?0 zXwtv4J+Ip`5(awFvpOTAG86kOHU$UETZ~@LVylm=%lBU;Scm$MhNIEMb3kVt9tvxb z`4Nbu7#Pe*H#u(kz1v@03uqTF|6F?$?NWmkb+KF$Y+szgS0Ne81997W5{NL4(4?Xk=%J)8(c9&?izu8^+=rK3D=xv#qlc-y#X_~OenFapx_Tp>k3u{wHU8 zP4AFwAsBXa$6Ci)_y_hWL5IBa`n{%y_h9FLp9=xqEJG1G5lKK7nIRhp*sud{pU0HD zu1wSf$p0B?;&jms)4q;*iA^QSgJLFj?};b*f2uq~^{$wDE7lp>EK376wDQm);?II0 zkoT{yX0Ddmb2iA8?K;`MJC`Oiq*A*tjUOS*?qKpSx+J zqTU9dFUr<4ZbGbdss2iwp?(>mTYa zbO;f)J1*YHMYCUm+4Kz&H(T!}11|7~QTtmLTfHoCj3U{_v@5{aNy!bFuNiJ- zVt`Q7SKH$51_lPsMeoi$ahkNh-C~~Hdvo;>{Nq=D|JFi*`*6l}iFEpyZWXNMd?awo z1fxIpfg)dWBBv<`+vBlbllGw#ax0i`v!bfn3#_kH^K%=eE%pyLqH}`y_I#b}oNg9c zO(UizXRH)Qn1OF8pKTp{`r3Q9F!?@hZcCN#XoTGbvlSe7 zpYRb)3rV(uDJgaj&VUt^myE6>?)AiZHz16y+n&U=JY`}PgC(IHZ_C3mp4 zg*zZyI+$)4DRgfDymAV7c?YUjZt}uEutRFEiEiBDE89;u4uB4c{+k4RchQZXb9QZS zquz$J+pXoWgw8hoiwf_C)hL#gIm@4~?e5B1T{TKqw$V?>X=y80CEvg3SRd9kn!fVo z?7E^yKtiOiqhds#Ff*0v&g#Ip^W?Y=vq1+lMxeXDUa^ol`j(Qy`YgqAT3&BWi*m)C z-TjgdarbM`N*&sneo}4DoOznDCZZ4L`QeHT?jel}@%eEqzS9Be+3#2lxEXYpi1H?J z^FV0jeNedF6&1lgC1sQedVJ$x=o^o92#2tu_$4>C6ZR?C6QA9^x>k#0#LZ9eEU-VC z-Q$8|Si#|8X0_2GoL{cRe-2Nc>@`p$H&)ka9vz1*6M%8b`|{D_SkG1gk2M5v|}ti>1ZXK%!+4DlN(B$pgWU>Ksv8+2Td!SyJPb z_F8r{>j{isB%ylhNQ&enbT^7HtPbiAk#3z#hxxwo5~v(F5mB>;dbWONUIAGoiL`gwTJ z(LcennP+$WXlcEs5fuFT?DfBL6@~pdp-kVcEo^%)h>e(J>+vfo7o$9~u6)X)m-o=-T z9xkxxmz)nyA8azyGt<+q?k^W651Jftkdm~$z=TzGIh2)Q1_b+_4?G*><#%Wt>j{dM z_f^a#TOZk9%FhxHcfPL#!BhI$_p$&4!+b#pG30CvH%!FH7laLb8LKz@l)UZT{P(_( zNkD*)PaM`3@8Pq@6kKX*etwc#T4Y>mz43zTC`i0$Zk2QY!@+7pRXrj$#*urxW6{d& zRc{`nH7yW2ItU$XCnuj3AaWKKUOssumyJfxa+INS<;d}ZfK{QmmXPLG*M?|pA1faB zThO2ZDSyGKXGUpF>HGItaEvuM2nBvPk?~?u++cg)9esIZRP^0WI;T4yA#gTS*G;>S z)@#qpajj+_xx`k=Ta~ZdYMHf{vwAd@yRxs@afY5M0U27hO9;JndU1o4i!J2VG~bb^ zf5akIc64!}L2gIFzSyA2zd7pkn0RMzlfh-oz+(QCCqmnQ`cn}z!|CxRInW5%$>#&j ztBx?ztFr8v73k6ZTdB0e>n*;-5up^`T@WZ;(qOHS^Y+p_7juNZg6(IY>*!^V+jKj7 zsu`hZ!?e}6sn*vM@kNWywy3R!PwLR;fuHU%e1>9b1C6H-KXvYge~vwNz6rMGVI$_N zJG-wf6Ud!C&kFN(lW(mu++Wosq81*Zi(P9N2|e8X(rZKT#7R>Ym-hMFg%$;otc34Z znQJID9wPQDe13hJY7MNx)!k5;{ktrm(5m~*1hmccDr}MGjqz{ zTbCnrLZ$)Inp`&$Usb9)+v37~^9hn6qnB(enpbgF`PM$4DP32{uU;y0-GnOs&yxk8 z^r~cV+M^g_v_JQ`LPWCsAJ;jjX27E3@K!PQwzcv`%Gh`!fdT{-7LgDT77>67>kC6= zL`8tNfUvlXu<(RI_5A;;;OcJcXczE*D?laxe}(&=3Ozsty8l|xbGP&Mv+_iOlx*Ft gk*w;jR`y6;q?K)eM?dnvCpJLpDw@g_Fw5}&2VleNZ2$lO literal 0 HcmV?d00001