From 02cb2e78e32985e07baf7f797b8660773b1a9c55 Mon Sep 17 00:00:00 2001 From: Jason Hall Date: Thu, 17 Dec 2020 06:43:19 -0500 Subject: [PATCH] host docs on GitHub, where it's prettier --- README.md | 54 ++++------------------- cmd/app/kodata/favicon.ico | Bin 4286 -> 0 bytes cmd/app/kodata/index.html | 85 ------------------------------------- cmd/app/main.go | 34 --------------- cmd/buildpack/main.go | 2 +- cmd/flatten/main.go | 2 +- cmd/ko/main.go | 2 +- cmd/mirror/main.go | 2 +- cmd/random/main.go | 2 +- 9 files changed, 14 insertions(+), 169 deletions(-) delete mode 100644 cmd/app/kodata/favicon.ico delete mode 100644 cmd/app/kodata/index.html delete mode 100644 cmd/app/main.go diff --git a/README.md b/README.md index e0d7a16..8ca09b7 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,16 @@ **kontain.me** serves Docker container images generated on-demand at the time they are requested. -# `random.kontain.me` +These include: -`docker pull random.kontain.me/random:latest` serves an image containing random -data. By default the image contains one layer containing 10 MB of random bytes. -You can request a specific size and shape of random image. For example, -`random.kontain.me/random:4x100` generates a random image of 4 layers of 100 -random bytes each. - -# `mirror.kontain.me` - -`docker pull mirror.kontain.me/[image]` will pull the an image (if it can) and -cache the manifest and layers. Subsequent pulls will, if possible, serve from -the cache. - -This acts as a simple [registry -mirror](https://docs.docker.com/registry/recipes/mirror/) which can reduce the -number of pulls from the original registry, in case they impose request limits -or exorbitant bandwidth costs or latencies. - -# `flatten.kontain.me` - -`docker pull flatten.kontain.me/[image]` will pull an image (if it can), then -flatten its layers into a single layer.

