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

This adops the "artifact" shortcode. (#2183) 

I'm introducing this here: knative/website#129 with the intention of enabling us to make the Pre-release pages show nightly builds, which are hosted completely differently.
This commit is contained in:
Matt Moore 2020-02-11 14:15:22 -08:00 committed by GitHub
parent 842a18d9bb
commit 5d2a9445eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/eventing/getting-started.md
View File

@ -49,13 +49,13 @@ If the `knative-eventing` namespace or the `imc-controller-*` does not exist, us
```sh ```sh
kubectl apply --selector knative.dev/crd-install=true \ kubectl apply --selector knative.dev/crd-install=true \
--filename https://github.com/knative/eventing/releases/download/{{< version >}}/eventing.yaml --filename {{< artifact repo="eventing" file="eventing.yaml" >}}
``` ```
1. Finish installing Eventing resources by running the following command: 1. Finish installing Eventing resources by running the following command:
```sh ```sh
kubectl apply --filename https://github.com/knative/eventing/releases/download/{{< version >}}/eventing.yaml kubectl apply --filename {{< artifact repo="eventing" file="eventing.yaml" >}}
``` ```
Installing the CRDs first can prevent race conditions, which might cause failures during the install. Installing the CRDs first can prevent race conditions, which might cause failures during the install.

42
docs/install/knative-with-any-k8s.md
View File

@ -45,13 +45,13 @@ The following commands install the Knative Serving component.
1. Install the [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (aka CRDs): 1. Install the [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (aka CRDs):
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/serving-crds.yaml kubectl apply --filename {{< artifact repo="serving" file="serving-crds.yaml" >}}
``` ```
1. Install the core components of Serving (see below for optional extensions): 1. Install the core components of Serving (see below for optional extensions):
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/serving-core.yaml kubectl apply --filename {{< artifact repo="serving" file="serving-core.yaml" >}}
``` ```
1. Pick a networking layer (alphabetical): 1. Pick a networking layer (alphabetical):
@ -114,7 +114,7 @@ The following commands install Contour and enable its Knative integration.
1. Install a properly configured Contour: 1. Install a properly configured Contour:
```bash ```bash
kubectl apply --filename https://github.com/knative/net-contour/releases/download/{{< version >}}/contour.yaml kubectl apply --filename {{< artifact repo="net-contour" file="contour.yaml" >}}
``` ```
<!-- TODO(https://github.com/knative/net-contour/issues/11): We need a guide on how to use/modify a pre-existing install. --> <!-- TODO(https://github.com/knative/net-contour/issues/11): We need a guide on how to use/modify a pre-existing install. -->
@ -122,7 +122,7 @@ The following commands install Contour and enable its Knative integration.
1. Install the Knative Contour controller: 1. Install the Knative Contour controller:
```bash ```bash
kubectl apply --filename https://github.com/knative/net-contour/releases/download/{{< version >}}/net-contour.yaml kubectl apply --filename {{< artifact repo="net-contour" file="net-contour.yaml" >}}
``` ```
1. To configure Knative Serving to use Contour by default: 1. To configure Knative Serving to use Contour by default:
@ -190,7 +190,7 @@ The following commands install Istio and enable its Knative integration.
1. Install the Knative Istio controller: 1. Install the Knative Istio controller:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/serving-istio.yaml kubectl apply --filename {{< artifact repo="serving" file="serving-istio.yaml" >}}
``` ```
1. Fetch the External IP or CNAME: 1. Fetch the External IP or CNAME:
@ -240,7 +240,7 @@ The following commands install Kourier and enable its Knative integration.
We ship a simple Kubernetes Job called "default domain" that will (see caveats) configure Knative Serving to use <a href="http://xip.io">xip.io</a> as the default DNS suffix. We ship a simple Kubernetes Job called "default domain" that will (see caveats) configure Knative Serving to use <a href="http://xip.io">xip.io</a> as the default DNS suffix.
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/serving-default-domain.yaml kubectl apply --filename {{< artifact repo="serving" file="serving-default-domain.yaml" >}}
``` ```
**Caveat**: This will only work if the cluster LoadBalancer service exposes an IPv4 address, so it will not work with IPv6 clusters, AWS, or local setups like Minikube. For these, see "Real DNS". **Caveat**: This will only work if the cluster LoadBalancer service exposes an IPv4 address, so it will not work with IPv6 clusters, AWS, or local setups like Minikube. For these, see "Real DNS".
@ -296,7 +296,7 @@ for driving autoscaling decisions. The following command will install the
components needed to support HPA-class autoscaling: components needed to support HPA-class autoscaling:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/serving-hpa.yaml kubectl apply --filename {{< artifact repo="serving" file="serving-hpa.yaml" >}}
``` ```
<!-- TODO(https://github.com/knative/docs/issues/2152): Link to a more in-depth guide on HPA-class autoscaling --> <!-- TODO(https://github.com/knative/docs/issues/2152): Link to a more in-depth guide on HPA-class autoscaling -->
@ -312,7 +312,7 @@ Knative supports automatically provisioning TLS certificates via [cert-manager](
2. Next, install the component that integrates Knative with cert-manager: 2. Next, install the component that integrates Knative with cert-manager:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/serving-cert-manager.yaml kubectl apply --filename {{< artifact repo="serving" file="serving-cert-manager.yaml" >}}
``` ```
3. Now configure Knative to [automatically configure TLS certificates](../serving/using-auto-tls.md). 3. Now configure Knative to [automatically configure TLS certificates](../serving/using-auto-tls.md).
@ -323,7 +323,7 @@ Knative supports automatically provisioning TLS certificates via [cert-manager](
If you plan to use cert-manager's support for provisioning wildcard certificates, then the most efficient way to provision certificates is with the namespace wildcard certificate controller. The following command will install the components needed to provision wildcard certificates in each namespace: If you plan to use cert-manager's support for provisioning wildcard certificates, then the most efficient way to provision certificates is with the namespace wildcard certificate controller. The following command will install the components needed to provision wildcard certificates in each namespace:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/serving-nscert.yaml kubectl apply --filename {{< artifact repo="serving" file="serving-nscert.yaml" >}}
``` ```
{{< /tab >}} {{< /tab >}}
@ -342,13 +342,13 @@ The following commands install the Knative Eventing component.
1. Install the [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (aka CRDs): 1. Install the [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (aka CRDs):
```bash ```bash
kubectl apply --filename https://github.com/knative/eventing/releases/download/{{< version >}}/eventing-crds.yaml kubectl apply --filename {{< artifact repo="eventing" file="eventing-crds.yaml" >}}
``` ```
1. Install the core components of Eventing (see below for optional extensions): 1. Install the core components of Eventing (see below for optional extensions):
```bash ```bash
kubectl apply --filename https://github.com/knative/eventing/releases/download/{{< version >}}/eventing-core.yaml kubectl apply --filename {{< artifact repo="eventing" file="eventing-core.yaml" >}}
``` ```
1. Install a default Channel (messaging) layer. 1. Install a default Channel (messaging) layer.
@ -359,7 +359,7 @@ The following commands install the Knative Eventing component.
The following command installs an implementation of Channel that runs in-memory. This implementation is nice because it is simple and standalone, but it is unsuitable for production use cases. The following command installs an implementation of Channel that runs in-memory. This implementation is nice because it is simple and standalone, but it is unsuitable for production use cases.
```bash ```bash
kubectl apply --filename https://github.com/knative/eventing/releases/download/{{< version >}}/in-memory-channel.yaml kubectl apply --filename {{< artifact repo="eventing" file="in-memory-channel.yaml" >}}
``` ```
{{< /tab >}} {{< /tab >}}
@ -440,7 +440,7 @@ The following command enables the default Broker on a namespace (here `default`)
The following command installs the Github Source: The following command installs the Github Source:
```bash ```bash
kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/github.yaml kubectl apply --filename {{< artifact repo="eventing-contrib" file="github.yaml" >}}
``` ```
To learn more about the Github source, try [our sample](../eventing/samples/github-source/README.md) To learn more about the Github source, try [our sample](../eventing/samples/github-source/README.md)
@ -451,7 +451,7 @@ To learn more about the Github source, try [our sample](../eventing/samples/gith
The following command installs the Apache Camel-K Source: The following command installs the Apache Camel-K Source:
```bash ```bash
kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/camel.yaml kubectl apply --filename {{< artifact repo="eventing-contrib" file="camel.yaml" >}}
``` ```
To learn more about the Apache Camel-K source, try [our sample](../eventing/samples/apache-camel-source/README.md) To learn more about the Apache Camel-K source, try [our sample](../eventing/samples/apache-camel-source/README.md)
@ -462,7 +462,7 @@ To learn more about the Apache Camel-K source, try [our sample](../eventing/samp
The following command installs the Apache Kafka Source: The following command installs the Apache Kafka Source:
```bash ```bash
kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/kafka-source.yaml kubectl apply --filename {{< artifact repo="eventing-contrib" file="kafka-source.yaml" >}}
``` ```
To learn more about the Apache Kafka source, try [our sample](../eventing/samples/kafka/source/README.md) To learn more about the Apache Kafka source, try [our sample](../eventing/samples/kafka/source/README.md)
@ -502,13 +502,13 @@ Knative provides a bundle of monitoring components that can be used to make the
- Install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for metrics: - Install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for metrics:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-metrics-prometheus.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-metrics-prometheus.yaml" >}}
``` ```
- Install the [ELK stack](https://www.elastic.co/what-is/elk-stack) (Elasticsearch, Logstash and Kibana) for logs: - Install the [ELK stack](https://www.elastic.co/what-is/elk-stack) (Elasticsearch, Logstash and Kibana) for logs:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-logs-elasticsearch.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-logs-elasticsearch.yaml" >}}
``` ```
- Install [Jaeger](https://jaegertracing.io/) for distributed tracing - Install [Jaeger](https://jaegertracing.io/) for distributed tracing
@ -519,7 +519,7 @@ Knative provides a bundle of monitoring components that can be used to make the
To install the in-memory (standalone) version of Jaeger, run the following command: To install the in-memory (standalone) version of Jaeger, run the following command:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-jaeger-in-mem.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-jaeger-in-mem.yaml" >}}
``` ```
{{< /tab >}} {{< /tab >}}
@ -527,7 +527,7 @@ kubectl apply --filename https://github.com/knative/serving/releases/download/{{
To install the ELK version of Jaeger (needs the ELK install above), run the following command: To install the ELK version of Jaeger (needs the ELK install above), run the following command:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-jaeger.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-jaeger.yaml" >}}
``` ```
{{< /tab >}} {{< /tab >}}
{{< /tabs >}} {{< /tabs >}}
@ -540,7 +540,7 @@ kubectl apply --filename https://github.com/knative/serving/releases/download/{{
To install the in-memory (standalone) version of Zipkin, run the following command: To install the in-memory (standalone) version of Zipkin, run the following command:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-zipkin-in-mem.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-zipkin-in-mem.yaml" >}}
``` ```
{{< /tab >}} {{< /tab >}}
@ -548,7 +548,7 @@ kubectl apply --filename https://github.com/knative/serving/releases/download/{{
To install the ELK version of Zipkin (needs the ELK install above), run the following command: To install the ELK version of Zipkin (needs the ELK install above), run the following command:
```bash ```bash
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-zipkin.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-zipkin.yaml" >}}
``` ```
{{< /tab >}} {{< /tab >}}
{{< /tabs >}} {{< /tabs >}}

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

@ -31,7 +31,7 @@ sections to do so now.
1. Run the following command to install Prometheus and Grafana: 1. Run the following command to install Prometheus and Grafana:
```shell ```shell
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-metrics-prometheus.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-metrics-prometheus.yaml" >}}
``` ```
1. Ensure that the `grafana-*`, `kibana-logging-*`, `kube-state-metrics-*`, 1. Ensure that the `grafana-*`, `kibana-logging-*`, `kube-state-metrics-*`,
@ -90,7 +90,7 @@ install:
1. Run the following command to install an ELK stack: 1. Run the following command to install an ELK stack:
```shell ```shell
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-logs-elasticsearch.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-logs-elasticsearch.yaml" >}}
``` ```
1. Ensure that the `elasticsearch-logging-*`, `fluentd-ds-*`, and 1. Ensure that the `elasticsearch-logging-*`, `fluentd-ds-*`, and
@ -268,14 +268,14 @@ uninstall that tool before installing the new tool.
end traces, run: end traces, run:
```shell ```shell
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-zipkin-in-mem.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-zipkin-in-mem.yaml" >}}
``` ```
- If Elasticsearch is installed and you want to persist end to end traces, - If Elasticsearch is installed and you want to persist end to end traces,
first run: first run:
```shell ```shell
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-zipkin.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-zipkin.yaml" >}}
``` ```
1. Create an Elasticsearch index for end to end traces: 1. Create an Elasticsearch index for end to end traces:
@ -303,14 +303,14 @@ end traces.
end traces, run: end traces, run:
```shell ```shell
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-jaeger-in-mem.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-jaeger-in-mem.yaml" >}}
``` ```
- If Elasticsearch is installed and you want to persist end to end traces, - If Elasticsearch is installed and you want to persist end to end traces,
first run: first run:
```shell ```shell
kubectl apply --filename https://github.com/knative/serving/releases/download/{{< version >}}/monitoring-tracing-jaeger.yaml kubectl apply --filename {{< artifact repo="serving" file="monitoring-tracing-jaeger.yaml" >}}
``` ```
1. Create an Elasticsearch index for end to end traces: 1. Create an Elasticsearch index for end to end traces: