Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/client/install-kn.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ aliases:

This guide provides details about how you can set up the Knative `kn` CLI.

## Install kn using brew

For macOS, you can install `kn` by using <a href="https://github.com/knative/homebrew-client" target="_blank">Homebrew</a>.

```
brew install kn
```


## Install kn using a binary

You can install `kn` by downloading the executable binary for your system and placing it in the system path.
Expand Down Expand Up @@ -47,10 +56,6 @@ Links to the latest nightly-built executable binaries are available here:
kn version
```

## Install kn using brew

For macOs, you can install `kn` by using <a href="https://github.com/knative/homebrew-client" target="_blank">brew</a>.

## Running kn using container images

**WARNING:** Nightly container images include features which may not be included in the latest Knative release and are not considered to be stable.
Expand Down
4 changes: 1 addition & 3 deletions docs/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ showlandingtoc: "false"

You can install the Serving component, Eventing component, or both on your cluster by using one of the following deployment options:

- Using a YAML-based installation:
- [Installing Serving using YAML files](./install-serving-with-yaml)
- [Installing Eventing using YAML files](./install-eventing-with-yaml)
- Using a [YAML-based installation](./prerequisites.md)
- Using the [Knative Operator](./knative-with-operators).
- Following the documentation for vendor managed [Knative offerings](../knative-offerings).

Expand Down
11 changes: 8 additions & 3 deletions docs/install/install-eventing-with-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ To install the Eventing component:
kubectl apply -f {{< artifact repo="eventing" file="eventing-core.yaml" >}}
```

For information about the YAML files in the Knative Serving and Eventing releases, see
[Installation files](./installation-files.md).


## Verify the installation

Expand Down Expand Up @@ -218,6 +221,8 @@ data:

After installing Knative Eventing:

- If you want to add extra features to your installation, see [Installing optional extensions](./install-extensions.md).
- If you want to install the Knative Serving component, see [Installing Serving using YAML files](./install-serving-with-yaml.md)
- Install the [Knative CLI](./install-kn) to use `kn` commands.
- To easily interact with Knative Eventing Components, [download the `kn` CLI](/docs/client/install-kn.md)

- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md)

- [Installing Knative Serving using YAML files](./install-serving-with-yaml.md)
6 changes: 5 additions & 1 deletion docs/install/install-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For information about the YAML files in the Knative Serving and Eventing release

Before you install any optional extensions, you must install Knative Serving or Eventing.
See [Installing Serving using YAML files](./install-serving-with-yaml.md)
and [Installing Eventing using YAML files](./install/install-eventing-with-yaml.md).
and [Installing Eventing using YAML files](./install-eventing-with-yaml.md).


## Install optional Serving extensions
Expand Down Expand Up @@ -276,3 +276,7 @@ To learn more about the VMware sources and bindings, try
{{< /tab >}}

{{< /tabs >}}

## Next steps

- To easily interact with Knative Services and Eventing Components, [download the `kn` CLI](/docs/client/install-kn.md)
12 changes: 8 additions & 4 deletions docs/install/install-serving-with-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@ To install the serving component:
kubectl apply -f {{< artifact repo="serving" file="serving-crds.yaml" >}}
```

1. Install the core components of Serving:
1. Install the core components of Knative Serving:

```bash
kubectl apply -f {{< artifact repo="serving" file="serving-core.yaml" >}}
```
For information about the YAML files in the Knative Serving and Eventing releases, see
[Installation files](./installation-files.md).


## Install a networking layer
Expand Down Expand Up @@ -373,6 +375,8 @@ Refer to the "Real DNS" method for a permanent solution.

After installing Knative Serving:

- If you want to add extra features to your installation, see [Installing optional extensions](./install-extensions.md).
- If you want to install the Knative Eventing component, see [Installing Eventing using YAML files](./install-eventing-with-yaml.md)
- Install the [Knative CLI](./install-kn) to use `kn` commands.
- [Installing Knative Eventing using YAML files](./install-eventing-with-yaml.md)

- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).

- To easily interact with Knative Services, [download the `kn` CLI](/docs/client/install-kn.md)
13 changes: 10 additions & 3 deletions docs/install/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Before installing Knative, you must meet the following prerequisites:

## System requirements

For prototyping purposes, Knative will work on most local deployments of Kubernetes.
**For prototyping purposes**, Knative will work on most local deployments of Kubernetes.
For example, you can use a local, one-node cluster that has 2 CPU and 4GB of memory.

For production purposes, it is recommended that:
**For production purposes**, it is recommended that:
- If you have only one node in your cluster, you will need at least 6 CPUs, 6 GB of memory, and 30 GB of disk storage.
- If you have multiple nodes in your cluster, for each node you will need at least 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
<!--TODO: Verify these requirements-->
Expand All @@ -26,4 +26,11 @@ Before installation, you must meet the following prerequisites:

- You have a cluster that uses Kubernetes v1.18 or newer.
- You have installed the [`kubectl` CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
- Your Kubernetes cluster must have access to the internet, since Kubernetes needs to be able to fetch images.
- Your Kubernetes cluster must have access to the internet, since Kubernetes needs to be able to fetch images. (To pull from a private registry, see [Deploying images from a private container registry](https://knative.dev/docs/serving/deploying/private-registry/))

## Install Knative Serving and Eventing

You can install the Serving component, Eventing component, or both on your cluster. If you're planning on installing both, **we recommend starting with Knative Serving.**

- [Installing Knative Serving using YAML files](./install-serving-with-yaml)
- [Installing Knative Eventing using YAML files](./install-eventing-with-yaml)