diff --git a/plugins/kn-curl/LICENSE b/plugins/kn-curl/LICENSE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/plugins/kn-curl/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/plugins/kn-curl/README.md b/plugins/kn-curl/README.md new file mode 100644 index 00000000..20f52c86 --- /dev/null +++ b/plugins/kn-curl/README.md @@ -0,0 +1,33 @@ +## kn-curl + +This plugins makes it easy to curl a Knative service. + +### Assumptions + +1. Your Knative installation uses Istio for its mesh networking. +2. You follow the Dependencies listed below. +3. You don't have a custom domain for your services. + +### Dependencies + +1. Get the latest [`kn`](https://github.com/knative/client/releases) binary for + your platform. +2. Make sure the `kn-curl` BASH file is in your plugins directory (default + `~/.config/kn/plugins`). If you are using a custom plugins repository, then + add it there. +3. Make sure the `kn-curl` BASH file has executable permissions. You can achieve + this with `chmod +x kn-curl`. + +### Examples + +```bash +# curl the service named hello +kn curl hello +``` + +### Next steps + +1. Remove Istio assumption or at least deal with cases of non-istio Knative + deployments. +2. Determine the domain and use that or default `example.com` if not set. +3. Add e2e test for this BASH plugin. diff --git a/plugins/kn-curl/e2e-test.sh b/plugins/kn-curl/e2e-test.sh new file mode 100755 index 00000000..b3d9867a --- /dev/null +++ b/plugins/kn-curl/e2e-test.sh @@ -0,0 +1,90 @@ +#!/bin/bash + +# Copyright ยฉ 2020 The Knative Authors +# +# 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. + +# Variables and defaults +KN=`which kn` +KUBECTL=`which kubectl` +E2E_TEST_NS=$"kn-curl-e2e-tests" +E2E_TEST_SERVICE_NAME=$"kn-curl-e2e-test-service" + +# Check that kn is in PATH +check_kn_in_path() { + if [ -z "${KN_PATH}" ]; then + if [ -x "${KN}" ]; then + echo "โœ… Found kn executable: $KN" + else + echo "๐Ÿ”ฅ Could not find kn executable, please add it to your PATH or set KN_PATH" + exit -1 + fi + else + echo "โœ… KN_PATH is set to: $KN_PATH" + export PATH=$KN_PATH:$PATH + fi +} + +# Check that kubectl is in PATH +check_kubectl_in_path() { + if [ -z "${KUBECTL_PATH}" ]; then + if [ -x "${KUBECTL}" ]; then + echo "โœ… Found kubectl executable: $KUBECTL" + else + echo "๐Ÿ”ฅ Could not find kubectl executable, please add it to your PATH or set KUBECTL_PATH" + exit -1 + fi + else + echo "โœ… KUBECTL_PATH is set to: $KUBECTL_PATH" + export PATH=$KUBECTL_PATH:$PATH + fi +} + +# Check kn and kubectl +check_kn_in_path +check_kubectl_in_path + +# Create e2e-test namespace +kubectl create ns $E2E_TEST_NS + +# Check last call +function check() { + if [ $? != 0 ]; then + echo "๐Ÿ”ฅ failed to $1" + exit 1 + fi +} + +# Start +echo "๐Ÿงช start kn curl e2e tests" + +# Test 1: create public service +kn service create $E2E_TEST_SERVICE_NAME --image knativesamples/helloworld --namespace $E2E_TEST_NS | check "create service" +kn curl $E2E_TEST_SERVICE_NAME | check "curl public service" + +# Test 2: update servcie to private (cluster local) service +kn service update $E2E_TEST_SERVICE_NAME --cluster-local --namespace $E2E_TEST_NS | check "update service to cluster_local" +kn curl $E2E_TEST_SERVICE_NAME | check("curl private service") + +# Cleanup +echo "๐Ÿงน cleanup" + +# Delete service +kn service delete $E2E_TEST_SERVICE_NAME --namespace $E2E_TEST_NS | check "delete service" + +# Delete namespace +kubectl delete ns $E2E_TEST_NS + +wait 2 +echo "โœ… Success" +exit 0 diff --git a/plugins/kn-curl/kn-curl b/plugins/kn-curl/kn-curl new file mode 100755 index 00000000..401e61d5 --- /dev/null +++ b/plugins/kn-curl/kn-curl @@ -0,0 +1,88 @@ +#!/bin/bash + +# Copyright ยฉ 2020 The Knative Authors +# +# 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. + +USAGE=$"Usage: + kn curl NAME + +Examples: + # Curl service hello + kn curl hello + + # Curl service hello in namespace myns + kn curl hello -n myns + + Flags: + -n, --namespace string Specify the namespace to operate in. +" + +# Need at least the service name +if [ -z "$1" ]; then + echo "$USAGE" + exit 0 +fi + +# If -h or --help is first argument +if [ "$1" == "-h" ] || [ "$1" == "--help" ]; then + echo "$USAGE" + exit 0 +fi + +# Setup the service name +SERVICE_NAME=$1 + +# Flags +N="-n" +NAMESPACE="--namespace" +NS="default" + +# Parse arguments for -n or --namespace and namespace value +if [ "$N" == "$2" ] || [ "$NAMESPACE" == "$2" ]; then + NS="$3" +fi + +# Get kubectl path +KUBECTL=`which kubectl` +if [ $? -ne 0 ]; then + echo "$USAGE" + echo "kubectl must also be in your PATH" + exit 0 +fi + +# Check istio is setup as ingress +ISTIO_POD=$($KUBECTL get pods -n knative-serving | grep networking-istio | awk '{print $1}') +if [ $? -ne 0 ]; then + echo "$USAGE" + echo "Knative must also be installed with Istio for this version." + exit 0 +fi + +# Get INGRESS assuming Istio +INGRESS=$($KUBECTL get svc istio-ingressgateway --namespace istio-system | awk '{print $4}' | tail +2) + +# Check if the servcice's cluster-local is on +CLUSTER_LOCAL=$($KUBECTL get ksvc $SERVICE_NAME --namespace $NS -o=jsonpath='{@.metadata.labels.serving\.knative\.dev\/visibility}') + +# Get URL for the service +URL=$($KUBECTL get ksvc $SERVICE_NAME --namespace $NS -o=jsonpath='{@.status.url}') + +# Perform curl of service either with CLUSTER_LOCAL or URL +if [ -z "$CLUSTER_LOCAL" ]; then + echo "curl -sS $URL" + curl -sS $URL +else + echo "curl -sS -H 'Host: $SERVICE_NAME.$NS.svc.cluster.local' http://$INGRESS" + curl -sS '-H' 'Host: '"$SERVICE_NAME"'.'"$NS"'.'svc.cluster.local'' http://"$INGRESS" +fi