Include a page that gives an overview of the user facing projects of Knative #1703
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Knative Project Overview | ||
|
|
||
| ## Functions | ||
|
|
||
| [func](https://github.com/knative/func) provides a simple programming model for using functions on Knative, without requiring in-depth knowledge of Knative, Kubernetes, containers, or dockerfiles. | ||
|
|
||
| ## Serving | ||
|
|
||
| [Serving](https://github.com/knative/serving) defines a set of resources to manage how your serverless workload behaves on the Kubernetes cluster. | ||
|
|
||
| ### Related Sub-projects | ||
|
|
||
| #### Networking Plugins | ||
|
|
||
| [Networking plugins](https://github.com/knative-extensions?q=net-&type=public) provide a shim to converts generic Serving resources to networking specific ones. Example integrations are Istio, Contour, Gateway API and Kourier. | ||
|
|
||
| #### Client | ||
|
|
||
| The [`kn` cli](https://github.com/knative/client) provides a quick and easy interface for creating Knative resources such as services and event sources, without the need to create or modify YAML files directly. kn also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting. | ||
|
|
||
| #### Operator | ||
|
There was a problem hiding this comment. Should we have a section for general supporting projects, including the infra and ux WGs? There was a problem hiding this comment. Take a look - let me know if you want me to add anything else |
||
|
|
||
| The [Operator](https://github.com/knative/operator) helps install, manage and upgrade Knative Serving installations on Kubernetes Clusters. | ||
|
|
||
| ## Eventing | ||
|
|
||
| [Eventing](https://github.com/knative/eventing) is a collection of APIs that enable you to use an event-driven architecture with your applications. You can use these APIs to create components that route events from event producers (known as sources) to event consumers (known as sinks) that receive events. | ||
|
|
||
| ### Related Sub-projects | ||
|
|
||
| #### Eventing Plugins | ||
|
|
||
| [Eventing plugins](https://github.com/knative-extensions?q=eventing-&type=public&language=&sort=) allow end-users to integrate Knative with various different eventing buses/queues such as Kafka, Redis, NATS, Rabbit-MQ. | ||
|
|
||
| #### Client | ||
|
|
||
| The [`kn` cli](https://github.com/knative/client) provides a quick and easy interface for creating Knative resources such as services and event sources, without the need to create or modify YAML files directly. kn also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting. | ||
|
|
||
| #### Operator | ||
|
|
||
| The [Operator](https://github.com/knative/operator) helps install, manage and upgrade Knative Eventing installations on Kubernetes Clusters. | ||
|
|
||
| ## Other Supporting Subprojects | ||
|
|
||
| ### Knative Website | ||
|
|
||
| The [`knative.dev`] website is where users learn about using and operating different components of Knative. | ||
|
|
||
| ### Knative Infrastructure | ||
|
|
||
| The test infrastructure hosts our CI and other various tooling to support development of Knative Kubernetes components. [`knative/infra`](https://github.com/knative/infra) contains documentation on how to get involved. | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| Knative projects are maintained by organized [working groups](./working-groups/WORKING-GROUPS.md). | ||
|
|
||
| Additionally, see the [Knative website](https://knative.dev) for in-depth information. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think client is pretty of functions at this point, not just serving functionality
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(or at least include client under functions)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have this repeated under eventing as well - the idea is that you can do 'eventing' things with the
knclient. Given that do you think it makes sense to include the same blurb underfunc?