knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

convert to Hugo rel link

This commit is contained in:
Richie Escarez 2019-02-01 20:20:08 -08:00
parent febbc01725
commit f1bbc8ebbc
44 changed files with 123 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
community/samples/README.md
View File

@ -2,4 +2,4 @@
| Sample Name | Knative Component | Description | Language(s) | | Sample Name | Knative Component | Description | Language(s) |
| --------------| ----------------- | -------------------------- | ----------------- | | --------------| ----------------- | -------------------------- | ----------------- |
| Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Rust](./serving/helloworld-rust/README.md), [Shell](./serving/helloworld-shell/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) | | Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](serving/helloworld-clojure/), [Dart](serving/helloworld-dart/), [Elixir](serving/helloworld-elixir/), [Haskell](serving/helloworld-haskell/), [Rust](serving/helloworld-rust/), [Shell](serving/helloworld-shell/), [Swift](serving/helloworld-swift/), [Vertx](serving/helloworld-vertx/) |

2
contributing/CONTRIBUTING.md
View File

@ -172,7 +172,7 @@ reviewers to the PR, set labels, run tests automatically, and so forth.
See [Reviewing and Merging Pull Requests](REVIEWING/) for the PR review and See [Reviewing and Merging Pull Requests](REVIEWING/) for the PR review and
merge process used for Knative and for more information about merge process used for Knative and for more information about
[Prow](./REVIEWING/#prow). [Prow](../REVIEWING/#prow).
## Issues ## Issues

10
contributing/DOCS-CONTRIBUTING.md
View File

@ -15,7 +15,7 @@ propose changes to this document in a pull request.
### Code of conduct ### Code of conduct
Knative follows the [Knative Code of Conduct](./CODE-OF-CONDUCT/). By Knative follows the [Knative Code of Conduct](../CODE-OF-CONDUCT/). By
participating, you are expected to uphold this code. Please report unacceptable participating, you are expected to uphold this code. Please report unacceptable
behavior to knative-code-of-conduct@googlegroups.com. behavior to knative-code-of-conduct@googlegroups.com.
@ -39,7 +39,7 @@ see a problem with the documentation, submit an issue using the following steps:
When you create a bug report, include as many details as possible and When you create a bug report, include as many details as possible and
include suggested fixes to the issue. If you know which Knative component include suggested fixes to the issue. If you know which Knative component
your bug is related to, you can assign the appropriate your bug is related to, you can assign the appropriate
[Working Group Lead](./WORKING-GROUPS/). [Working Group Lead](../WORKING-GROUPS/).
- **Feature request**: For upcoming changes to the documentation or requests - **Feature request**: For upcoming changes to the documentation or requests
for more information on a particular subject. for more information on a particular subject.
@ -51,7 +51,7 @@ documentation issues should go in the `docs` repository.
### Working group ### Working group
The [Knative Documentation Working Group](./WORKING-GROUPS/#documentation) The [Knative Documentation Working Group](../WORKING-GROUPS/#documentation)
meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to
accommodate contributors in both the EMEA and APAC timezones. accommodate contributors in both the EMEA and APAC timezones.
[Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com) [Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com)
@ -66,9 +66,9 @@ There are a couple different ways to jump in to the Knative doc set:
- Look at issues in the Docs repo labled - Look at issues in the Docs repo labled
[Good First Issue](https://github.com/knative/docs/labels/kind%2Fgood-first-issue). [Good First Issue](https://github.com/knative/docs/labels/kind%2Fgood-first-issue).
- Run through the [install guide](../install/README.md) for the platform of your - Run through the [install guide](../../install/docs/README.md) for the platform of your
choice, as well as the choice, as well as the
[Getting Started with Knative App Deployment](../install/getting-started-knative-app/) [Getting Started with Knative App Deployment](../../install/docs/getting-started-knative-app/)
guide, and keep a guide, and keep a
[friction log](https://devrel.net/developer-experience/an-introduction-to-friction-logging) [friction log](https://devrel.net/developer-experience/an-introduction-to-friction-logging)
of the experience. What was hard for you? Then open a PR with a few of the experience. What was hard for you? Then open a PR with a few

2
contributing/README.md
View File

@ -56,7 +56,7 @@ tools, platforms, languages, and products. By submitting a tutorial you can
share your experience and help others who are solving similar problems. share your experience and help others who are solving similar problems.
Community tutorials are stored in Markdown files on Community tutorials are stored in Markdown files on
[GitHub](../community/samples/) where they can be reviewed and edited by the [GitHub](../../community/samples/) where they can be reviewed and edited by the
community. community.
Please submit a Pull Request to the community sample directory under the Knative Please submit a Pull Request to the community sample directory under the Knative

4
contributing/SLACK-GUIDELINES.md
View File

@ -22,7 +22,7 @@ https://slack.knative.dev.
## Code of Conduct ## Code of Conduct
The Knative [Code of Conduct](./CODE-OF-CONDUCT/) applies throughout the The Knative [Code of Conduct](../CODE-OF-CONDUCT/) applies throughout the
project, and includes all communication mediums. project, and includes all communication mediums.
## Admins ## Admins
@ -56,7 +56,7 @@ privately.
Please reach out to the #slack-admins group with your request to create a new Please reach out to the #slack-admins group with your request to create a new
channel. channel.
Channels are dedicated to [Working Groups](./WORKING-GROUPS/), sub-projects, Channels are dedicated to [Working Groups](../WORKING-GROUPS/), sub-projects,
community topics, and related programs/projects. community topics, and related programs/projects.
Channels are not: Channels are not:

62
docs/README.md
View File

@ -9,11 +9,11 @@ patterns and codify the best practices that are shared by successful,
real-world, Kubernetes-based frameworks and applications. Knative components real-world, Kubernetes-based frameworks and applications. Knative components
focus on solving mundane but difficult tasks such as: focus on solving mundane but difficult tasks such as:
- [Deploying a container](./install/getting-started-knative-app) - [Deploying a container](install/getting-started-knative-app)
- [Orchestrating source-to-URL workflows on Kubernetes](./serving/samples/source-to-url-go/) - [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) - [Routing and managing traffic with blue/green deployment](serving/samples/blue-green-deployment)
- [Scaling automatically and sizing workloads based on demand](./serving/samples/autoscale-go) - [Scaling automatically and sizing workloads based on demand](serving/samples/autoscale-go)
- [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source) - [Binding running services to eventing ecosystems](eventing/samples/kubernetes-event-source)
Developers on Knative can use familiar idioms, languages, and frameworks to Developers on Knative can use familiar idioms, languages, and frameworks to
deploy functions, applications, or containers workloads. deploy functions, applications, or containers workloads.
@ -33,7 +33,7 @@ The following Knative components are available:
Knative is designed for different personas: Knative is designed for different personas:
![Diagram that displays different Audiences for Knative](./images/knative-audience.svg) ![Diagram that displays different Audiences for Knative](images/knative-audience.svg)
### Developers ### Developers
@ -60,8 +60,8 @@ separation between pluggable components, the Knative project establishes an
efficient contributor workflow. efficient contributor workflow.
Knative is a diverse, open, and inclusive community. To get involved, see Knative is a diverse, open, and inclusive community. To get involved, see
[CONTRIBUTING.md](./contributing/CONTRIBUTING) and join the [CONTRIBUTING.md](../../contributing/CONTRIBUTING/) and join the
[Knative community](./community/). [Knative community](../../community/).
Your own path to becoming a Knative contributor can 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). [begin anywhere](https://github.com/knative/serving/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fgood-first-issue).
@ -74,41 +74,41 @@ Follow the links below to learn more about Knative.
### Getting started ### Getting started
- [Installing Knative](./install/) - [Installing Knative](install/)
- [Getting started with app deployment](./install/getting-started-knative-app) - [Getting started with app deployment](install/getting-started-knative-app)
- [Getting started with serving](./serving) - [Getting started with serving](serving)
- [Getting started with builds](./build) - [Getting started with builds](build)
- [Getting started with eventing](./eventing) - [Getting started with eventing](eventing)
### Configuration and networking ### Configuration and networking
- [Configuring outbound network access](./serving/outbound-network-access) - [Configuring outbound network access](serving/outbound-network-access)
- [Using a custom domain](./serving/using-a-custom-domain) - [Using a custom domain](serving/using-a-custom-domain)
- [Assigning a static IP address for Knative on Google Kubernetes Engine](./serving/gke-assigning-static-ip-address) - [Assigning a static IP address for Knative on Google Kubernetes Engine](serving/gke-assigning-static-ip-address)
- [Configuring HTTPS with a custom certificate](./serving/using-an-ssl-cert) - [Configuring HTTPS with a custom certificate](serving/using-an-ssl-cert)
### Samples and demos ### Samples and demos
- [Autoscaling](./serving/samples/autoscale-go/) - [Autoscaling](serving/samples/autoscale-go/)
- [Source-to-URL deployment](./serving/samples/source-to-url-go/) - [Source-to-URL deployment](serving/samples/source-to-url-go/)
- [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source) - [Binding running services to eventing ecosystems](eventing/samples/kubernetes-event-source)
- [Telemetry](./serving/samples/telemetry-go/) - [Telemetry](serving/samples/telemetry-go/)
- [REST API sample](./serving/samples/rest-api-go/) - [REST API sample](serving/samples/rest-api-go/)
- [All samples for serving](./serving/samples/) - [All samples for serving](serving/samples/)
- [All samples for eventing](./eventing/samples/) - [All samples for eventing](eventing/samples/)
### Logging and metrics ### Logging and metrics
- [Installing logging, metrics and traces](./serving/installing-logging-metrics-traces) - [Installing logging, metrics and traces](serving/installing-logging-metrics-traces)
- [Accessing logs](./serving/accessing-logs) - [Accessing logs](serving/accessing-logs)
- [Accessing metrics](./serving/accessing-metrics) - [Accessing metrics](serving/accessing-metrics)
- [Accessing traces](./serving/accessing-traces) - [Accessing traces](serving/accessing-traces)
- [Setting up a logging plugin](./serving/setting-up-a-logging-plugin) - [Setting up a logging plugin](serving/setting-up-a-logging-plugin)
### Debugging ### Debugging
- [Debugging application issues](./serving/debugging-application-issues) - [Debugging application issues](serving/debugging-application-issues)
- [Debugging performance issues](./serving/debugging-performance-issues) - [Debugging performance issues](serving/debugging-performance-issues)
--- ---

8
docs/build/README.md vendored
View File

@ -12,9 +12,9 @@ action, you can define a Knative `Build` through a single configuration file.
Also consider using a Knative `Build` to build the source code of your apps into Also consider using a Knative `Build` to build the source code of your apps into
container images, which you can then run on container images, which you can then run on
[Knative `serving`](../serving/). [Knative `serving`](../../serving/).
More information about this use case is demonstrated in More information about this use case is demonstrated in
[this sample](../serving/samples/source-to-url-go). [this sample](../../serving/samples/source-to-url-go).
## Key features of Knative Builds ## Key features of Knative Builds
@ -49,7 +49,7 @@ Before you can run a Knative Build, you must install the Knative Build component
in your Kubernetes cluster: in your Kubernetes cluster:
- For details about installing a new instance of Knative in your Kubernetes - For details about installing a new instance of Knative in your Kubernetes
cluster, see [Installing Knative](../install/). cluster, see [Installing Knative](../../install/).
- If you have a component of Knative installed and running, you can - If you have a component of Knative installed and running, you can
[add and install the Knative Build component](installing-build-component/). [add and install the Knative Build component](installing-build-component/).
@ -103,7 +103,7 @@ builds.
#### Complex samples #### Complex samples
- [Use Knative to build apps from source code and then run those containers](../serving/samples/source-to-url-go). - [Use Knative to build apps from source code and then run those containers](../../serving/samples/source-to-url-go).
## Related info ## Related info

1
docs/build/builder-contract.md vendored
View File

@ -70,7 +70,6 @@ Builders should expect a Build to implement the following conventions:
- Credentials attached to the Build's service account may be exposed as Git or - Credentials attached to the Build's service account may be exposed as Git or
Docker credentials as outlined [here](../auth/). Docker credentials as outlined [here](../auth/).
--- ---
Except as otherwise noted, the content of this page is licensed under the Except as otherwise noted, the content of this page is licensed under the

2
docs/build/builds.md vendored
View File

@ -107,7 +107,6 @@ of the `steps` fields, or container images that you define:
For details about how to ensure that you implement each step to align with the For details about how to ensure that you implement each step to align with the
"builder contract", see the [`Builder`](../builder-contract/) reference topic. "builder contract", see the [`Builder`](../builder-contract/) reference topic.
#### Template #### Template
The `template` field is a required if no `steps` are defined. Specifies a The `template` field is a required if no `steps` are defined. Specifies a
@ -150,7 +149,6 @@ of the `Build` resource object.
For examples and more information about specifying service accounts, see the For examples and more information about specifying service accounts, see the
[`ServiceAccount`](../auth/) reference topic. [`ServiceAccount`](../auth/) reference topic.
#### Volumes #### Volumes
Optional. Specifies one or more Optional. Specifies one or more

6
docs/eventing/README.md
View File

@ -61,13 +61,13 @@ event sources. Sources manage registration and delivery of events from external
systems using Kubernetes systems using Kubernetes
[Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
Learn more about Eventing development in the Learn more about Eventing development in the
[Eventing work group](../../contributing/WORKING-GROUPS.md#events). [Eventing work group](../../contributing/WORKING-GROUPS/#events).
## Installation ## Installation
Knative Eventing currently requires Knative Serving and Istio version 1.0 or Knative Eventing currently requires Knative Serving and Istio version 1.0 or
later installed. later installed.
[Follow the instructions to install on the platform of your choice](../install/). [Follow the instructions to install on the platform of your choice](../../install/).
Many of the sources require making outbound connections to create the event Many of the sources require making outbound connections to create the event
subscription, and if you have any functions that make use of any external (to subscription, and if you have any functions that make use of any external (to
@ -247,7 +247,7 @@ The CronJobSource fires events based on given
## Getting Started ## Getting Started
- [Setup Knative Serving](../install/) - [Setup Knative Serving](../../install/)
- [Install Eventing components](#installation) - [Install Eventing components](#installation)
- [Run samples](samples/) - [Run samples](samples/)

8
docs/eventing/samples/gcp-pubsub-source/README.md
View File

@ -15,7 +15,7 @@ source is most useful as a bridge from other GCP services, such as
project id, and also set your project ID as default using project id, and also set your project ID as default using
`gcloud config set project $PROJECT_ID`. `gcloud config set project $PROJECT_ID`.
1. Setup [Knative Serving](../../../install) 1. Setup [Knative Serving](../../../../install)
1. Setup 1. Setup
[Knative Eventing](https://github.com/knative/docs/tree/master/eventing). In [Knative Eventing](https://github.com/knative/docs/tree/master/eventing). In
@ -70,7 +70,7 @@ source is most useful as a bridge from other GCP services, such as
`controller-manager` StatefulSet which manages your Eventing sources. `controller-manager` StatefulSet which manages your Eventing sources.
`google-cloud-key` and `key.json` are pre-configured values in `google-cloud-key` and `key.json` are pre-configured values in
[`gcp-pubsub-source.yaml`](./gcp-pubsub-source.yaml). [`gcp-pubsub-source.yaml`](../gcp-pubsub-source.yaml).
## Deployment ## Deployment
@ -97,7 +97,7 @@ source is most useful as a bridge from other GCP services, such as
1. Create a GCP PubSub Topic. If you change its name (`testing`), you also need 1. Create a GCP PubSub Topic. If you change its name (`testing`), you also need
to update the `topic` in the to update the `topic` in the
[`gcp-pubsub-source.yaml`](./gcp-pubsub-source.yaml) file: [`gcp-pubsub-source.yaml`](../gcp-pubsub-source.yaml) file:
```shell ```shell
gcloud pubsub topics create testing gcloud pubsub topics create testing
@ -105,7 +105,7 @@ source is most useful as a bridge from other GCP services, such as
1. Replace the 1. Replace the
[`MY_GCP_PROJECT` placeholder](https://cloud.google.com/resource-manager/docs/creating-managing-projects) [`MY_GCP_PROJECT` placeholder](https://cloud.google.com/resource-manager/docs/creating-managing-projects)
in [`gcp-pubsub-source.yaml`](./gcp-pubsub-source.yaml) and apply it. in [`gcp-pubsub-source.yaml`](../gcp-pubsub-source.yaml) and apply it.
If you're in the samples directory, you can replace `MY_GCP_PROJECT` and If you're in the samples directory, you can replace `MY_GCP_PROJECT` and
apply in one command: apply in one command:

2
docs/eventing/samples/github-source/README.md
View File

@ -10,7 +10,7 @@ You will need:
1. An internet-accessible Kubernetes cluster with Knative Serving 1. An internet-accessible Kubernetes cluster with Knative Serving
installed. Follow the [installation installed. Follow the [installation
instructions](../../../install/) instructions](../../../../install/)
if you need to create one. if you need to create one.
1. Ensure Knative Serving is [configured with a domain 1. Ensure Knative Serving is [configured with a domain
name](../../../serving/using-a-custom-domain.md) name](../../../serving/using-a-custom-domain.md)

17
docs/install/Knative-custom-install.md
View File

@ -15,7 +15,7 @@ to run multiple installation commands.
## Before you begin ## Before you begin
- If you are new to Knative, you should instead - If you are new to Knative, you should instead
[follow one of the platform-specific installation guides](./) to help [follow one of the platform-specific installation guides](../) to help
you get up and running quickly. you get up and running quickly.
- The steps in this guide use `bash` for the MacOS or Linux environment; for - The steps in this guide use `bash` for the MacOS or Linux environment; for
@ -70,7 +70,7 @@ service mesh. If you install any of the following options, you must install
- [Knative Eventing](https://github.com/knative/eventing) - [Knative Eventing](https://github.com/knative/eventing)
- [Knative Eventing Sources](https://github.com/knative/eventing-sources) - [Knative Eventing Sources](https://github.com/knative/eventing-sources)
- [Observability plugins](../serving/installing-logging-metrics-traces/) - [Observability plugins](../../serving/installing-logging-metrics-traces/)
#### Istio installation options #### Istio installation options
@ -210,7 +210,7 @@ files from the Knative repositories:
| [`message-dumper.yaml`][5.3] | Installs an Event logging service for debugging. | Serving component, Eventing component | | [`message-dumper.yaml`][5.3] | Installs an Event logging service for debugging. | Serving component, Eventing component |
_\*_ See _\*_ See
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces/) [Installing logging, metrics, and traces](../../serving/installing-logging-metrics-traces/)
for details about installing the various supported observability plug-ins. for details about installing the various supported observability plug-ins.
† These are the recommended standard install files suitable for most use cases. † These are the recommended standard install files suitable for most use cases.
@ -330,7 +330,6 @@ commands below.
kubectl get pods --namespace knative-monitoring kubectl get pods --namespace knative-monitoring
``` ```
See See
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md) [Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md)
for details about setting up the various supported observability plug-ins. for details about setting up the various supported observability plug-ins.
@ -343,14 +342,14 @@ events in your Knative cluster.
Depending on the Knative components you installed, you can use the following Depending on the Knative components you installed, you can use the following
guides to help you get started with Knative: guides to help you get started with Knative:
- [Getting Started with Knative App Deployment](./getting-started-knative-app/) - [Getting Started with Knative App Deployment](../getting-started-knative-app/)
- [Knative Serving sample apps](../serving/samples/) - [Knative Serving sample apps](../../serving/samples/)
- [Creating a simple Knative Build](../build/creating-builds/) - [Creating a simple Knative Build](../../build/creating-builds/)
- [Knative Build templates](https://github.com/knative/build-templates) - [Knative Build templates](https://github.com/knative/build-templates)
- [Knative Eventing overview](../eventing/) - [Knative Eventing overview](../../eventing/)
- [Knative Eventing code samples](../eventing/samples) - [Knative Eventing code samples](../../eventing/samples)

2
docs/install/Knative-with-AKS.md
View File

@ -200,7 +200,7 @@ To deploy your first app with Knative, follow the step-by-step
guide. guide.
To get started with Knative Eventing, pick one of the To get started with Knative Eventing, pick one of the
[Eventing Samples](../eventing/samples/) to walk through. [Eventing Samples](../../eventing/samples/) to walk through.
To get started with Knative Build, read the [Build README](../build/README.md), To get started with Knative Build, read the [Build README](../build/README.md),
then choose a sample to walk through. then choose a sample to walk through.

2
docs/install/Knative-with-Docker-for-Mac.md
View File

@ -103,7 +103,7 @@ Knative, check out the
guide. guide.
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/) repo. head to the [sample apps](../../serving/samples/) repo.
> Note: You can replace the {IP_ADDRESS} placeholder used in the samples with > Note: You can replace the {IP_ADDRESS} placeholder used in the samples with
> `localhost` as mentioned above. > `localhost` as mentioned above.

2
docs/install/Knative-with-Minikube.md
View File

@ -130,7 +130,7 @@ Knative, check out the
guide. guide.
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/) repo. head to the [sample apps](../../serving/samples/) repo.
> Note: When looking up the IP address to use for accessing your app, you need > Note: When looking up the IP address to use for accessing your app, you need
> to look up the NodePort for the `istio-ingressgateway` well as the IP address > to look up the NodePort for the `istio-ingressgateway` well as the IP address

2
docs/install/Knative-with-Minishift.md
View File

@ -278,7 +278,7 @@ curl -H "Host: helloworld-go.myproject.example.com" http://$IP_ADDRESS
``` ```
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/) repository. head to the [sample apps](../../serving/samples/) repository.
## Cleaning up ## Cleaning up

2
docs/install/Knative-with-OpenShift.md
View File

@ -217,7 +217,7 @@ Knative, check out the
guide. guide.
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/) repo. head to the [sample apps](../../serving/samples/) repo.
> Note: When looking up the IP address to use for accessing your app, you need > Note: When looking up the IP address to use for accessing your app, you need
> to look up the NodePort for the `istio-ingressgateway` well as the IP address > to look up the NodePort for the `istio-ingressgateway` well as the IP address

2
docs/install/README.md
View File

@ -133,7 +133,7 @@ and set up an Istio IP range for outbound network access:
## Checking the version of your Knative Serving installation ## Checking the version of your Knative Serving installation
- [Checking the version of your Knative Serving installation](check-install-version/) - [Checking the version of your Knative Serving installation](./check-install-version/)
--- ---

4
docs/install/getting-started-knative-app.md
View File

@ -11,7 +11,7 @@ using cURL requests.
You need: You need:
- A Kubernetes cluster with [Knative installed](./). - A Kubernetes cluster with [Knative installed](../).
- An image of the app that you'd like to deploy available on a container - An image of the app that you'd like to deploy available on a container
registry. The image of the sample app used in this guide is available on registry. The image of the sample app used in this guide is available on
Google Container Registry. Google Container Registry.
@ -19,7 +19,7 @@ You need:
## Sample application ## Sample application
This guide uses the This guide uses the
[Hello World sample app in Go](../serving/samples/helloworld-go) to demonstrate [Hello World sample app in Go](../../serving/samples/helloworld-go) to demonstrate
the basic workflow for deploying an app, but these steps can be adapted for your the basic workflow for deploying an app, but these steps can be adapted for your
own application if you have an image of it available on own application if you have an image of it available on
[Docker Hub](https://docs.docker.com/docker-hub/repos/), [Docker Hub](https://docs.docker.com/docker-hub/repos/),

30
docs/serving/README.md
View File

@ -54,30 +54,30 @@ in the Knative Serving repository.
## More samples and demos ## More samples and demos
- [Autoscaling with Knative Serving](./samples/autoscale-go/) - [Autoscaling with Knative Serving](samples/autoscale-go/)
- [Source-to-URL with Knative Serving](./samples/source-to-url-go/) - [Source-to-URL with Knative Serving](samples/source-to-url-go/)
- [Telemetry with Knative Serving](./samples/telemetry-go/) - [Telemetry with Knative Serving](samples/telemetry-go/)
- [REST API sample](./samples/rest-api-go/) - [REST API sample](samples/rest-api-go/)
## Setting up Logging and Metrics ## Setting up Logging and Metrics
- [Installing Logging, Metrics and Traces](./installing-logging-metrics-traces/) - [Installing Logging, Metrics and Traces](../installing-logging-metrics-traces/)
- [Accessing Logs](./accessing-logs/) - [Accessing Logs](../accessing-logs/)
- [Accessing Metrics](./accessing-metrics/) - [Accessing Metrics](../accessing-metrics/)
- [Accessing Traces](./accessing-traces/) - [Accessing Traces](../accessing-traces/)
- [Setting up a logging plugin](./setting-up-a-logging-plugin/) - [Setting up a logging plugin](../setting-up-a-logging-plugin/)
## Debugging Knative Serving issues ## Debugging Knative Serving issues
- [Debugging Application Issues](./debugging-application-issues/) - [Debugging Application Issues](../debugging-application-issues/)
- [Debugging Performance Issues](./debugging-performance-issues/) - [Debugging Performance Issues](../debugging-performance-issues/)
## Configuration and Networking ## Configuration and Networking
- [Configuring outbound network access](./outbound-network-access/) - [Configuring outbound network access](../outbound-network-access/)
- [Configuring cluster local routes](./cluster-local-route/) - [Configuring cluster local routes](../cluster-local-route/)
- [Using a custom domain](./using-a-custom-domain/) - [Using a custom domain](../using-a-custom-domain/)
- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address/) - [Assigning a static IP address for Knative on Google Kubernetes Engine](../gke-assigning-static-ip-address/)
## Known Issues ## Known Issues

8
docs/serving/accessing-logs.md
View File

@ -5,7 +5,7 @@ weight: 5
--- ---
If you have not yet installed the logging and monitoring components, go through If you have not yet installed the logging and monitoring components, go through
the [installation instructions](./installing-logging-metrics-traces/) to set the [installation instructions](../../installing-logging-metrics-traces/) to set
up the necessary components first. up the necessary components first.
## Kibana and Elasticsearch ## Kibana and Elasticsearch
@ -27,7 +27,7 @@ up the necessary components first.
The Discover tab of the Kibana UI looks like this: The Discover tab of the Kibana UI looks like this:
![Kibana UI Discover tab](./images/kibana-discover-tab-annotated.png) ![Kibana UI Discover tab](../images/kibana-discover-tab-annotated.png)
You can change the time frame of logs Kibana displays in the upper right You can change the time frame of logs Kibana displays in the upper right
corner of the screen. The main search bar is across the top of the Discover corner of the screen. The main search bar is across the top of the Discover
@ -88,7 +88,7 @@ kubernetes.labels.serving_knative_dev\/revision: <REVISION_NAME>
### Accessing build logs ### Accessing build logs
To access logs for a [Knative Build](../build/): To access logs for a [Knative Build](../../build/):
- Find the build's name in the specified in the `.yaml` file: - Find the build's name in the specified in the `.yaml` file:
@ -147,7 +147,7 @@ userAgent curl/7.60.0
### Accessing end to end request traces ### Accessing end to end request traces
See [Accessing Traces](./accessing-traces/) page for details. See [Accessing Traces](../accessing-traces/) page for details.
## Stackdriver ## Stackdriver

2
docs/serving/accessing-metrics.md
View File

@ -25,7 +25,7 @@ $(kubectl get pods --namespace knative-monitoring \
3. Select the **Home** button on the top of the page to see the list of 3. Select the **Home** button on the top of the page to see the list of
pre-installed dashboards (screenshot below): pre-installed dashboards (screenshot below):
![Knative Dashboards](./images/grafana1.png) ![Knative Dashboards](../images/grafana1.png)
The following dashboards are pre-installed with Knative Serving: The following dashboards are pre-installed with Knative Serving:

2
docs/serving/accessing-traces.md
View File

@ -5,7 +5,7 @@ weight: 15
--- ---
If you have not yet installed the logging and monitoring components, go through If you have not yet installed the logging and monitoring components, go through
the [installation instructions](./installing-logging-metrics-traces/) to set the [installation instructions](../installing-logging-metrics-traces/) to set
up the necessary components. up the necessary components.
In order to access request traces, you use the Zipkin visualization tool. In order to access request traces, you use the Zipkin visualization tool.

2
docs/serving/cluster-local-route.md
View File

@ -8,7 +8,7 @@ In Knative 0.3.x or later, all Routes with a domain suffix of
`svc.cluster.local` will only be visible inside the cluster. `svc.cluster.local` will only be visible inside the cluster.
This can be done by changing the `config-domain` config map as instructed This can be done by changing the `config-domain` config map as instructed
[here](./using-a-custom-domain/). [here](../using-a-custom-domain/).
You can also set the label `serving.knative.dev/visibility=cluster-local` on You can also set the label `serving.knative.dev/visibility=cluster-local` on
your Route or KService to achieve the same effect. your Route or KService to achieve the same effect.

2
docs/serving/debugging-application-issues.md
View File

@ -29,7 +29,7 @@ ERROR: Non-zero return code '1' from command: Process exited with status 1
## Check application logs ## Check application logs
Knative Serving provides default out-of-the-box logs for your application. Knative Serving provides default out-of-the-box logs for your application.
Access your application logs using [Accessing Logs](./accessing-logs/) page. Access your application logs using [Accessing Logs](../accessing-logs/) page.
## Check Route status ## Check Route status

14
docs/serving/debugging-performance-issues.md
View File

@ -14,13 +14,13 @@ and tools.
Start your investigation with the "Revision - HTTP Requests" dashboard. Start your investigation with the "Revision - HTTP Requests" dashboard.
1. To open this dashboard, open the Grafana UI as described in 1. To open this dashboard, open the Grafana UI as described in
[Accessing Metrics](./accessing-metrics/) and navigate to "Knative [Accessing Metrics](../accessing-metrics/) and navigate to "Knative
Serving - Revision HTTP Requests". Serving - Revision HTTP Requests".
1. Select your configuration and revision from the menu on top left of the 1. Select your configuration and revision from the menu on top left of the
page. You will see a page like this: page. You will see a page like this:
![Knative Serving - Revision HTTP Requests](./images/request_dash1.png) ![Knative Serving - Revision HTTP Requests](../images/request_dash1.png)
This dashboard gives visibility into the following for each revision: This dashboard gives visibility into the following for each revision:
@ -41,12 +41,12 @@ Next, look into request traces to find out where the time is spent for a single
request. request.
1. To access request traces, open the Zipkin UI as described in 1. To access request traces, open the Zipkin UI as described in
[Accessing Traces](./accessing-traces/). [Accessing Traces](../accessing-traces/).
1. Select your revision from the "Service Name" dropdown, and then click the 1. Select your revision from the "Service Name" dropdown, and then click the
"Find Traces" button. You'll get a view that looks like this: "Find Traces" button. You'll get a view that looks like this:
![Zipkin - Trace Overview](./images/zipkin1.png) ![Zipkin - Trace Overview](../images/zipkin1.png)
In this example, you can see that the request spent most of its time in the In this example, you can see that the request spent most of its time in the
[span](https://github.com/opentracing/specification/blob/master/specification.md#the-opentracing-data-model) [span](https://github.com/opentracing/specification/blob/master/specification.md#the-opentracing-data-model)
@ -54,7 +54,7 @@ request.
1. Click that span to see a view like the following: 1. Click that span to see a view like the following:
![Zipkin - Span Details](./images/zipkin2.png) ![Zipkin - Span Details](../images/zipkin2.png)
This view shows detailed information about the specific span, such as the This view shows detailed information about the specific span, such as the
micro service or external URL that was called. In this example, the call to micro service or external URL that was called. In this example, the call to
@ -70,7 +70,7 @@ next.
1. To open the autoscaler dashboard, open Grafana UI and select "Knative 1. To open the autoscaler dashboard, open Grafana UI and select "Knative
Serving - Autoscaler" dashboard, which looks like this: Serving - Autoscaler" dashboard, which looks like this:
![Knative Serving - Autoscaler](./images/autoscaler_dash1.png) ![Knative Serving - Autoscaler](../images/autoscaler_dash1.png)
This view shows 4 key metrics from the Knative Serving autoscaler: This view shows 4 key metrics from the Knative Serving autoscaler:
@ -98,7 +98,7 @@ the traffic but was only granted 8 pods because the cluster is out of resources.
You can access total CPU and memory usage of your revision from the "Knative You can access total CPU and memory usage of your revision from the "Knative
Serving - Revision CPU and Memory Usage" dashboard, which looks like this: Serving - Revision CPU and Memory Usage" dashboard, which looks like this:
![Knative Serving - Revision CPU and Memory Usage](./images/cpu_dash1.png) ![Knative Serving - Revision CPU and Memory Usage](../images/cpu_dash1.png)
The first chart shows rate of the CPU usage across all pods serving the The first chart shows rate of the CPU usage across all pods serving the
revision. The second chart shows total memory consumed across all pods serving revision. The second chart shows total memory consumed across all pods serving

2
docs/serving/gke-assigning-static-ip-address.md
View File

@ -5,7 +5,7 @@ weight: 35
--- ---
If you are running Knative on Google Kubernetes Engine and want to use a If you are running Knative on Google Kubernetes Engine and want to use a
[custom domain](./using-a-custom-domain/) with your apps, you need to [custom domain](../using-a-custom-domain/) with your apps, you need to
configure a static IP address to ensure that your custom domain mapping doesn't configure a static IP address to ensure that your custom domain mapping doesn't
break. break.

8
docs/serving/installing-logging-metrics-traces.md
View File

@ -5,7 +5,7 @@ weight: 40
--- ---
If you followed one of the If you followed one of the
[comprehensive install guides](../install/#install-guides) or you [comprehensive install guides](../../install/#install-guides) or you
performed a custom installation and included the `monitoring.yaml` file in your performed a custom installation and included the `monitoring.yaml` file in your
installation, all of the observability features are already installed and you installation, all of the observability features are already installed and you
can skip down to the can skip down to the
@ -254,9 +254,9 @@ end traces.
## Learn More ## Learn More
- Learn more about accessing logs, metrics, and traces: - Learn more about accessing logs, metrics, and traces:
- [Accessing Logs](./accessing-logs/) - [Accessing Logs](../accessing-logs/)
- [Accessing Metrics](./accessing-metrics/) - [Accessing Metrics](../accessing-metrics/)
- [Accessing Traces](./accessing-traces/) - [Accessing Traces](../accessing-traces/)
--- ---

1
docs/serving/samples/README.md
View File

@ -20,3 +20,4 @@ more about Knative Serving resources.
| Telemetry | This sample runs a simple web server that makes calls to other in-cluster services and responds to requests with "Hello World!". The purpose of this sample is to show generating metrics, logs, and distributed traces. | [Go](telemetry-go/README.md) | | Telemetry | This sample runs a simple web server that makes calls to other in-cluster services and responds to requests with "Hello World!". The purpose of this sample is to show generating metrics, logs, and distributed traces. | [Go](telemetry-go/README.md) |
| Thumbnailer | An example of deploying a "dockerized" application to Knative Serving which takes video URL as an input and generates its thumbnail image. | [Go](thumbnailer-go/README.md) | | Thumbnailer | An example of deploying a "dockerized" application to Knative Serving which takes video URL as an input and generates its thumbnail image. | [Go](thumbnailer-go/README.md) |
| Traffic Splitting | This samples builds off the [Creating a RESTful Service](./rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](traffic-splitting/README.md) | | Traffic Splitting | This samples builds off the [Creating a RESTful Service](./rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](traffic-splitting/README.md) |

6
docs/serving/samples/autoscale-go/README.md
View File

@ -4,10 +4,10 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision.
## Prerequisites ## Prerequisites
1. A Kubernetes cluster with 1. A Kubernetes cluster with
[Knative Serving](../../../install/) [Knative Serving](../../../../install/)
installed. installed.
1. A 1. A
[metrics installation](../../installing-logging-metrics-traces/) [metrics installation](../../../installing-logging-metrics-traces/)
for viewing scaling graphs (optional). for viewing scaling graphs (optional).
1. The `hey` load generator installed (`go get -u github.com/rakyll/hey`). 1. The `hey` load generator installed (`go get -u github.com/rakyll/hey`).
1. Clone this repository, and move into the sample directory: 1. Clone this repository, and move into the sample directory:
@ -19,7 +19,7 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision.
## Deploy the Service ## Deploy the Service
1. Deploy the [sample](./service.yaml) Knative Service: 1. Deploy the [sample](../service.yaml) Knative Service:
``` ```
kubectl apply --filename serving/samples/autoscale-go/service.yaml kubectl apply --filename serving/samples/autoscale-go/service.yaml

4
docs/serving/samples/blue-green-deployment.md
View File

@ -13,9 +13,9 @@ configuration.
You need: You need:
- A Kubernetes cluster with [Knative installed](../../install/). - A Kubernetes cluster with [Knative installed](../../../install/).
- (Optional) - (Optional)
[A custom domain configured](../../serving/using-a-custom-domain/) for use [A custom domain configured](../../../serving/using-a-custom-domain/) for use
with Knative. with Knative.
Note: The source code for the gcr.io/knative-samples/knative-route-demo image Note: The source code for the gcr.io/knative-samples/knative-route-demo image

2
docs/serving/samples/build-private-repo-go/README.md
View File

@ -8,7 +8,7 @@ This sample demonstrates:
## Before you begin ## Before you begin
- [Install Knative Serving](../../../install/) - [Install Knative Serving](../../../../install/)
- Create a local folder for this sample and download the files in this directory - Create a local folder for this sample and download the files in this directory
into it. into it.

2
docs/serving/samples/buildpack-app-dotnet/README.md
View File

@ -9,7 +9,7 @@ sample app for Cloud Foundry.
## Prerequisites ## Prerequisites
- [Install Knative Serving](../../../install/) - [Install Knative Serving](../../../../install/)
## Running ## Running

2
docs/serving/samples/buildpack-function-nodejs/README.md
View File

@ -8,7 +8,7 @@ sample function for riff.
## Prerequisites ## Prerequisites
- [Install Knative Serving](../../../install/) - [Install Knative Serving](../../../../install/)
## Running ## Running

2
docs/serving/samples/gitwebhook-go/README.md
View File

@ -5,7 +5,7 @@ webhook.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](../../../install/) [installation instructions](../../../../install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [Docker](https://www.docker.com) installed and running on your local machine,
and a Docker Hub account configured (we'll use it for a container registry). and a Docker Hub account configured (we'll use it for a container registry).

2
docs/serving/samples/grpc-ping-go/README.md
View File

@ -5,7 +5,7 @@ This sample requires knative/serving 0.4 or later.
## Prerequisites ## Prerequisites
1. [Install Knative](../../../install/) 1. [Install Knative](../../../../install/)
1. Install [docker](https://www.docker.com/) 1. Install [docker](https://www.docker.com/)
## Build and run the gRPC server ## Build and run the gRPC server

2
docs/serving/samples/hello-world/helloworld-ruby/README.md
View File

@ -72,7 +72,7 @@ recreate the source files from this folder.
``` ```
1. Run bundle. If you don't have bundler installed, copy the 1. Run bundle. If you don't have bundler installed, copy the
[Gemfile.lock](./Gemfile.lock) to your working directory. [Gemfile.lock](../Gemfile.lock) to your working directory.
```shell ```shell
bundle install bundle install

2
docs/serving/samples/knative-routing-go/README.md
View File

@ -15,7 +15,7 @@ the Login service.
## Prerequisites ## Prerequisites
1. A Kubernetes cluster with 1. A Kubernetes cluster with
[Knative Serving](../../../install/) [Knative Serving](../../../../install/)
installed. installed.
2. Install 2. Install
[Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment). [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment).

2
docs/serving/samples/source-to-url-go/README.md
View File

@ -11,7 +11,7 @@ deployment.
You need: You need:
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](../../../install/) [installation instructions](../../../../install/)
if you need to create one. if you need to create one.
- Go installed and configured. This is optional, and only required if you want - Go installed and configured. This is optional, and only required if you want
to run the sample app locally. to run the sample app locally.

4
docs/serving/samples/telemetry-go/README.md
View File

@ -9,7 +9,7 @@ dedicated Prometheus instance rather than using the default installation.
## Prerequisites ## Prerequisites
1. A Kubernetes cluster with 1. A Kubernetes cluster with
[Knative Serving](../../../install/) [Knative Serving](../../../../install/)
installed. installed.
2. Check if Knative monitoring components are installed: 2. Check if Knative monitoring components are installed:
@ -18,7 +18,7 @@ kubectl get pods --namespace knative-monitoring
``` ```
- If pods aren't found, install - If pods aren't found, install
[Knative monitoring component](../../installing-logging-metrics-traces/). [Knative monitoring component](../../../installing-logging-metrics-traces/).
3. Install 3. Install
[Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment). [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment).

2
docs/serving/samples/thumbnailer-go/README.md
View File

@ -6,7 +6,7 @@ generates its thumbnail image using the `ffmpeg` framework.
## Before you begin ## Before you begin
- [Install Knative Serving](../../../install/) - [Install Knative Serving](../../../../install/)
If you want to test and run the app locally: If you want to test and run the app locally:

2
docs/serving/using-a-custom-domain.md
View File

@ -81,7 +81,7 @@ You can also apply an updated domain configuration:
> deployed services and routes. > deployed services and routes.
Deploy an app (for example, Deploy an app (for example,
[`helloworld-go`](./samples/helloworld-go/)), to your cluster as [`helloworld-go`](../samples/helloworld-go/)), to your cluster as
normal. You can check the customized domain in Knative Route "helloworld-go" normal. You can check the customized domain in Knative Route "helloworld-go"
with the following command: with the following command:

2
docs/serving/using-an-ssl-cert.md
View File

@ -9,7 +9,7 @@ steps below to configure Knative to use your certificate and enable HTTPS
connections. connections.
Before you begin, you will need to Before you begin, you will need to
[configure Knative to use your custom domain](./using-a-custom-domain/). [configure Knative to use your custom domain](../using-a-custom-domain/).
**Note:** due to limitations in Istio, Knative only supports a single **Note:** due to limitations in Istio, Knative only supports a single
certificate per cluster. If you will serve multiple domains in the same cluster, certificate per cluster. If you will serve multiple domains in the same cluster,