- -_Flattening images obviates image layer caching, so it's often not an -optimization._ - -# `ko.kontain.me` - -`docker pull ko.kontain.me/ko/[import path]` serves an image -containing a Go binary fetched using `go get` and built into a -container image using [ko](https://github.com/google/ko). - -For example, `docker pull ko.kontain.me/ko/github.com/google/ko/cmd/ko` will -fetch, build and (eventually) serve a Docker image containing `ko` itself. -_Koception!_ - -# `buildpack.kontain.me` - -`docker pull buildpack.kontain.me/[ghuser]/[ghrepo]:[revision]` serves an image -fetched from source on GitHub and built using [CNCF -Buildpacks](https://buildpacks.io) - -For example, `docker pull -buildpack.kontain.me/buildpack/sample-java-app:b032838` fetches, builds and -serves a [sample Java app](https://github.com/buildpack/sample-java-app). +* [`random.kontain.me`](./cmd/random), which serves randomly-generated images. +* [`mirror.kontain.me`](./cmd/mirror), which pulls and caches images from other registries. +* [`flatten.kontain.me`](./cmd/flatten), which pulls and flattens images from other registries, + so they contain only one layer. +* [`ko.kontain.me`](./cmd/ko), which builds a Go binary into a container image using + [`ko`](https://github.com/google/ko). +* [`buildpack.kontain.me`](./cmd/buildpack), which builds a GitHub repo using [CNCF + Buildpacks](https://buildpacks.io). # Caveats diff --git a/cmd/app/kodata/favicon.ico b/cmd/app/kodata/favicon.ico deleted file mode 100644 index 0c34bfd1a222dd07116a82b324108ce3f5c9ecf5..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4286 zcmb`Lc~F%18OMK!qiLF&I@3uHYhrCZ5UGS=FDOA$m)N}*gK4|g;;ost;eGC{0HCr?hn{72H!pXk~2|7T9$T9JtZJl zztJte_WVlE)T*`8)IWI23Z`z`t9Z$8{BWlNa&;{Dpk{_owl>N~+4hCIyaAR<qkk{FIs{(rkURkFxz6zr1tck=y{wByzBK zNdSB21i(K2zFd-2v)VJ|BbSJSKU(dX%m7}`*H<+hn5$u71)4W}6j~pt!f@LsrvrR* zJHh|pIdD&^f6k{Ku&@WJN6Xw2n^*3VJ2-?W-lpP@QNk8#j;!nX6YxPAZy+0+^~^n8!}jE9-jOPFSyDyYzpPx+Zqd*E zxAI9pc|K9Q@O;sZ7+B~K0d`LDLOI8Ov&1#w68aJLkzdBI4ecE)B<(0?@5gnObzE)Z ztJJRb&eoey^Hb7m<)dceiWP9s2rdU|Q7`gE&n-uu1AK1p6bJS@VtH?iFrRjgG29b- z=lCbs$Mw}-DH~^h9Lb8$4r33$WV@AmDf<1T)o=8jo=?w20n!o5b?}KN7ypMu; zfA)igpM+TZv)i^G=6@WFon>8+Aw>2D=V4uWaK>V#?umEehhdhTZ^J9s} z`&ituo|&kPXN~yWcb>a;tLMIXLhfko?cw|yeqFjYUkBtlvhC3WK6_-${i6hax894N zCr=h^M*fyin7?@+EO(b5W^5IUDm~94kD7mh>*@yiEqYG+$$L?=A99K9kFzJfQ*5=i|BeJ(9~PeBnpBSwu;J-Heio2+X#mN6k%skH=X}9S0 z%M;j9N6k>x+6z^x0dSNFd|CsXk9`oAvd;My4=9(yK0)geKZ9N@a+KlTnN(NX+-|$) zkdf^zG_6Gbqun{Uzaf{3w3BA4;KN;zUEKu+Q$LJcy8`N-8?Zh4_zV8?8BqR3zC}N= zDI?-KrF>Am?=EjDZ_rQ0nX-_=t__&K$Jm24Zz9`2-vqfe=b)jX5&C+2Vd&CDsB0Sr zhp0-fi>@tZP|zuQfO^Fq=rgFDO5~${Rd8zQG~^QB36J0U=AN_8T;vDjcR_iB5!7lG z3=Ivzg9o2MYtJ}riLBs!(R=Z@!b1+rkSAn8*bBuT#r=xjTk4jmcix}>hPSeV1syU; zk^Rh?b&K}_s67y?1Sbu zE3PZtUlut=3$s9fT_bYfKu!h7vP&UIUIb2IIk3tzMerYevGU!LdOc)?Gd9O-h@Zr@ zTk=NU6Q7Q>)*IRfp>yyS6sm7QY}H>NsIUk3$#&S4sRhTF8d&3<0ruM>a9;}t=g=&O zLw<~+3}Uc{xSVp>CClero>5BR?xv0X(w};3{u|KLs5E|HNWQ%&+45qqB}eoU$CeV+%NcVh*sE zVTaJ%pW!%JV7{?@^6aUXkfI)lsT_ugvWs~C?*zO*V+m|JiX}pr@Web$KkYb1WsZfWi4h1N-f3vPB`9!WtM$_)?(u5hQRD!DNbLU z9*}R;5TEiERx$vxW5WgXyPVt9a|=$JMzF3! zQ_oFk#Mhd@5M|-9~*-3(hGPG z>Ucq?sGYcyR5b+Uw?RSkC1~!w4eG&rcpQf_$Ru{-`5Ra_k$VMXrQN7O2lRXH89L02 z4xAF|Vf~&%u+l62jzehv+?a~KnUQ6K7b4Mb+UG@IC03sW?c{-9jvlh>`uU8B+tPO% z&UB4(uN%!bQ1dOQ&|ihv@^0|V(t&HLhO>$9hJCvV_0&B>dsC9yyw5A4WO`lCUu~l+ z26uR68(L83my$H~Q~E6NC6*ccDD;q0-2=6zG1U7h`h5rLy9I88d5m*u{t1=m!7H1% zYR;veIa}aAbxl=`xu>FPG@ z;~$<`S~yVA4OQ(Ue7?kO=pN&G=}3A{bc{gqiC+Ah#efQyP2K1LQO}Z&t)t%QN z?PNdRuiC5{MZK2e6Sp+=b<``{mC-W0zPW+L7PU-9zVdb7*ca^Dy{~L_gLmgOna8|O z8?PP3Y~83ejy}$)9l)$S=UP2R&FK9T)H{OQDDSM+*^T;U7F~Sym7LdkqjTsk>%ac_ z6y1gKS(v{qxbGfDjU!l(iB0o%Nl|_4lG1twxskh->RGq%nORb$?sYEze|;wPgqfAK zUYrtK&^{Z#n@M+OYIT^Eo9^kVWbe$g@7@_bfqI)> - - -Kontain.me - - - -

kontain.me serves Docker container images generated on-demand at the -time they are requested.

- -

random.kontain.me

- -

docker pull random.kontain.me/random:latest serves an image containing -random data. By default the image contains one layer containing 10 MB of random -bytes. You can request a specific size and shape of random image. For example, -random.kontain.me/random:4x100 generates a random image of 4 layers of -100 random bytes each. - -

mirror.kontain.me

- -

docker pull mirror.kontain.me/[image] will pull the an image -(if it can) and cache the manifest and layers. Subsequent pulls will, if -possible, serve from the cache.

- -

This acts as a simple registry - mirror which can reduce the number of pulls from the original -registry, in case they impose request limits or exorbitant bandwidth costs or -latencies.

- -

flatten.kontain.me

- -

docker pull flatten.kontain.me/[image] will pull an image (if -it can), then flatten its layers into a single layer.

- -

Flattening images obviates image layer caching, so it's often not an - optimization.

- -

ko.kontain.me

- -

docker pull ko.kontain.me/[import path] serves an image -containing a Go binary fetched using go get and built into a -container image using ko.

- -

For example, -docker pull ko.kontain.me/github.com/google/ko/cmd/ko will fetch, -build and (eventually) serve a Docker image containing ko itself. -Koception!

- -

NB: All Docker image references must be lowercase.

- -

buildpack.kontain.me

