mirror of https://github.com/knative/docs.git
Copied the README into _index.md instead of referencing README from (#3382)
* Copied the README into _index.md instead of referencing README from index so that the website will build properly. Did not delete README so that github renders as well. * Removed README.md
This commit is contained in:
parent
113941af51
commit
e204743905
|
@ -1,76 +0,0 @@
|
|||
Knative Serving builds on Kubernetes and Istio to support deploying and serving
|
||||
of serverless applications and functions. Serving is easy to get started with
|
||||
and scales to support advanced scenarios.
|
||||
|
||||
The Knative Serving project provides middleware primitives that enable:
|
||||
|
||||
- Rapid deployment of serverless containers
|
||||
- [Automatic scaling up and down to zero](./autoscaling/README.md)
|
||||
- Routing and network programming for Istio components
|
||||
- Point-in-time snapshots of deployed code and configurations
|
||||
|
||||
## Serving resources
|
||||
|
||||
Knative Serving defines a set of objects as Kubernetes Custom Resource
|
||||
Definitions (CRDs). These objects are used to define and control how your
|
||||
serverless workload behaves on the cluster:
|
||||
|
||||
- [Service](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#service):
|
||||
The `service.serving.knative.dev` resource automatically manages the whole
|
||||
lifecycle of your workload. It controls the creation of other objects to
|
||||
ensure that your app has a route, a configuration, and a new revision for each
|
||||
update of the service. Service can be defined to always route traffic to the
|
||||
latest revision or to a pinned revision.
|
||||
- [Route](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#route):
|
||||
The `route.serving.knative.dev` resource maps a network endpoint to one or
|
||||
more revisions. You can manage the traffic in several ways, including
|
||||
fractional traffic and named routes.
|
||||
- [Configuration](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#configuration):
|
||||
The `configuration.serving.knative.dev` resource maintains the desired state
|
||||
for your deployment. It provides a clean separation between code and
|
||||
configuration and follows the Twelve-Factor App methodology. Modifying a
|
||||
configuration creates a new revision.
|
||||
- [Revision](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#revision):
|
||||
The `revision.serving.knative.dev` resource is a point-in-time snapshot of the
|
||||
code and configuration for each modification made to the workload. Revisions
|
||||
are immutable objects and can be retained for as long as useful. Knative
|
||||
Serving Revisions can be automatically scaled up and down according to
|
||||
incoming traffic. See
|
||||
[Configuring the Autoscaler](./autoscaling) for more
|
||||
information.
|
||||
|
||||

|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with Serving, check out one of the [hello world](./samples/)
|
||||
sample projects. These projects use the `Service` resource, which manages all of
|
||||
the details for you.
|
||||
|
||||
With the `Service` resource, a deployed service will automatically have a
|
||||
matching route and configuration created. Each time the `Service` is updated, a
|
||||
new revision is created.
|
||||
|
||||
For more information on the resources and their interactions, see the
|
||||
[Resource Types Overview](https://github.com/knative/serving/blob/main/docs/spec/overview.md)
|
||||
in the Knative Serving repository.
|
||||
|
||||
## More samples and demos
|
||||
|
||||
- [Knative Serving code samples](./samples/README.md)
|
||||
|
||||
## Debugging Knative Serving issues
|
||||
|
||||
- [Debugging Application Issues](./debugging-application-issues.md)
|
||||
|
||||
## Configuration and Networking
|
||||
|
||||
- [Configuring cluster local routes](./cluster-local-route.md)
|
||||
- [Using a custom domain](./using-a-custom-domain.md)
|
||||
- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address.md)
|
||||
- [Using subroutes](./using-subroutes.md)
|
||||
|
||||
## Known Issues
|
||||
|
||||
See the [Knative Serving Issues](https://github.com/knative/serving/issues) page
|
||||
for a full list of known issues.
|
|
@ -5,4 +5,79 @@ weight: 20
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" %}}
|
||||
Knative Serving builds on Kubernetes and Istio to support deploying and serving
|
||||
of serverless applications and functions. Serving is easy to get started with
|
||||
and scales to support advanced scenarios.
|
||||
|
||||
The Knative Serving project provides middleware primitives that enable:
|
||||
|
||||
- Rapid deployment of serverless containers
|
||||
- [Automatic scaling up and down to zero](./autoscaling/README.md)
|
||||
- Routing and network programming for Istio components
|
||||
- Point-in-time snapshots of deployed code and configurations
|
||||
|
||||
## Serving resources
|
||||
|
||||
Knative Serving defines a set of objects as Kubernetes Custom Resource
|
||||
Definitions (CRDs). These objects are used to define and control how your
|
||||
serverless workload behaves on the cluster:
|
||||
|
||||
- [Service](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#service):
|
||||
The `service.serving.knative.dev` resource automatically manages the whole
|
||||
lifecycle of your workload. It controls the creation of other objects to
|
||||
ensure that your app has a route, a configuration, and a new revision for each
|
||||
update of the service. Service can be defined to always route traffic to the
|
||||
latest revision or to a pinned revision.
|
||||
- [Route](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#route):
|
||||
The `route.serving.knative.dev` resource maps a network endpoint to one or
|
||||
more revisions. You can manage the traffic in several ways, including
|
||||
fractional traffic and named routes.
|
||||
- [Configuration](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#configuration):
|
||||
The `configuration.serving.knative.dev` resource maintains the desired state
|
||||
for your deployment. It provides a clean separation between code and
|
||||
configuration and follows the Twelve-Factor App methodology. Modifying a
|
||||
configuration creates a new revision.
|
||||
- [Revision](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#revision):
|
||||
The `revision.serving.knative.dev` resource is a point-in-time snapshot of the
|
||||
code and configuration for each modification made to the workload. Revisions
|
||||
are immutable objects and can be retained for as long as useful. Knative
|
||||
Serving Revisions can be automatically scaled up and down according to
|
||||
incoming traffic. See
|
||||
[Configuring the Autoscaler](./autoscaling) for more
|
||||
information.
|
||||
|
||||

|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with Serving, check out one of the [hello world](./samples/)
|
||||
sample projects. These projects use the `Service` resource, which manages all of
|
||||
the details for you.
|
||||
|
||||
With the `Service` resource, a deployed service will automatically have a
|
||||
matching route and configuration created. Each time the `Service` is updated, a
|
||||
new revision is created.
|
||||
|
||||
For more information on the resources and their interactions, see the
|
||||
[Resource Types Overview](https://github.com/knative/serving/blob/main/docs/spec/overview.md)
|
||||
in the Knative Serving repository.
|
||||
|
||||
## More samples and demos
|
||||
|
||||
- [Knative Serving code samples](./samples/README.md)
|
||||
|
||||
## Debugging Knative Serving issues
|
||||
|
||||
- [Debugging Application Issues](./debugging-application-issues.md)
|
||||
|
||||
## Configuration and Networking
|
||||
|
||||
- [Configuring cluster local routes](./cluster-local-route.md)
|
||||
- [Using a custom domain](./using-a-custom-domain.md)
|
||||
- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address.md)
|
||||
- [Using subroutes](./using-subroutes.md)
|
||||
|
||||
## Known Issues
|
||||
|
||||
See the [Knative Serving Issues](https://github.com/knative/serving/issues) page
|
||||
for a full list of known issues.
|
||||
|
|
Loading…
Reference in New Issue