├── .gitignore ├── LICENSE ├── README.md ├── examples └── webserver.sh ├── kn.sh └── knlib.sh /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A Kubernetes native shell experience: `kn` 2 | 3 | The basic idea behind `kn` is to use the fact that pods in Kubernetes are modelled after machines. That is, the apps running in containers in the pod can communicate with each other via `localhost` and transfer data via volumes they can mount into their own filesystem hierarchy as they see fit. 4 | 5 | So, imagine you want to try something out real quick? Do a short iteration using a scripting language such as Python, Ruby, or Node.js? Might want to jump on a container to debug something in-cluster? Run a quick load test? Then, `kn` is for you: it offers a collection of shell functions allowing you to quickly launch a pod, jump into it and have the code and data available you need to carry out your task. 6 | 7 | **Note that this tool is meant to be used in dev and test environments. Use at your own risk.** 8 | 9 | ## Install 10 | 11 | Simply Git clone or download this repo from the [release page](https://github.com/mhausenblas/kn/releases/latest), and copy `kn*.sh` somewhere on your path. If you're super fancy, you can set an alias like so: (since I moved the script to `/Users/mhausenblas/bin/`): 12 | 13 | ```shell 14 | alias kn='/Users/mhausenblas/bin/kn.sh' 15 | ``` 16 | 17 | I've tested `kn` in the Bash shell v3.2 on macOS and Linux. Note that in order to work `kn` requires you to have `kubectl` [installed and configured](https://kubernetes.io/docs/tasks/tools/install-kubectl/). If you also want to use the (optional) feature to expose an environment to the public, you need to have [ngrok](https://ngrok.com/) installed and configured. 18 | 19 | ## Use 20 | 21 | ### Config 22 | 23 | The following environment variables are used (set global or per invocation): 24 | 25 | - `KN_BASE_IMAGE` … set the base image to use; defaults to `centos:7`. 26 | - `KN_SYNC` … if set to `true`, the content of the current directory will be copied into the pod at `/tmp/work`; defaults to `true`. 27 | - `KN_POLICY` … if set to `public`, services will be made available on the public Web using `ngrok`; defaults to `local`. 28 | - `KN_MODE` … if set to `daemon`, the environment is detached and we assume there's some kind of networked service running; defaults to `interactive`. 29 | 30 | ### Commands 31 | 32 | The following commands are available: 33 | 34 | - `up [NAME] [PORT]` … creates environment, copies files of current directory unless disabled by `KN_SYNC=false`. 35 | - `connect NAME` … puts you into the running environment. 36 | - `down NAME` … deletes environment, removes all resources associated with it. 37 | - `publish NAME PORT` … publishes the daemonized environment `NAME` by using port-forwarding of `PORT` in the environment (assuming something serves on this port in the container) to port `9898` locally, and, if enabled by `KN_POLICY`, makes it also publicly available using `ngrok`. 38 | - `ls` … lists all resources manged by `kn`. 39 | 40 | ## Examples 41 | 42 | Launching an interactive environment with `kn`: 43 | 44 | ```shell 45 | ## launch interactive environment: 46 | $ kn up 47 | ....... 48 | Copied content of /Users/mhausenblas/tmp to /tmp/work in the environment 49 | The environment [sandbox] is now ready! 50 | 51 | ## list all environments: 52 | $ kn ls 53 | NAME SINCE 54 | sandbox 2018-10-22T10:16:13Z 55 | 56 | ## jump into the environment: 57 | $ kn connect 58 | connecting to sandbox-64dc6d6bf9-s6gzjsh-4.2# 59 | sh-4.2# 60 | sh-4.2# ps -ef 61 | UID PID PPID C STIME TTY TIME CMD 62 | root 1 0 0 10:16 ? 00:00:00 sleep 86400 63 | root 27 0 0 10:17 pts/0 00:00:00 sh 64 | root 36 27 0 10:17 pts/0 00:00:00 ps -ef 65 | sh-4.2# exit 66 | exit 67 | 68 | ## destroy the environment: 69 | $ kn down 70 | The environment [sandbox] has been destroyed, all data is gone the way of the dodo 71 | ``` 72 | 73 | Publishing a daemonized environment using the container image `quay.io/mhausenblas/pingsvc:2` that serves on port `8888`: 74 | 75 | ```shell 76 | ## launch as daemonized env: 77 | $ KN_BASE_IMAGE=quay.io/mhausenblas/pingsvc:2 KN_MODE=daemon kn up psvc 8888 78 | The daemonized environment [psvc] is now ready! 79 | To publish your environment, do: kn publish psvc 8888 80 | 81 | ## now make it publicly available using ngrok: 82 | $ KN_POLICY=public kn publish psvc 8888 83 | ngrok by @inconshreveable 84 | 85 | Session Status online 86 | Account Michael Hausenblas (Plan: Pro) 87 | Version 2.2.8 88 | Region United States (us) 89 | Web Interface http://127.0.0.1:4040 90 | Forwarding http://0cf727cf.ngrok.io -> localhost:9898 91 | Forwarding https://0cf727cf.ngrok.io -> localhost:9898 92 | 93 | Connections ttl opn rt1 rt5 p50 p90 94 | 1 0 0.01 0.00 0.30 0.30 95 | 96 | HTTP Requests 97 | ------------- 98 | 99 | GET /ping 200 OK 100 | 101 | ## in a second terminal session, check if we can get to the service: 102 | $ curl localhost:9898/ping 103 | pong 104 | 105 | $ curl http://0cf727cf.ngrok.io/ping 106 | pong 107 | 108 | ## now we can get rid of the environment: 109 | $ kn down psvc 110 | The environment [psvc] has been destroyed, all data is gone the way of the dodo 111 | ``` -------------------------------------------------------------------------------- /examples/webserver.sh: -------------------------------------------------------------------------------- 1 | while true ; do nc -l -p 8080 -c 'echo -e "HTTP/1.1 200 OK\n\n $(date)"'; done -------------------------------------------------------------------------------- /kn.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ################################################################################ 4 | ### Michael Hausenblas, (c) 2018 5 | ### https://mhausenblas.info 6 | 7 | set -o errexit 8 | set -o errtrace 9 | set -o pipefail 10 | 11 | ################################################################################ 12 | ### INIT ####################################################################### 13 | 14 | ### include all the functions we gonna need 15 | source ./knlib.sh 16 | 17 | ### command line arguments 18 | COMMAND="${1:-ls}" # if no command given, default to list environments 19 | CURRENTENV="${2:-sandbox}" # if no environment given, default to 'sandbox' 20 | PPORT="${3}" # must be provided for expose 21 | 22 | ### globals 23 | KN_NAMESPACE=kn 24 | 25 | ### pick up environment variables, if present 26 | if [[ -z "${KN_BASE_IMAGE}" ]]; then 27 | KN_BASE_IMAGE="centos:7" 28 | else 29 | KN_BASE_IMAGE="${KN_BASE_IMAGE}" 30 | fi 31 | 32 | if [[ -z "${KN_SYNC}" ]]; then 33 | KN_SYNC="true" 34 | else 35 | KN_SYNC="${KN_SYNC}" 36 | fi 37 | 38 | if [[ -z "${KN_POLICY}" ]]; then 39 | KN_POLICY="local" 40 | else 41 | KN_POLICY="${KN_POLICY}" 42 | fi 43 | 44 | if [[ -z "${KN_MODE}" ]]; then 45 | KN_MODE="interactive" 46 | else 47 | KN_MODE="${KN_MODE}" 48 | fi 49 | 50 | ### make sure the namespace exists before we proceed 51 | kubectl get ns | \ 52 | grep $KN_NAMESPACE > /dev/null || (kubectl create ns $KN_NAMESPACE) 53 | 54 | ################################################################################ 55 | ### MAIN ####################################################################### 56 | 57 | case $COMMAND in 58 | ls) 59 | env_ls $KN_NAMESPACE 60 | ;; 61 | up) 62 | env_up $KN_NAMESPACE $CURRENTENV $KN_BASE_IMAGE $KN_SYNC $KN_MODE $PPORT 63 | ;; 64 | connect) 65 | env_connect $KN_NAMESPACE $CURRENTENV 66 | ;; 67 | down) 68 | env_down $KN_NAMESPACE $CURRENTENV 69 | ;; 70 | publish) 71 | env_publish $KN_NAMESPACE $CURRENTENV $KN_POLICY $PPORT 72 | ;; 73 | help) 74 | print_help 75 | printf "\n\n" 76 | print_cfg $KN_BASE_IMAGE $KN_SYNC $KN_POLICY 77 | ;; 78 | *) 79 | printf "The [$COMMAND] command is not (yet) supported!\n\n" 80 | print_help 81 | esac -------------------------------------------------------------------------------- /knlib.sh: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | ### FUNCTIONS ################################################################## 3 | 4 | function env_up { 5 | ns=$1 6 | currentenv=$2 7 | img=$3 8 | cppolicy=$4 9 | imode=$5 10 | pport=$6 11 | pod=$(kubectl -n $ns get po -l=run=$currentenv --output=jsonpath={.items[*].metadata.name}) 12 | #echo $1 $2 $3 $4 $5 $6 13 | 14 | # create a dedicated service account: 15 | kubectl -n $ns create sa $currentenv > /dev/null 16 | # launch environment depending on mode: 17 | if [[ $imode == "interactive" ]] 18 | then 19 | # launch interactive environment that stays up for 24h: 20 | kubectl -n $ns run $currentenv --image=$img --serviceaccount=$currentenv > /dev/null 2>&1 -- sleep 86400 21 | # make sure the pod is running so that we can copy stuff in there: 22 | while true 23 | do 24 | isrunning=$(kubectl -n $ns get po -l=run=$currentenv --output=jsonpath={.items[*].status.phase}) 25 | printf "." 26 | if [[ $isrunning == "Running" ]] 27 | then 28 | break 29 | fi 30 | sleep 3 31 | done 32 | # if enabled, copy contents of current directory into environment at /tmp/work 33 | if [[ $cppolicy == "true" ]] 34 | then 35 | srcdir=$(pwd) 36 | p=$(kubectl -n $ns get po -l=run=$currentenv --output=jsonpath={.items[*].metadata.name}) 37 | kubectl -n $ns cp $srcdir $ns/$p:/tmp/work 38 | printf "\nCopied content of $(pwd) to /tmp/work in the environment\n" 39 | fi 40 | printf "The environment [$currentenv] is now ready!\nTo get into your environment, do: kn connect $currentenv\n" 41 | else # daemon mode 42 | if [[ -z "${pport}" ]]; then 43 | printf "No port given, use: KN_MODE=daemon kn up NAME PORT" 44 | exit 1 45 | fi 46 | # launch a daemonized environment: 47 | kubectl -n $ns run $currentenv --image=$img --serviceaccount=$currentenv --port=$pport > /dev/null 2>&1 48 | printf "The daemonized environment [$currentenv] is now ready!\nTo publish your environment, do: kn publish $currentenv $pport\n" 49 | fi 50 | } 51 | 52 | function env_connect { 53 | ns=$1 54 | currentenv=$2 55 | pod=$(kubectl -n $ns get po -l=run=$currentenv --output=jsonpath={.items[*].metadata.name}) 56 | printf "connecting to $pod" 57 | kubectl -n $ns exec -it $pod -- sh 58 | } 59 | 60 | 61 | function env_down { 62 | ns=$1 63 | currentenv=$2 64 | kubectl -n $ns delete deployment $currentenv > /dev/null 65 | kubectl -n $ns delete sa $currentenv > /dev/null 66 | if [ -x "$(command -v pkill)" ] 67 | then 68 | pkill -if "kubectl -n kn port-forward" 69 | else 70 | kill $(ps -ef | grep '[k]ubectl.*port-forward' | awk '{print $2}') 71 | fi 72 | printf "The environment [$currentenv] has been destroyed, all data is gone the way of the dodo\n" 73 | } 74 | 75 | function env_publish { 76 | ns=$1 77 | currentenv=$2 78 | ppolicy=$3 79 | pport=$4 80 | if [[ -z "${pport}" ]]; then 81 | printf "No port given, use: kn publish NAME PORT" 82 | exit 1 83 | fi 84 | kubectl -n $ns port-forward deployment/$currentenv 9898:$pport & 85 | # if enabled, publish environment to public 86 | if [[ $ppolicy = "public" ]] 87 | then 88 | if ! [ -x "$(command -v ngrok)" ] 89 | then 90 | printf "Sorry, need https://ngrok.com installed to publish the environment" 91 | else 92 | ngrok http 9898 93 | fi 94 | fi 95 | } 96 | 97 | function env_ls { 98 | ns=$1 99 | kubectl -n $ns get deploy -o=custom-columns=NAME:.metadata.name,SINCE:.metadata.creationTimestamp 100 | } 101 | 102 | function print_help { 103 | printf "I currently only know about the following commands:\n[up], [connect], [down], [publish], [ls]\n" 104 | } 105 | 106 | function print_cfg { 107 | baseimage=$1 108 | synccwd=$2 109 | policy=$3 110 | printf "kn is using the following settings\n" 111 | printf "==================================\n" 112 | printf " Base image: [$baseimage] (set with KN_BASE_IMAGE)\n" 113 | printf " Sync current directory: [$synccwd] (set KN_SYNC=true to enable)\n" 114 | printf " Publishing policy: [$policy] (set KN_POLICY=public to expose publicy)\n" 115 | } --------------------------------------------------------------------------------