diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index a17efde1b..000000000 --- a/docs/README.md +++ /dev/null @@ -1,43 +0,0 @@ - -Knative extends Kubernetes to provide developers with a set of tools that simplify the process of deploying and managing event-driven applications that can run anywhere. - -Developers using Knative can use familiar languages and frameworks to solve common use cases, such as: - -- [Deploying a container](./serving/getting-started-knative-app.md) -- [Routing and managing traffic with blue/green deployment](./serving/samples/blue-green-deployment.md) -- [Scaling automatically and sizing workloads based on demand](./serving/autoscaling) -- [Binding running services to eventing ecosystems](./eventing/getting-started.md) - -## How it works - -Knative consists of the [Knative Serving](./serving) and [Knative Eventing](./eventing) components. - -These components are delivered as Kubernetes custom resource definitions (CRDs), which can be configured by a cluster administrator to provide default settings for developer-created applications and event workflow components. - -Follow the links below to learn more about Knative. - -### Getting started - -- [Installing Knative](./install/README.md) -- [Getting started with app deployment](./serving/getting-started-knative-app.md) -- [Getting started with serving](./serving) -- [Getting started with eventing](./eventing) - -### Configuration and networking - -- [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-a-tls-cert.md) -- [Configuring high availability](./serving/config-ha.md) - -### Samples and demos - -- [Autoscaling](./serving/autoscaling/autoscale-go/) -- [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source/) -- [REST API sample](./serving/samples/rest-api-go/README.md) -- [All samples for serving](./serving/samples/) -- [All samples for eventing](./eventing/samples/) - -### Debugging - -- [Debugging application issues](./serving/debugging-application-issues.md) diff --git a/docs/_index.md b/docs/_index.md index 953e8a18e..9b87bcbb7 100755 --- a/docs/_index.md +++ b/docs/_index.md @@ -3,6 +3,54 @@ title: "Welcome to Knative" linkTitle: "Documentation" weight: 10 type: "docs" +aliases: + - /docs/concepts/overview.md --- -{{% readfile file="README.md" %}} +The Knative project provides a set of [Kubernetes controllers](https://kubernetes.io/docs/concepts/architecture/controller/) that help to simplify developer and administrator experiences on [Kubernetes](https://kubernetes.io) clusters, by introducing an event-driven, serverless architecture. + +There are two core Knative components, that can be installed and used together or independently to provide different functions: + +* [Knative Serving](https://knative.dev/docs/serving/): Run stateless services more easily on Kubernetes, + by making autoscaling, networking and rollouts easier. + +* [Knative Eventing](https://knative.dev/docs/eventing/): Create subscriptions to event sources declaratively, + and route events to Kubernetes endpoints. + +These components are delivered as Kubernetes custom resource definitions (CRDs), which can be configured by a cluster administrator to provide default settings for developer-created applications and event workflow components. + +**Note**: Earlier versions of Knative included a Build component. That component has been broken out into its own +project, [Tekton Pipelines](https://tekton.dev/). + +Knative registers its own API types to the Kubernetes API, enabling developers and cluster administrators to use familiar languages and frameworks to solve common use cases, such as: + +- [Deploying a container](./serving/getting-started-knative-app.md) +- [Routing and managing traffic with blue/green deployment](./serving/samples/blue-green-deployment.md) +- [Scaling automatically and sizing workloads based on demand](./serving/autoscaling) +- [Binding running services to eventing ecosystems](./eventing/getting-started.md) + +### Getting started + +- [Installing Knative](./install/README.md) +- [Getting started with app deployment](./serving/getting-started-knative-app.md) +- [Getting started with serving](./serving) +- [Getting started with eventing](./eventing) + +### Configuration and networking + +- [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-a-tls-cert.md) +- [Configuring high availability](./serving/config-ha.md) + +### Samples and demos + +- [Autoscaling](./serving/autoscaling/autoscale-go/) +- [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source/) +- [REST API sample](./serving/samples/rest-api-go/README.md) +- [All samples for serving](./serving/samples/) +- [All samples for eventing](./eventing/samples/) + +### Debugging + +- [Debugging application issues](./serving/debugging-application-issues.md) diff --git a/docs/concepts/_index.md b/docs/concepts/_index.md deleted file mode 100755 index 0d74ab1c9..000000000 --- a/docs/concepts/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Knative Concepts" -linkTitle: "Concepts" -weight: 90 -type: "docs" ---- - -Learn about Knative. diff --git a/docs/concepts/overview.md b/docs/concepts/overview.md deleted file mode 100644 index 10d597778..000000000 --- a/docs/concepts/overview.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Overview" -weight: 5 -type: "docs" ---- - -This document contains a quick overview of Knative. - -Knative (pronounced kay-native) is a set of open source components for [Kubernetes](https://kubernetes.io) that implements -functionality to: - -* run stateless workloads, such as microservices -* support event subscription, delivery, and handling - -on Kubernetes clusters. - -Knative is implemented as a set of [controllers](https://kubernetes.io/docs/concepts/architecture/controller/) you install -on your Kubernetes cluster. Knative registers its own API types to the Kubernetes API, so working with it is not -too different from working with Kubernetes itself. - -Knative consists of two independent components that have their own GitHub projects: - -* [Knative Serving](https://knative.dev/docs/serving/): Run stateless services more easily on Kubernetes, - by making autoscaling, networking and rollouts easier. - -* [Knative Eventing](https://knative.dev/docs/eventing/): Create subscriptions to event sources declaratively, - and route events to Kubernetes endpoints. - -You can use either one or both components in your cluster. - -**Note**: Earlier versions of Knative included a Build component. That component has been broken out into its own -project, [Tekton Pipelines](https://tekton.dev/).