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

Update notes formatting (#4512)

This commit is contained in:
Ashleigh Brennan 2021-11-22 08:22:14 -06:00 committed by GitHub
parent 07b80cea90
commit 18fe4aba94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 43 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/eventing/broker/create-mtbroker.md
View File

@ -13,7 +13,8 @@ You can create a broker by using the `kn` CLI or by applying YAML files using `k
kn broker create <broker-name> -n <namespace>
```
**NOTE:** If you choose not to specify a namespace, the broker will be created in the current namespace.
!!! note
If you choose not to specify a namespace, the broker will be created in the current namespace.
1. Optional: Verify that the broker was created by listing existing brokers. Enter the following command:

9
docs/eventing/broker/kafka-broker/README.md
View File

@ -101,7 +101,8 @@ This `ConfigMap` is installed in the cluster. You can edit
the configuration or create a new one with the same values
depending on your needs.
**NOTE:** The `default.topic.replication.factor` value must be less than or equal to the number of Kafka broker instances in your cluster. For example, if you only have one Kafka broker, the `default.topic.replication.factor` value should not be more than `1`.
!!! note
The `default.topic.replication.factor` value must be less than or equal to the number of Kafka broker instances in your cluster. For example, if you only have one Kafka broker, the `default.topic.replication.factor` value should not be more than `1`.
## Set as default broker implementation
@ -170,7 +171,8 @@ data:
The `Secret` `my_secret` must exist in the same namespace of the `ConfigMap` referenced by `broker.spec.config`,
in this case: `knative-eventing`.
_Note: Certificates and keys must be in [`PEM` format](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail)._
!!! note
Certificates and keys must be in [`PEM` format](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail).
### Authentication using SASL
@ -222,7 +224,8 @@ kubectl create secret --namespace <namespace> generic <my_secret> \
--from-file=user.key=<my_key.pem_file_path>
```
_NOTE: `ca.crt` can be omitted to fallback to use system's root CA set._
!!! note
`ca.crt` can be omitted to fallback to use system's root CA set.
## Kafka Producer and Consumer configurations

6
docs/eventing/channels/channels-crds.md
View File

@ -13,10 +13,8 @@ procedure:
This is a non-exhaustive list of the available Channels for Knative Eventing.
Notes:
* Inclusion in this list is not an endorsement, nor does it imply any level of
support.
!!! note
Inclusion in this list is not an endorsement, nor does it imply any level of support.
Name | Status | Support | Description
--- | --- | --- | ---

4
docs/eventing/configuration/channel-configuration.md
View File

@ -27,7 +27,7 @@ data:
By changing the `data.default-ch-config` property we can define the clusterDefaults and per Namespace defaults.
This configuration is used by the Channel custom resource definition (CRD) to create platform specific implementations.
This configuration is used by the Channel custom resource definition (CRD) to create platform specific implementations.
!!! note
The `clusterDefault` setting determines the global, cluster-wide default Channel type. You can configure Channel defaults for individual namespaces by using the `namespaceDefaults` setting.
The `clusterDefault` setting determines the global, cluster-wide default Channel type. You can configure Channel defaults for individual namespaces by using the `namespaceDefaults` setting.

3
docs/eventing/flows/sequence/sequence-with-broker-trigger/README.md
View File

@ -11,7 +11,8 @@ into the Broker and create another Trigger which will then display those events.
- Knative Serving
- `InMemoryChannel`
**NOTE:** The examples use the `default` namespace.
!!! note
The examples use the `default` namespace.
If you want to use different type of `Channel`, you will have to modify the
`Sequence.Spec.ChannelTemplate` to create the appropriate Channel resources.

9
docs/eventing/sources/apache-camel-source/README.md
View File

@ -1,12 +1,3 @@
---
title: "Apache Camel source"
linkTitle: "Camel source"
weight: 100
type: "docs"
aliases:
- /docs/eventing/samples/apache-camel-source
---
# Apache Camel source
Apache Camel based sources are now provided via [Kamelets](https://camel.apache.org/camel-kamelets/latest/) as part of the [Apache Camel K](https://camel.apache.org/camel-k/latest/installation/installation.html) project. Kamelets are a new technology that allow anyone to pick and use event sources and sinks from a [catalog](https://camel.apache.org/camel-kamelets/latest/), without having to dig into the internal details of Apache Camel.

4
docs/eventing/sugar/README.md
View File

@ -104,8 +104,8 @@ spec:
EOF
```
> _Note_: If the named Broker already exists, the Sugar controller will do
> nothing, and the Trigger will not own the existing Broker.
!!! note
If the named Broker already exists, the Sugar controller does nothing, and the Trigger will not own the existing Broker.
This will make a Broker called "sugar" in the Namespace "hello", and attempt to
send events to the "event-display" service.

3
docs/install/client/README.md
View File

@ -12,7 +12,8 @@ See [Install and Set Up `kubectl`](https://kubernetes.io/docs/tasks/tools/instal
`kn` provides a quick and easy interface for creating Knative resources such as services and event sources, without the need to create or modify YAML files directly. `kn` also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting.
**NOTE:** `kn` cannot be used to install Knative components such as Serving or Eventing.
!!! note
`kn` cannot be used to install Knative components such as Serving or Eventing.
See [Installing `kn`](install-kn.md).

7
docs/install/operator/configuring-eventing-cr.md
View File

@ -48,7 +48,7 @@ The `spec.config` in the KnativeEventing CR has one `<name>` entry for each Conf
### Setting a default channel
If you are using different channel implementations, like the KafkaChannel, or you want a specific configuration of the InMemoryChannel to be the default configuration, you can change the default behavior by updating the `default-ch-webhook` ConfigMap.
If you are using different channel implementations, like the KafkaChannel, or you want a specific configuration of the InMemoryChannel to be the default configuration, you can change the default behavior by updating the `default-ch-webhook` ConfigMap.
You can do this by modifying the KnativeEventing CR:
@ -79,11 +79,12 @@ spec:
retry: 5
```
**NOTE:** The `clusterDefault` setting determines the global, cluster-wide default channel type. You can configure channel defaults for individual namespaces by using the `namespaceDefaults` setting.
!!! note
The `clusterDefault` setting determines the global, cluster-wide default channel type. You can configure channel defaults for individual namespaces by using the `namespaceDefaults` setting.
### Setting the default channel for the broker
If you are using a channel-based broker, you can change the default channel type for the broker from InMemoryChannel to KafkaChannel, by updating the `config-br-default-channel` ConfigMap.
If you are using a channel-based broker, you can change the default channel type for the broker from InMemoryChannel to KafkaChannel, by updating the `config-br-default-channel` ConfigMap.
You can do this by modifying the KnativeEventing CR:

6
docs/install/serving/installing-istio.md
View File

@ -1,9 +1,3 @@
---
title: "Installing Istio for Knative"
weight: 15
type: "docs"
---
# Installing Istio for Knative
This guide walks you through manually installing and customizing Istio for use

3
docs/serving/autoscaling/scale-bounds.md
View File

@ -15,7 +15,8 @@ Knative will attempt to never have less than this number of replicas at any one
* **Possible values:** integer
* **Default:** `0` if scale-to-zero is enabled and class KPA is used, `1` otherwise
**NOTE:** For more information about scale-to-zero configuration, see the documentation on [Configuring scale to zero](scale-to-zero.md).
!!! note
For more information about scale-to-zero configuration, see the documentation on [Configuring scale to zero](scale-to-zero.md).
**Example:**

46
docs/serving/configuration/config-defaults.md
View File

@ -43,7 +43,6 @@ none is specified.
**Default**: `"300"` (5 minutes)
**Example:**
```yaml
apiVersion: v1
@ -53,7 +52,6 @@ metadata:
namespace: knative-serving
data:
revision-timeout-seconds: "300" # 5 minutes
```
### Max Revision Timeout Seconds
@ -71,7 +69,6 @@ should also be increased to prevent in-flight requests being disrupted.
**Default**: `"600"` (10 minutes)
**Example:**
```yaml
apiVersion: v1
@ -81,7 +78,6 @@ metadata:
namespace: knative-serving
data:
max-revision-timeout-seconds: "600" # 10 minutes
```
### Revision Cpu Request
@ -97,7 +93,6 @@ By default, it is not set by Knative.
**Default**: `"400m"` (0.4 of a CPU (aka 400 milli-CPU))
**Example:**
```yaml
apiVersion: v1
@ -107,7 +102,6 @@ metadata:
namespace: knative-serving
data:
revision-cpu-request: "400m" # 0.4 of a CPU (aka 400 milli-CPU)
```
### Revision Memory Request
@ -123,7 +117,6 @@ By default, it is not set by Knative.
**Default**: `"100M"` (100 megabytes of memory)
**Example:**
```yaml
apiVersion: v1
@ -133,7 +126,6 @@ metadata:
namespace: knative-serving
data:
revision-memory-request: "100M" # 100 megabytes of memory
```
### Revision Ephemeral Storage Request
@ -147,7 +139,6 @@ specified and the system default is used.
**Default**: `"500M"` (500 megabytes of storage)
**Example:**
```yaml
apiVersion: v1
@ -157,7 +148,6 @@ metadata:
namespace: knative-serving
data:
revision-ephemeral-storage-request: "500M" # 500 megabytes of storage
```
### Revision Cpu Limit
@ -173,7 +163,6 @@ By default, it is not set by Knative.
**Default**: `"1000m"` (1 CPU (aka 1000 milli-CPU))
**Example:**
```yaml
apiVersion: v1
@ -183,7 +172,6 @@ metadata:
namespace: knative-serving
data:
revision-cpu-limit: "1000m" # 1 CPU (aka 1000 milli-CPU)
```
### Revision Memory Limit
@ -199,7 +187,6 @@ By default, it is not set by Knative.
**Default**: `"200M"` (200 megabytes of memory)
**Example:**
```yaml
apiVersion: v1
@ -209,7 +196,6 @@ metadata:
namespace: knative-serving
data:
revision-memory-limit: "200M" # 200 megabytes of memory
```
### Revision Ephemeral Storage Limit
@ -223,7 +209,6 @@ specified and the system default is used.
**Default**: `"750M"` (750 megabytes of storage)
**Example:**
```yaml
apiVersion: v1
@ -233,7 +218,6 @@ metadata:
namespace: knative-serving
data:
revision-ephemeral-storage-limit: "750M" # 750 megabytes of storage
```
### Container Name Template
@ -249,7 +233,6 @@ enclosing Service or Configuration, so values such as
**Default**: `"user-container"`
**Example:**
```yaml
apiVersion: v1
@ -259,7 +242,6 @@ metadata:
namespace: knative-serving
data:
container-name-template: "user-container"
```
### Container Concurrency
@ -275,7 +257,6 @@ the pod receives.
**Default**: `"0"`
**Example:**
```yaml
apiVersion: v1
@ -285,11 +266,12 @@ metadata:
namespace: knative-serving
data:
container-concurrency: "0"
```
### Container Concurrency Max Limit
{% raw %}
The container concurrency max limit is an operator setting ensuring that
the individual revisions cannot have arbitrary large concurrency
values, or autoscaling targets. `container-concurrency` default setting
@ -297,16 +279,15 @@ must be at or below this value.
Must be greater than 1.
Note: even with this set, a user can choose a containerConcurrency
of 0 (i.e. unbounded) unless allow-container-concurrency-zero is
set to "false".
!!! note
Even with this set, a user can choose a `containerConcurrency` value of 0 (unbounded) unless `allow-container-concurrency-zero` is set to "false".
{% endraw %}
**Key**: `container-concurrency-max-limit`
**Default**: `"1000"`
**Example:**
```yaml
apiVersion: v1
@ -316,7 +297,6 @@ metadata:
namespace: knative-serving
data:
container-concurrency-max-limit: "1000"
```
### Allow Container Concurrency Zero
@ -329,7 +309,6 @@ specify 0 (i.e. unbounded) for containerConcurrency.
**Default**: `"true"`
**Example:**
```yaml
apiVersion: v1
@ -339,27 +318,24 @@ metadata:
namespace: knative-serving
data:
allow-container-concurrency-zero: "true"
```
### Enable Service Links
{% raw %}
enable-service-links specifies the default value used for the
enableServiceLinks field of the PodSpec, when it is omitted by the user.
See [the Kubernetes Documentation for the enableServiceLinks Feature](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service).
enable-service-links specifies the default value used for the enableServiceLinks field of the PodSpec, when it is omitted by the user. See [the Kubernetes Documentation for the enableServiceLinks Feature](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service).
This is a tri-state flag with possible values of (true|false|default).
In environments with large number of services it is suggested
to set this value to `false`.
See [serving#8498](https://github.com/knative/serving/issues/8498).
In environments with large number of services it is suggested to set this value to `false`. See [serving#8498](https://github.com/knative/serving/issues/8498).
{% endraw %}
**Key**: `enable-service-links`
**Default**: `"false"`
**Example:**
```yaml
apiVersion: v1
@ -369,6 +345,4 @@ metadata:
namespace: knative-serving
data:
enable-service-links: "false"
```

4
docs/serving/load-balancing/README.md
View File

@ -1,8 +1,6 @@
# Load balancing
You can turn on Knative load balancing, by placing the _Activator service_ in the request path to act as a load balancer.
**NOTE:** To do this, you must first ensure that individual pod addressability is enabled.
You can turn on Knative load balancing, by placing the _Activator service_ in the request path to act as a load balancer. To do this, you must first ensure that individual pod addressability is enabled.
## Activator pod selection

6
docs/serving/troubleshooting/debugging-application-issues.md
View File

@ -129,10 +129,8 @@ If you see this condition, check the following to continue debugging:
- [Check Pod status](#check-pod-status)
- [Check Istio routing](#check-ingressistio-routing)
If you see other conditions, look up the meaning of the conditions in Knative
[Error Conditions and Reporting](https://github.com/knative/serving/blob/main/docs/spec/errors.md).
Note: some of them are not implemented yet. An alternative is to
[check Pod status](#check-pod-status).
!!! tip
If you see other conditions, you can look up the meaning of the conditions in Knative [Error Conditions and Reporting](https://github.com/knative/serving/blob/main/docs/spec/errors.md). An alternative is to [check Pod status](#check-pod-status).
## Check Pod status

8
docs/serving/using-auto-tls.md
View File

@ -291,8 +291,8 @@ requests are handled:
...
```
**Note:**
When using HTTP-01 challenge, `http-protocol` field has to be set to `Enabled` to make sure HTTP-01 challenge requests can be accepted by the cluster.
!!! note
When using HTTP-01 challenge, `http-protocol` field has to be set to `Enabled` to make sure HTTP-01 challenge requests can be accepted by the cluster.
1. Ensure that the file was updated successfully:
@ -311,8 +311,8 @@ be able to handle HTTPS traffic.
kubectl apply -f https://raw.githubusercontent.com/knative/docs/main/docs/serving/autoscaling/autoscale-go/service.yaml
```
1. When the certificate is provisioned (which could take up to several minutes depending on
the challenge type), you should see something like:
1. When the certificate is provisioned (which could take up to several minutes depending on the challenge type), you should see something like:
```
NAME URL LATESTCREATED LATESTREADY READY REASON
autoscale-go https://autoscale-go.default.{custom-domain} autoscale-go-6jf85 autoscale-go-6jf85 True

3
docs/snippets/install-kn.md
View File

@ -7,7 +7,8 @@
brew install kn
```
Note: Quickstart requires `kn` version 0.25 or later. To upgrade an existing install to the latest version, run `brew upgrade kn`.
!!! note
Quickstart requires `kn` version 0.25 or later. To upgrade an existing install to the latest version, run `brew upgrade kn`.
=== "Using a binary"