mirror of https://github.com/knative/docs.git
Installation Doc Updates (#6395)
* Installation Doc Updates Improve installation guidance * Formatting fix * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * link fix and table update More writing * Update README.md Misc edits * Update README.md Minor edits * Adding install-kn to PR Consolidating CLI installations into this this topic. * Update install-kn.md Changing red bug alert to important The old syntax was: ??? bug "Having issues upgrading `kn` to Homebrew?" * Update install-kn (snippet) Removed alert formatting * Added quickstart-install.md Various edits * Fixes and reviewed edits Made Evan suggestions, table column test, spelling fixes * Update quickstart-install.md link fix * Update README.md Replaced the table with a bulleted list approach. * Update README.md Put back the table * Added serving and eventing install topics Updated topics per effort - consolidating guidance * Link fixes * Made Evan's edits * Various updates All files added for this PR. * Link fix * Formatting fixes * Formatting and consistency fix * Update docs/install/operator/knative-with-operator-cli.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/client/install-kn.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> --------- Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>
This commit is contained in:
Bruce Hamilton
Evan Anderson
parent
3bc14fb91c
commit
7872b0e943
|
|
@ -51,8 +51,8 @@ nav:
|
|||
###############################################################################
|
||||
- Installing:
|
||||
- About installing Knative: install/README.md
|
||||
- Install the Knative CLI: client/install-kn.md
|
||||
- Install Knative using quickstart: install/quickstart-install.md
|
||||
- Install CLI Tools: client/install-kn.md
|
||||
- Install quickstart: install/quickstart-install.md
|
||||
# YAML Installation
|
||||
- Install Knative with YAML:
|
||||
- About YAML-based installation: install/yaml-install/README.md
|
||||
|
|
|
|||
|
|
@ -7,18 +7,27 @@ components:
|
|||
function: how-to
|
||||
---
|
||||
|
||||
# Installing the Knative CLI
|
||||
# Installing CLI Tools
|
||||
|
||||
This guide provides details about how you can install the Knative `kn` CLI.
|
||||
There are three CLI tools available for managing Knative:
|
||||
|
||||
- Kubernetes CLI - `kubectl`
|
||||
- Knative CLI - `kn`
|
||||
- Knative Operator CLI - `kn`
|
||||
|
||||
The `kn` CLI makes Knative operations easier, but all functionality is available in `kubectl` CLI provided you want to primarily use YAML representations of resources.
|
||||
|
||||
## Install Kubernetes CLI
|
||||
|
||||
Install the [Kubernetes CLI (`kubectl`)](https://kubernetes.io/docs/tasks/tools/install-kubectl){target=_blank} to run commands against Kubernetes clusters. You can use `kubectl` to deploy applications, inspect and manage cluster resources, and view logs.
|
||||
|
||||
--8<-- "security-prereqs-binaries.md"
|
||||
--8<-- "install-kn.md"
|
||||
|
||||
## Install kn using the nightly-built binary
|
||||
### Install kn using the nightly-built binary
|
||||
|
||||
!!! warning
|
||||
Nightly container images include features which may not be included in the latest Knative release and are not considered to be stable.
|
||||
|
||||
|
||||
Nightly-built executable binaries are available for users who want to install the latest pre-release build of `kn`.
|
||||
|
||||
Links to the latest nightly-built executable binaries are available here:
|
||||
|
|
@ -27,6 +36,59 @@ Links to the latest nightly-built executable binaries are available here:
|
|||
- [Linux](https://storage.googleapis.com/knative-nightly/client/latest/kn-linux-amd64){target=_blank}
|
||||
- [Windows](https://storage.googleapis.com/knative-nightly/client/latest/kn-windows-amd64.exe){target=_blank}
|
||||
|
||||
## Using kn with Tekton
|
||||
### Using kn with Tekton
|
||||
|
||||
See the [Tekton documentation](http://hub.tekton.dev/tekton/task/kn){target=_blank}.
|
||||
|
||||
## Install the Knative Operator CLI Plugin
|
||||
|
||||
Before you install the Knative Operator CLI Plugin, first install the Knative CLI described earlier.
|
||||
|
||||
=== "MacOS"
|
||||
|
||||
1. Download the binary `kn-operator-darwin-amd64` for your system from the [release page](https://github.com/knative-extensions/kn-plugin-operator/releases/tag/knative-v1.7.1).
|
||||
|
||||
1. Rename the binary to `kn-operator`:
|
||||
|
||||
```bash
|
||||
mv kn-operator-darwin-amd64 kn-operator
|
||||
```
|
||||
|
||||
=== "Linux"
|
||||
|
||||
1. Download the binary `kn-operator-linux-amd64` for your system from the [release page](https://github.com/knative-extensions/kn-plugin-operator/releases/tag/knative-v1.7.1).
|
||||
|
||||
1. Rename the binary to `kn-operator`:
|
||||
|
||||
```bash
|
||||
mv kn-operator-linux-amd64 kn-operator
|
||||
```
|
||||
|
||||
Make the plugin executable by running the command:
|
||||
|
||||
```bash
|
||||
chmod +x kn-operator
|
||||
```
|
||||
|
||||
Create the directory for the `kn` plugin:
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.config/kn/plugins
|
||||
```
|
||||
|
||||
Move the file to a plugin directory for `kn`:
|
||||
|
||||
```bash
|
||||
cp kn-operator ~/.config/kn/plugins
|
||||
```
|
||||
|
||||
### Verify the installation of the Knative Operator CLI Plugin
|
||||
|
||||
You can run the following command to verify the installation:
|
||||
|
||||
```bash
|
||||
kn operator -h
|
||||
```
|
||||
|
||||
You should see more information about how to use this CLI plugin.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,26 +8,58 @@ function: reference
|
|||
|
||||
# Installing Knative
|
||||
|
||||
!!! note
|
||||
Please also take a look at the [Serving Architecture](../serving/architecture.md), which explains the Knative components and the general networking concept.
|
||||
There are three installation methods to install Knative:
|
||||
|
||||
You can install the Serving component, Eventing component, or both on your
|
||||
cluster by using one of the following deployment options:
|
||||
- A quickstart experience on a local computer only by using a preconfigured extension.
|
||||
- A YAML installation suitable for production use.
|
||||
- A Knative Operator installation suitable for production use.
|
||||
|
||||
- Use the [Knative Quickstart plugin](quickstart-install.md) to install a
|
||||
preconfigured, local distribution of Knative for development purposes.
|
||||
A Knative installation is composed of the Serving and Eventing components. The quickstart implements both. The YAML and Knative Operator installations provide options to install either or both.
|
||||
|
||||
- Use a YAML-based installation to install a production ready deployment:
|
||||
- [Install Knative Serving by using YAML](yaml-install/serving/install-serving-with-yaml.md)
|
||||
- [Install Knative Eventing by using YAML](yaml-install/eventing/install-eventing-with-yaml.md)
|
||||
Supported platforms are Linux, MacOS, and Windows.
|
||||
|
||||
- Use the [Knative Operator](operator/knative-with-operators.md) to install and
|
||||
configure a production-ready deployment.
|
||||
## Installation roadmap
|
||||
|
||||
- Follow the documentation for vendor-managed [Knative offerings](knative-offerings.md).
|
||||
Use the following table to evaluate your installation method.
|
||||
|
||||
You can also [upgrade an existing Knative installation](upgrade/README.md).
|
||||
| | Quickstart | YAML | Knative Operator |
|
||||
| --- | --- | --- | --- |
|
||||
| Purpose | local | production | production |
|
||||
| Kubernetes | local deployment of kind or Minikube | existing deployment | existing deployment |
|
||||
| Hardware | 3 CPU, 3 GB RAM | One node: 6 CPUs, 6 GB memory, 30 GB disk storage.<br>Multiple nodes: 2 CPUs each, 4 GB memory, 20 GB disk storage. | same as YAML |
|
||||
|
||||
!!! note
|
||||
Knative installation instructions assume you are running Mac or Linux with a Bash shell.
|
||||
<!-- TODO: Link to provisioning guide for advanced installation -->
|
||||
Use the following steps to install Knative depending on your installation method.
|
||||
|
||||
**Quickstart**:
|
||||
|
||||
1. Install the [CLI Tools](../client/install-kn.md).
|
||||
1. Install the [Knative Quickstart plugin](quickstart-install.md).
|
||||
|
||||
**YAML**:
|
||||
|
||||
1. Install the [CLI Tools](../client/install-kn.md).
|
||||
1. Install either or both:
|
||||
- Install [Knative Serving](yaml-install/serving/install-serving-with-yaml.md).
|
||||
- Install [Knative Eventing](yaml-install/eventing/install-eventing-with-yaml.md).
|
||||
|
||||
**Operator**:
|
||||
|
||||
1. Install the [CLI Tools](../client/install-kn.md) including the Knative Operator CLI plugin.
|
||||
1. Install using the Knative Operator, and with it the Serving and Eventing components, by either of the following:
|
||||
- The [Knative Operator](./operator/knative-with-operators.md) using K8S Manifests or via Helm.
|
||||
- The [Knative Operator CLI](./operator/knative-with-operator-cli.md).
|
||||
|
||||
All installations require a supported Kubernetes version.
|
||||
|
||||
System requirements provided are recommendations only. The requirements for your installation m may, depending on whether you use optional components, such as a networking layer.
|
||||
|
||||
For a list of commercial Knative products, see [Knative offerings](knative-offerings.md).
|
||||
|
||||
## Installation resources
|
||||
|
||||
Use the following links to maintain your installations.
|
||||
|
||||
- [Upgrading Knative](upgrade/README.md)
|
||||
- [Uninstall Knative](uninstall.md)
|
||||
- [Check Knative version](upgrade/check-install-version.md)
|
||||
- [Troubleshoot Knative installations](troubleshooting.md)
|
||||
|
|
|
|||
|
|
@ -8,64 +8,22 @@ function: how-to
|
|||
|
||||
# Install by using the Knative Operator CLI Plugin
|
||||
|
||||
Knative provides a CLI Plugin to install, configure and manage Knative via the command lines. This CLI plugin facilitates
|
||||
you with a parameter-driven way to configure the Knative cluster, without interacting with the complexities of the custom
|
||||
resources.
|
||||
Knative provides the Operator CLI Plugin to install, configure and manage Knative on the command line. This plugin helps you configure the Knative cluster, without interacting with the complexities of the custom resources.
|
||||
|
||||
--8<-- "prerequisites.md"
|
||||
--8<-- "security-prereqs-binaries.md"
|
||||
This topic describes how to install the Knative Operator and the Serving and Eventing components using a CLI.
|
||||
|
||||
## Install the Knative Operator CLI Plugin
|
||||
This installation requires the following prerequisites:
|
||||
|
||||
Before you install the Knative Operator CLI Plugin, first install the [Knative CLI](../../client/install-kn.md).
|
||||
- The [CLI Tools](../../client/install-kn.md) are installed.
|
||||
- Sufficient hardware:
|
||||
|
||||
=== "MacOS"
|
||||
One node requires at least 6 CPUs, 6 GB of memory, and 30 GB of disk storage.
|
||||
|
||||
1. Download the binary `kn-operator-darwin-amd64` for your system from the [release page](https://github.com/knative-extensions/kn-plugin-operator/releases/tag/knative-v1.7.1).
|
||||
Multiple nodes require 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
|
||||
|
||||
1. Rename the binary to `kn-operator`:
|
||||
- The existing Kubernetes is running a supported version.
|
||||
|
||||
```bash
|
||||
mv kn-operator-darwin-amd64 kn-operator
|
||||
```
|
||||
|
||||
=== "Linux"
|
||||
|
||||
1. Download the binary `kn-operator-linux-amd64` for your system from the [release page](https://github.com/knative-extensions/kn-plugin-operator/releases/tag/knative-v1.7.1).
|
||||
|
||||
1. Rename the binary to `kn-operator`:
|
||||
|
||||
```bash
|
||||
mv kn-operator-linux-amd64 kn-operator
|
||||
```
|
||||
|
||||
Make the plugin executable by running the command:
|
||||
|
||||
```bash
|
||||
chmod +x kn-operator
|
||||
```
|
||||
|
||||
Create the directory for the `kn` plugin:
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.config/kn/plugins
|
||||
```
|
||||
|
||||
Move the file to a plugin directory for `kn`:
|
||||
|
||||
```bash
|
||||
cp kn-operator ~/.config/kn/plugins
|
||||
```
|
||||
|
||||
## Verify the installation of the Knative Operator CLI Plugin
|
||||
|
||||
You can run the following command to verify the installation:
|
||||
|
||||
```bash
|
||||
kn operator -h
|
||||
```
|
||||
|
||||
You should see more information about how to use this CLI plugin.
|
||||
For information on other Knative installs, see the [Installation Roadmap](../README.md#installation-roadmap).
|
||||
|
||||
## Install the Knative Operator
|
||||
|
||||
|
|
@ -90,7 +48,7 @@ To install Knative Operator of a specific version, e.g. 1.7.1, run:
|
|||
kn operator install -v 1.7.1
|
||||
```
|
||||
|
||||
## Installing the Knative Serving component
|
||||
## Install the Knative Serving component
|
||||
|
||||
You can install Knative Serving of any specific version under any specific namespace. By default, the namespace is `knative-serving`,
|
||||
and the version is the latest.
|
||||
|
|
@ -165,7 +123,7 @@ you can configure Knative Serving with different ingresses:
|
|||
kn operator enable ingress --contour -n knative-serving
|
||||
```
|
||||
|
||||
## Installing the Knative Eventing component
|
||||
## Install the Knative Eventing component
|
||||
|
||||
You can install Knative Eventing of any specific version under any specific namespace. By default, the namespace is `knative-eventing`,
|
||||
and the version is the latest.
|
||||
|
|
@ -188,7 +146,7 @@ To install Knative Operator of a specific version, e.g. 1.7, run:
|
|||
kn operator install --component eventing -n knative-eventing -v "1.7"
|
||||
```
|
||||
|
||||
### Installing Knative Eventing with event sources
|
||||
### Install Knative Eventing with event sources
|
||||
|
||||
Knative Operator can configure the Knative Eventing component with different event sources.
|
||||
Click on each of the following tabs to
|
||||
|
|
|
|||
|
|
@ -8,17 +8,22 @@ function: how-to
|
|||
|
||||
# Install by using the Knative Operator
|
||||
|
||||
Knative provides a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to install, configure and manage Knative.
|
||||
You can install the Serving component, Eventing component, or both on your cluster.
|
||||
Knative provides the [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to install, configure and manage Knative. You can install the Serving component, Eventing component, or both on your cluster.
|
||||
|
||||
The following table describes the supported versions of Serving and Eventing for the Knative Operator:
|
||||
This topic describes how to install the Knative Operator and the Serving and Eventing components using manifests and other resources. To install the Operator and the components using a CLI, see [Knative Operator CLI](knative-with-operator-cli.md).
|
||||
|
||||
| Operator | Serving | Eventing |
|
||||
|----------|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| v1.19 | v1.19.0<br/>v1.18.0 and v1.18.1<br/>v1.17.0, v1.17.1 and v1.17.2<br/>v1.16.0, v1.16.1, v1.16.2 and v1.16.3 | v1.19.0<br/>v1.18.0, v1.18.1 and v1.18.2<br/>v1.17.0, v1.17.1, v1.17.2, v1.17.3, v1.17.4, v1.17.5 and v1.17.6<br/>v1.16.0, v1.16.1, v1.16.2, v1.16.3, v1.16.4, v1.16.5, v1.16.6 and v1.16.7 |
|
||||
This installation requires the following prerequisites:
|
||||
|
||||
--8<-- "prerequisites.md"
|
||||
{% include "security-prereqs-images.md" %}
|
||||
- The [CLI Tools](../../client/install-kn.md) are installed.
|
||||
- Sufficient hardware:
|
||||
|
||||
One node requires at least 6 CPUs, 6 GB of memory, and 30 GB of disk storage.
|
||||
|
||||
Multiple nodes require 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
|
||||
|
||||
- The existing Kubernetes is running a supported version.
|
||||
|
||||
For information on other Knative installs, see the [Installation Roadmap](../README.md#installation-roadmap).
|
||||
|
||||
## Install the Knative Operator
|
||||
|
||||
|
|
@ -677,6 +682,14 @@ for the source:
|
|||
ko delete -f config/
|
||||
```
|
||||
|
||||
## Supported versions
|
||||
|
||||
The following table describes the supported versions of Serving and Eventing for the Knative Operator:
|
||||
|
||||
| Operator | Serving | Eventing |
|
||||
|----------|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| v1.19 | v1.19.0<br/>v1.18.0 and v1.18.1<br/>v1.17.0, v1.17.1 and v1.17.2<br/>v1.16.0, v1.16.1, v1.16.2 and v1.16.3 | v1.19.0<br/>v1.18.0, v1.18.1 and v1.18.2<br/>v1.17.0, v1.17.1, v1.17.2, v1.17.3, v1.17.4, v1.17.5 and v1.17.6<br/>v1.16.0, v1.16.1, v1.16.2, v1.16.3, v1.16.4, v1.16.5, v1.16.6 and v1.16.7 |
|
||||
|
||||
## What's next
|
||||
|
||||
- [Configure Knative Serving using Operator](configuring-serving-cr.md)
|
||||
|
|
|
|||
|
|
@ -6,12 +6,19 @@ components:
|
|||
function: tutorial
|
||||
---
|
||||
|
||||
# Install Knative using quickstart
|
||||
# Install the Knative quickstart plugin
|
||||
|
||||
Following this quickstart tutorial provides you with a simplified, local Knative installation by using the Knative `quickstart` plugin.
|
||||
This quickstart plugin provides a simplified Knative installation on a kind or Minikube Kubernetes cluster running locally on a single computer. This installation is well suited for experimentation.
|
||||
|
||||
This installation requires the following prerequisites:
|
||||
|
||||
- The [CLI Tools](../client/install-kn.md) are installed.
|
||||
- Sufficient hardware:
|
||||
|
||||
6 CPUs, 6 GB of memory, and 30 GB of disk storage.
|
||||
|
||||
For information on production installs, see the [Installation Roadmap](README.md#installation-roadmap).
|
||||
|
||||
--8<-- "quickstart-prereqs.md"
|
||||
--8<-- "install-kn.md"
|
||||
--8<-- "quickstart-install.md"
|
||||
|
||||
## Next steps
|
||||
|
|
|
|||
|
|
@ -7,14 +7,22 @@ function: how-to
|
|||
|
||||
# Installing Knative Eventing using YAML files
|
||||
|
||||
This topic describes how to install Knative Eventing by applying YAML files using the `kubectl` CLI.
|
||||
This topic describes how to install Knative Eventing by applying YAML files. This installation requires the following prerequisites:
|
||||
|
||||
--8<-- "prerequisites.md"
|
||||
{% include "security-prereqs-images.md" %}
|
||||
- The [CLI Tools](../../../client/install-kn.md) are installed.
|
||||
- Sufficient hardware:
|
||||
|
||||
## Install Knative Eventing
|
||||
One node requires at least 6 CPUs, 6 GB of memory, and 30 GB of disk storage.
|
||||
|
||||
To install Knative Eventing:
|
||||
Multiple nodes require 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
|
||||
|
||||
- The existing Kubernetes is running a supported version.
|
||||
|
||||
For information on other Knative installs, see the [Installation Roadmap](../../README.md#installation-roadmap).
|
||||
|
||||
## Install the Knative Eventing component
|
||||
|
||||
To install the Knative Eventing component:
|
||||
|
||||
1. Install the required custom resource definitions (CRDs) by running the command:
|
||||
|
||||
|
|
|
|||
|
|
@ -7,10 +7,18 @@ function: how-to
|
|||
|
||||
# Installing Knative Serving using YAML files
|
||||
|
||||
This topic describes how to install Knative Serving by applying YAML files using the `kubectl` CLI.
|
||||
This topic describes how to install Knative Serving by applying YAML files. This installation requires the following prerequisites:
|
||||
|
||||
--8<-- "prerequisites.md"
|
||||
{% include "security-prereqs-images.md" %}
|
||||
- The [CLI Tools](../../../client/install-kn.md) are installed.
|
||||
- Sufficient hardware:
|
||||
|
||||
One node requires at least 6 CPUs, 6 GB of memory, and 30 GB of disk storage.
|
||||
|
||||
Multiple nodes require 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
|
||||
|
||||
- The existing Kubernetes is running a supported version.
|
||||
|
||||
For information on other Knative installs, see the [Installation Roadmap](../../README.md#installation-roadmap).
|
||||
|
||||
## Install the Knative Serving component
|
||||
|
||||
|
|
|
|||
|
|
@ -20,16 +20,6 @@ The `kn` CLI also simplifies completion of otherwise complex procedures such as
|
|||
brew install knative/client/kn
|
||||
```
|
||||
|
||||
??? bug "Having issues upgrading `kn` using Homebrew?"
|
||||
|
||||
If you are having issues upgrading using Homebrew, it might be due to a change to a CLI repository where the `master` branch was renamed to `main`. Resolve this issue by running the command:
|
||||
|
||||
```bash
|
||||
brew uninstall kn
|
||||
brew untap knative/client --force
|
||||
brew install knative/client/kn
|
||||
```
|
||||
|
||||
=== "Using a binary"
|
||||
|
||||
You can install `kn` by downloading the executable binary for your system and placing it in the system path.
|
||||
|
|
|
|||
Loading…
Reference in New Issue