forked from knative/docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move resources and readme (knative#843)
- Loading branch information
1 parent
dd5603d
commit 899350d
Showing
8 changed files
with
277 additions
and
118 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,119 +1,5 @@ | ||
| # Welcome to Knative | ||
| Welcome to the Knative docs source file repository. | ||
|
|
||
| Knative (pronounced kay-nay-tiv) extends Kubernetes to provide a set of | ||
| middleware components that are essential to build modern, source-centric, and | ||
| container-based applications that can run anywhere: on premises, in the cloud, | ||
| or even in a third-party data center. | ||
| If you are a contributor [add link to master content here (when site is published)]. | ||
|
|
||
| Each of the components under the Knative project attempt to identify common | ||
| patterns and codify the best practices that are shared by successful, | ||
| real-world, Kubernetes-based frameworks and applications. Knative components | ||
| focus on solving mundane but difficult tasks such as: | ||
|
|
||
| - [Deploying a container](./install/getting-started-knative-app.md) | ||
| - [Orchestrating source-to-URL workflows on Kubernetes](./serving/samples/source-to-url-go/) | ||
| - [Routing and managing traffic with blue/green deployment](./serving/samples/blue-green-deployment.md) | ||
| - [Scaling automatically and sizing workloads based on demand](./serving/samples/autoscale-go) | ||
| - [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source) | ||
|
|
||
| Developers on Knative can use familiar idioms, languages, and frameworks to | ||
| deploy functions, applications, or containers workloads. | ||
|
|
||
| ## Components | ||
|
|
||
| The following Knative components are available: | ||
|
|
||
| - [Build](https://github.com/knative/build) - Source-to-container build | ||
| orchestration | ||
| - [Eventing](https://github.com/knative/eventing) - Management and delivery of | ||
| events | ||
| - [Serving](https://github.com/knative/serving) - Request-driven compute that | ||
| can scale to zero | ||
|
|
||
| ## Audience | ||
|
|
||
| Knative is designed for different personas: | ||
|
|
||
|  | ||
|
|
||
| ### Developers | ||
|
|
||
| Knative components offer developers Kubernetes-native APIs for deploying | ||
| serverless-style functions, applications, and containers to an auto-scaling | ||
| runtime. | ||
|
|
||
| To join the conversation, head over to the | ||
| [Knative users](https://groups.google.com/d/forum/knative-users) Google group. | ||
|
|
||
| ### Operators | ||
|
|
||
| Knative components are intended to be integrated into more polished products | ||
| that cloud service providers or in-house teams in large enterprises can then | ||
| operate. | ||
|
|
||
| Any enterprise or cloud provider can adopt Knative components into their own | ||
| systems and pass the benefits along to their customers. | ||
|
|
||
| ### Contributors | ||
|
|
||
| With a clear project scope, lightweight governance model, and clean lines of | ||
| separation between pluggable components, the Knative project establishes an | ||
| efficient contributor workflow. | ||
|
|
||
| Knative is a diverse, open, and inclusive community. To get involved, see | ||
| [CONTRIBUTING.md](./community/CONTRIBUTING.md) and join the | ||
| [Knative community](./community/README.md). | ||
|
|
||
| Your own path to becoming a Knative contributor can | ||
| [begin anywhere](https://github.com/knative/serving/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fgood-first-issue). | ||
| [Bug reports](https://github.com/knative/serving/issues/new) and friction logs | ||
| from new developers are especially welcome. | ||
|
|
||
| ## Documentation | ||
|
|
||
| Follow the links below to learn more about Knative. | ||
|
|
||
| ### Getting started | ||
|
|
||
| - [Installing Knative](./install/README.md) | ||
| - [Getting started with app deployment](./install/getting-started-knative-app.md) | ||
| - [Getting started with serving](./serving) | ||
| - [Getting started with builds](./build) | ||
| - [Getting started with eventing](./eventing) | ||
|
|
||
| ### Configuration and networking | ||
|
|
||
| - [Configuring outbound network access](./serving/outbound-network-access.md) | ||
| - [Using a custom domain](./serving/using-a-custom-domain.md) | ||
| - [Assigning a static IP address for Knative on Google Kubernetes Engine](./serving/gke-assigning-static-ip-address.md) | ||
| - [Configuring HTTPS with a custom certificate](./serving/using-an-ssl-cert.md) | ||
|
|
||
| ### Samples and demos | ||
|
|
||
| - [Autoscaling](./serving/samples/autoscale-go/README.md) | ||
| - [Source-to-URL deployment](./serving/samples/source-to-url-go/README.md) | ||
| - [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source) | ||
| - [Telemetry](./serving/samples/telemetry-go/README.md) | ||
| - [REST API sample](./serving/samples/rest-api-go/README.md) | ||
| - [All samples for serving](./serving/samples/) | ||
| - [All samples for eventing](./eventing/samples/) | ||
|
|
||
| ### Logging and metrics | ||
|
|
||
| - [Installing logging, metrics and traces](./serving/installing-logging-metrics-traces.md) | ||
| - [Accessing logs](./serving/accessing-logs.md) | ||
| - [Accessing metrics](./serving/accessing-metrics.md) | ||
| - [Accessing traces](./serving/accessing-traces.md) | ||
| - [Setting up a logging plugin](./serving/setting-up-a-logging-plugin.md) | ||
|
|
||
| ### Debugging | ||
|
|
||
| - [Debugging application issues](./serving/debugging-application-issues.md) | ||
| - [Debugging performance issues](./serving/debugging-performance-issues.md) | ||
|
|
||
| --- | ||
|
|
||
| Except as otherwise noted, the content of this page is licensed under the | ||
| [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/), | ||
| and code samples are licensed under the | ||
| [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). | ||
| To read the docs, see our [Documentation Website](http://knative.dev/docs). |
This file contains 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,129 @@ | ||
| +++ | ||
| title = "Knative" | ||
|
|
||
| +++ | ||
|
|
||
| {{< blocks/cover title="Welcome to the Knative Project!" image_anchor="top" height="max" color="dark" >}} | ||
| <div class="mx-auto"> | ||
| <a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}"> | ||
| Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i> | ||
| </a> | ||
| <a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/knative"> | ||
| View Repository <i class="fab fa-github ml-2 "></i> | ||
| </a> | ||
| <p class="lead mt-5"><h2>Kubernetes-based platform to build, deploy, and manage modern serverless workloads.</h2></p> | ||
| <div class="mx-auto mt-5"> | ||
| {{< blocks/link-down color="info" >}} | ||
| </div> | ||
| </div> | ||
| {{< /blocks/cover >}} | ||
|
|
||
|
|
||
| {{% blocks/lead color="primary" %}} | ||
| Knative provides a set of middleware components that are essential to build modern, source-centric, and container-based applications that can run anywhere: on premises, in the cloud, or even in a third-party data center. | ||
|
|
||
| {{% /blocks/lead %}} | ||
|
|
||
|
|
||
| {{% blocks/section %}} | ||
| <div class="col-12"> | ||
| <h1 class="text-center">Essential base primitives for all</h1> | ||
| Knative components are built on Kubernetes and codify the best practices shared by successful real-world Kubernetes-based frameworks. It enables developers to focus just on writing interesting code, without worrying about the “boring but difficult” parts of building, deploying, and managing an application. | ||
| </div> | ||
| {{% /blocks/section %}} | ||
|
|
||
| {{% blocks/section %}} | ||
| <div class="col-12"> | ||
| <h1 class="text-center"> | ||
| Developer-friendly software</h1> | ||
| Knative offers a set of reusable components that focuses on solving many mundane but difficult tasks such as orchestrating source-to-container workflows, routing and managing traffic during deployment, auto-scaling your workloads, or binding running services to eventing ecosystems. Developers can even use familiar idioms, languages, and frameworks to deploy any workload: functions, applications, or containers. | ||
| </div> | ||
| {{% /blocks/section %}} | ||
|
|
||
| {{% blocks/section %}} | ||
| <div class="col-12"> | ||
| <h1 class="text-center">Supports popular development patterns</h1> | ||
| Knative focuses on an idiomatic developer experience. It supports common development patterns such as GitOps, DockerOps, ManualOps, as well as tools and frameworks such as Django, Ruby on Rails, Spring, and many more. | ||
| </div> | ||
| {{% /blocks/section %}} | ||
|
|
||
| {{% blocks/section %}} | ||
| <div class="col-12"> | ||
| <h1 class="text-center">Best of both worlds: Flexibility and control</h1> | ||
| Knative is designed to plug easily into existing build and CI/CD toolchains. By focusing on open-source-first technologies that run anywhere, on any cloud, on any infrastructure supported by Kubernetes, enterprises are free to move their workloads wherever they run best. This offers the flexibility and control customers need to adapt the system to their own unique requirements. | ||
| </div> | ||
| {{% /blocks/section %}} | ||
|
|
||
| {{% blocks/section %}} | ||
| <div class="col-12"> | ||
| <h1 class="text-center">Operator-friendly</h1> | ||
| Knative is designed to be run as a service by all major cloud providers. Google currently works with industry leaders such as Pivotal, SAP, Red Hat, IBM, and many others to create the building blocks that will best suit the needs of developers. Knative powers real-world workloads and is also compatible with other cutting-edge technologies such as Kubernetes and Istio. | ||
| </div> | ||
| {{% /blocks/section %}} | ||
|
|
||
| <!---------- | ||
| {{% blocks/section %}} | ||
| <div class="col-12"> | ||
| <h1 class="text-center">Run your serverless workloads on Kubernetes Engine</h1> | ||
| You can now run your serverless workloads on Google Kubernetes Engine (GKE) by enabling the serverless add-on. Powered by Knative, the serverless add-on helps developers orchestrate builds, serving, and events with a single click, enabling the benefits of an idiomatic developer experience with the flexibility and control of GKE. | ||
| </div> | ||
| {{% /blocks/section %}} | ||
| ----------> | ||
|
|
||
| {{< blocks/section >}} | ||
|
|
||
| <h1 class="text-center">Knative Features</h1> | ||
| <table align="center"> | ||
| <thead> | ||
| <tr> | ||
| <th width="30%">Feature Name</th> | ||
| <th width="70%">Feature Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>Serving</td> | ||
| <td>Scale to zero, request-driven compute model</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Build</td> | ||
| <td>Cloud-native source to container orchestration</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Eventing</td> | ||
| <td>Universal subscription, delivery, and management of events</td> | ||
| </tr> | ||
| <!---------- | ||
| <tr> | ||
| <td>Add-on for GKE</td> | ||
| <td>GCP managed stack on Kubernetes</td> | ||
| </tr> | ||
| -----> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| {{< /blocks/section >}} | ||
|
|
||
|
|
||
| {{< blocks/section color="light" >}} | ||
|
|
||
| {{% blocks/feature icon="fab fa-slack" title="Talk to us on Slack!" url="https://knative.slack.com/" %}} | ||
| Interested in learning more, speaking to other contributors, or finding answers? | ||
| {{% /blocks/feature %}} | ||
|
|
||
|
|
||
| {{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="./contributing/" %}} | ||
| Want to join the fun? New users are always welcome! | ||
| {{% /blocks/feature %}} | ||
|
|
||
|
|
||
| {{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/KnativeProject" %}} | ||
| For announcement of latest features etc. | ||
| {{% /blocks/feature %}} | ||
|
|
||
|
|
||
| {{< /blocks/section >}} | ||
|
|
||
|
|
||
|
|
||
|
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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,118 @@ | ||
|
|
||
| Knative (pronounced kay-nay-tiv) extends Kubernetes to provide a set of | ||
| middleware components that are essential to build modern, source-centric, and | ||
| container-based applications that can run anywhere: on premises, in the cloud, | ||
| or even in a third-party data center. | ||
|
|
||
| Each of the components under the Knative project attempt to identify common | ||
| patterns and codify the best practices that are shared by successful, | ||
| real-world, Kubernetes-based frameworks and applications. Knative components | ||
| focus on solving mundane but difficult tasks such as: | ||
|
|
||
| - [Deploying a container](./install/getting-started-knative-app.md) | ||
| - [Orchestrating source-to-URL workflows on Kubernetes](./serving/samples/source-to-url-go/) | ||
| - [Routing and managing traffic with blue/green deployment](./serving/samples/blue-green-deployment.md) | ||
| - [Scaling automatically and sizing workloads based on demand](./serving/samples/autoscale-go) | ||
| - [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source) | ||
|
|
||
| Developers on Knative can use familiar idioms, languages, and frameworks to | ||
| deploy functions, applications, or containers workloads. | ||
|
|
||
| ## Components | ||
|
|
||
| The following Knative components are available: | ||
|
|
||
| - [Build](https://github.com/knative/build) - Source-to-container build | ||
| orchestration | ||
| - [Eventing](https://github.com/knative/eventing) - Management and delivery of | ||
| events | ||
| - [Serving](https://github.com/knative/serving) - Request-driven compute that | ||
| can scale to zero | ||
|
|
||
| ## Audience | ||
|
|
||
| Knative is designed for different personas: | ||
|
|
||
|  | ||
|
|
||
| ### Developers | ||
|
|
||
| Knative components offer developers Kubernetes-native APIs for deploying | ||
| serverless-style functions, applications, and containers to an auto-scaling | ||
| runtime. | ||
|
|
||
| To join the conversation, head over to the | ||
| [Knative users](https://groups.google.com/d/forum/knative-users) Google group. | ||
|
|
||
| ### Operators | ||
|
|
||
| Knative components are intended to be integrated into more polished products | ||
| that cloud service providers or in-house teams in large enterprises can then | ||
| operate. | ||
|
|
||
| Any enterprise or cloud provider can adopt Knative components into their own | ||
| systems and pass the benefits along to their customers. | ||
|
|
||
| ### Contributors | ||
|
|
||
| With a clear project scope, lightweight governance model, and clean lines of | ||
| separation between pluggable components, the Knative project establishes an | ||
| efficient contributor workflow. | ||
|
|
||
| Knative is a diverse, open, and inclusive community. To get involved, see | ||
| [CONTRIBUTING.md](./community/CONTRIBUTING.md) and join the | ||
| [Knative community](./community/README.md). | ||
|
|
||
| Your own path to becoming a Knative contributor can | ||
| [begin anywhere](https://github.com/knative/serving/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fgood-first-issue). | ||
| [Bug reports](https://github.com/knative/serving/issues/new) and friction logs | ||
| from new developers are especially welcome. | ||
|
|
||
| ## Documentation | ||
|
|
||
| Follow the links below to learn more about Knative. | ||
|
|
||
| ### Getting started | ||
|
|
||
| - [Installing Knative](./install/README.md) | ||
| - [Getting started with app deployment](./install/getting-started-knative-app.md) | ||
| - [Getting started with serving](./serving) | ||
| - [Getting started with builds](./build) | ||
| - [Getting started with eventing](./eventing) | ||
|
|
||
| ### Configuration and networking | ||
|
|
||
| - [Configuring outbound network access](./serving/outbound-network-access.md) | ||
| - [Using a custom domain](./serving/using-a-custom-domain.md) | ||
| - [Assigning a static IP address for Knative on Google Kubernetes Engine](./serving/gke-assigning-static-ip-address.md) | ||
| - [Configuring HTTPS with a custom certificate](./serving/using-an-ssl-cert.md) | ||
|
|
||
| ### Samples and demos | ||
|
|
||
| - [Autoscaling](./serving/samples/autoscale-go/README.md) | ||
| - [Source-to-URL deployment](./serving/samples/source-to-url-go/README.md) | ||
| - [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source) | ||
| - [Telemetry](./serving/samples/telemetry-go/README.md) | ||
| - [REST API sample](./serving/samples/rest-api-go/README.md) | ||
| - [All samples for serving](./serving/samples/) | ||
| - [All samples for eventing](./eventing/samples/) | ||
|
|
||
| ### Logging and metrics | ||
|
|
||
| - [Installing logging, metrics and traces](./serving/installing-logging-metrics-traces.md) | ||
| - [Accessing logs](./serving/accessing-logs.md) | ||
| - [Accessing metrics](./serving/accessing-metrics.md) | ||
| - [Accessing traces](./serving/accessing-traces.md) | ||
| - [Setting up a logging plugin](./serving/setting-up-a-logging-plugin.md) | ||
|
|
||
| ### Debugging | ||
|
|
||
| - [Debugging application issues](./serving/debugging-application-issues.md) | ||
| - [Debugging performance issues](./serving/debugging-performance-issues.md) | ||
|
|
||
| --- | ||
|
|
||
| Except as otherwise noted, the content of this page is licensed under the | ||
| [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/), | ||
| and code samples are licensed under the | ||
| [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). |
This file contains 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,10 @@ | ||
| --- | ||
| title: "Welcome to Knative" | ||
| linkTitle: "Documentation" | ||
| weight: 10 | ||
| menu: | ||
| main: | ||
| weight: 20 | ||
| --- | ||
|
|
||
| {{% readfile file="docs/README.md" markdown="true" %}} |
This file contains 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,7 @@ | ||
| --- | ||
| title: "Knative Concepts" | ||
| linkTitle: "Concepts" | ||
| weight: 89 | ||
| --- | ||
|
|
||
| Learn about Knative. |
This file contains 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.