- -

docker pull buildpack.kontain.me/[ghuser]/[ghrepo]/[path/to/app]:[revision] -serves an image fetched from source on GitHub and built using CNCF Buildpacks. Specifically, it uses the GCP buildpack - builder

- -

For example, docker pull - buildpack.kontain.me/googlecloudplatform/buildpack-samples/sample-go:master - fetches, builds and serves a sample - Go app.

- -

NB: All Docker image references must be lowercase.

- -

The image tag can be a commit, branch or tag. The default, -:latest, pulls the master branch.

- -

Caveats

- -

The registry does not accept pushes of any kind. This is a silly hack and if -it's at all reliable it's by accident. Don't rely on it for anything serious. -It could probably do a lot of smart things to be a lot faster.

- -

Source is available on -GitHub.

- - diff --git a/cmd/app/main.go b/cmd/app/main.go deleted file mode 100644 index 738b8c6..0000000 --- a/cmd/app/main.go +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright 2018 Google LLC All Rights Reserved. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package main - -import ( - "fmt" - "log" - "net/http" - "os" -) - -func main() { - http.Handle("/", http.FileServer(http.Dir("/var/run/ko"))) - log.Println("Starting...") - port := os.Getenv("PORT") - if port == "" { - port = "8080" - log.Printf("Defaulting to port %s", port) - } - log.Printf("Listening on port %s", port) - log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil)) -} diff --git a/cmd/buildpack/main.go b/cmd/buildpack/main.go index 72fa996..4f8cb57 100644 --- a/cmd/buildpack/main.go +++ b/cmd/buildpack/main.go @@ -54,7 +54,7 @@ func main() { error: log.New(os.Stderr, "E ", log.Ldate|log.Ltime|log.Lshortfile), ds: ds, }) - http.Handle("/", http.RedirectHandler("https://kontain.me", http.StatusMovedPermanently)) + http.Handle("/", http.RedirectHandler("https://github.com/imjasonh/kontain.me/blob/master/cmd/buildpack", http.StatusSeeOther)) log.Println("Starting...") port := os.Getenv("PORT") diff --git a/cmd/flatten/main.go b/cmd/flatten/main.go index f7db5ed..1b8f6c4 100644 --- a/cmd/flatten/main.go +++ b/cmd/flatten/main.go @@ -37,7 +37,7 @@ func main() { info: log.New(os.Stdout, "I ", log.Ldate|log.Ltime|log.Lshortfile), error: log.New(os.Stderr, "E ", log.Ldate|log.Ltime|log.Lshortfile), }) - http.Handle("/", http.RedirectHandler("https://kontain.me", http.StatusMovedPermanently)) + http.Handle("/", http.RedirectHandler("https://github.com/imjasonh/kontain.me/blob/master/cmd/flatten", http.StatusSeeOther)) log.Println("Starting...") port := os.Getenv("PORT") diff --git a/cmd/ko/main.go b/cmd/ko/main.go index 190083d..b76cefc 100644 --- a/cmd/ko/main.go +++ b/cmd/ko/main.go @@ -41,7 +41,7 @@ func main() { info: log.New(os.Stdout, "I ", log.Ldate|log.Ltime|log.Lshortfile), error: log.New(os.Stderr, "E ", log.Ldate|log.Ltime|log.Lshortfile), }) - http.Handle("/", http.RedirectHandler("https://kontain.me", http.StatusMovedPermanently)) + http.Handle("/", http.RedirectHandler("https://github.com/imjasonh/kontain.me/blob/master/cmd/ko", http.StatusSeeOther)) log.Println("Starting...") port := os.Getenv("PORT") diff --git a/cmd/mirror/main.go b/cmd/mirror/main.go index bc54950..c1ebafc 100644 --- a/cmd/mirror/main.go +++ b/cmd/mirror/main.go @@ -32,7 +32,7 @@ func main() { info: log.New(os.Stdout, "I ", log.Ldate|log.Ltime|log.Lshortfile), error: log.New(os.Stderr, "E ", log.Ldate|log.Ltime|log.Lshortfile), }) - http.Handle("/", http.RedirectHandler("https://kontain.me", http.StatusMovedPermanently)) + http.Handle("/", http.RedirectHandler("https://github.com/imjasonh/kontain.me/blob/master/cmd/mirror", http.StatusSeeOther)) log.Println("Starting...") port := os.Getenv("PORT") diff --git a/cmd/random/main.go b/cmd/random/main.go index 65521b5..d18daf8 100644 --- a/cmd/random/main.go +++ b/cmd/random/main.go @@ -18,7 +18,7 @@ func main() { info: log.New(os.Stdout, "I ", log.Ldate|log.Ltime|log.Lshortfile), error: log.New(os.Stderr, "E ", log.Ldate|log.Ltime|log.Lshortfile), }) - http.Handle("/", http.RedirectHandler("https://kontain.me", http.StatusMovedPermanently)) + http.Handle("/", http.RedirectHandler("https://github.com/imjasonh/kontain.me/blob/master/cmd/random", http.StatusSeeOther)) log.Println("Starting...") port := os.Getenv("PORT")