Knative developer experience, docs, reference Knative CLI implementation
Go to file
Navid Shaikh 2e1a863815
Revisit sink prefixes: Support only 'ksvc' prefix and drop 'svc', 'service' support for knative service (#896)
* Update description for sink flag

 - Add examples for broker, service and URI
 - Add note about default prefix and service alias

* Update the sink flag description

* Update cli conventions doc

* Update the sink prefixes mapping

 - 'ksvc' prefix for knative services
 -  Remove 'svc' or 'service' prefixes mapping for knative services

* Hint in err msg to use 'ksvc' if used prefixes 'svc' or 'service'

* Update CHANGELOG

* Update source list e2e tests to refer ksvc prefix

* Update sink flag description
2020-07-14 00:46:18 -07:00
.github correct typo in pull request template (#826) 2020-05-05 09:11:44 -07:00
cmd/kn Add grouping for help message + streamlined help messages (#887) 2020-06-18 00:06:25 -07:00
config Use ko's strict mode for better errors messages (#706) 2020-03-07 12:11:27 -08:00
conventions Revisit sink prefixes: Support only 'ksvc' prefix and drop 'svc', 'service' support for knative service (#896) 2020-07-14 00:46:18 -07:00
docs Revisit sink prefixes: Support only 'ksvc' prefix and drop 'svc', 'service' support for knative service (#896) 2020-07-14 00:46:18 -07:00
hack kn v0.16.0 release prep (#922) 2020-07-10 10:41:19 -07:00
lib/test kn v0.16.0 release prep (#922) 2020-07-10 10:41:19 -07:00
pkg Revisit sink prefixes: Support only 'ksvc' prefix and drop 'svc', 'service' support for knative service (#896) 2020-07-14 00:46:18 -07:00
scripts/test-infra chore: Move from Eventing v1alpha1 to v1beta1 (#878) 2020-06-08 05:42:19 -07:00
test Revisit sink prefixes: Support only 'ksvc' prefix and drop 'svc', 'service' support for knative service (#896) 2020-07-14 00:46:18 -07:00
third_party/VENDOR-LICENSE kn v0.16.0 release prep (#922) 2020-07-10 10:41:19 -07:00
vendor kn v0.16.0 release prep (#922) 2020-07-10 10:41:19 -07:00
.gitignore Explicit name for serving client (#537) 2019-12-08 23:42:44 -08:00
CHANGELOG.adoc Revisit sink prefixes: Support only 'ksvc' prefix and drop 'svc', 'service' support for knative service (#896) 2020-07-14 00:46:18 -07:00
LICENSE Initial commit 2018-12-12 16:45:51 -08:00
OWNERS Adds Navid (@navidshaikh) to approvers list (#321) 2019-07-31 13:59:43 -07:00
README.md Add badges in README (#780) 2020-04-07 16:26:00 -07:00
go.mod kn v0.16.0 release prep (#922) 2020-07-10 10:41:19 -07:00
go.sum kn v0.16.0 release prep (#922) 2020-07-10 10:41:19 -07:00

README.md

Kn

go.dev reference Go Report Card Releases LICENSE Slack Status

The Knative client kn is your door to the Knative world. It allows you to create Knative resources interactively from the command line or from within Shell scripts.

kn offers you:

  • Full support for managing all features of Knative Serving (services, revisions, traffic splits)
  • Growing support Knative eventing, closely following its development (managing of sources & triggers)
  • A plugin architecture similar to that of kubectl plugins
  • A thin client-specific API in golang which helps in tasks like synchronously waiting on Knative service write operations.
  • An easy integration of Knative into Tekton Pipelines by using kn in a Tekton Task.

This client uses the Knative Serving and Knative Eventing API exclusively so that it will work with any Knative installation, even those that are not Kubernetes based. It does not help in installing Knative itself though. Please refer to the various Knative installation options for how to install Knative with its prerequisites.

Documentation

Start with the user's guide to learn more. You can read about common use cases, get detailed documentation on each command, and learn how to extend the kn CLI. For more information, have a look at:

  • User guide
    • Installation - How to install kn and run on your machine
    • Examples - Use case based examples
    • FAQ (to come.)
  • Reference Manual - all possible commands and options with usage examples

Developers

We love contributions! Please refer to CONTRIBUTING for more information on how to best contributed to contribute to Knative.

For code contributions it as easy as picking an issue (look out for "kind/good-first-issue"), briefly comment that you would like to work on it, code, test, code and finally submit a PR which will trigger the review process.

More details on how to build and test can be found in the Developer guide.