You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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>
Copy file name to clipboardExpand all lines: docs/client/install-kn.md
+68-6Lines changed: 68 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,18 +7,27 @@ components:
7
7
function: how-to
8
8
---
9
9
10
-
# Installing the Knative CLI
10
+
# Installing CLI Tools
11
11
12
-
This guide provides details about how you can install the Knative `kn` CLI.
12
+
There are three CLI tools available for managing Knative:
13
+
14
+
- Kubernetes CLI - `kubectl`
15
+
- Knative CLI - `kn`
16
+
- Knative Operator CLI - `kn`
17
+
18
+
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.
19
+
20
+
## Install Kubernetes CLI
21
+
22
+
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.
13
23
14
-
--8<-- "security-prereqs-binaries.md"
15
24
--8<-- "install-kn.md"
16
25
17
-
## Install kn using the nightly-built binary
26
+
### Install kn using the nightly-built binary
27
+
18
28
!!! warning
19
29
Nightly container images include features which may not be included in the latest Knative release and are not considered to be stable.
20
30
21
-
22
31
Nightly-built executable binaries are available for users who want to install the latest pre-release build of `kn`.
23
32
24
33
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:
See the [Tekton documentation](http://hub.tekton.dev/tekton/task/kn){target=_blank}.
42
+
43
+
## Install the Knative Operator CLI Plugin
44
+
45
+
Before you install the Knative Operator CLI Plugin, first install the Knative CLI described earlier.
46
+
47
+
=== "MacOS"
48
+
49
+
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).
50
+
51
+
1. Rename the binary to `kn-operator`:
52
+
53
+
```bash
54
+
mv kn-operator-darwin-amd64 kn-operator
55
+
```
56
+
57
+
=== "Linux"
58
+
59
+
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).
60
+
61
+
1. Rename the binary to `kn-operator`:
62
+
63
+
```bash
64
+
mv kn-operator-linux-amd64 kn-operator
65
+
```
66
+
67
+
Make the plugin executable by running the command:
68
+
69
+
```bash
70
+
chmod +x kn-operator
71
+
```
72
+
73
+
Create the directory for the `kn` plugin:
74
+
75
+
```bash
76
+
mkdir -p ~/.config/kn/plugins
77
+
```
78
+
79
+
Move the file to a plugin directory for `kn`:
80
+
81
+
```bash
82
+
cp kn-operator ~/.config/kn/plugins
83
+
```
84
+
85
+
### Verify the installation of the Knative Operator CLI Plugin
86
+
87
+
You can run the following command to verify the installation:
88
+
89
+
```bash
90
+
kn operator -h
91
+
```
92
+
93
+
You should see more information about how to use this CLI plugin.
Copy file name to clipboardExpand all lines: docs/install/README.md
+48-16Lines changed: 48 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,26 +8,58 @@ function: reference
8
8
9
9
# Installing Knative
10
10
11
-
!!! note
12
-
Please also take a look at the [Serving Architecture](../serving/architecture.md), which explains the Knative components and the general networking concept.
11
+
There are three installation methods to install Knative:
13
12
14
-
You can install the Serving component, Eventing component, or both on your
15
-
cluster by using one of the following deployment options:
13
+
- A quickstart experience on a local computer only by using a preconfigured extension.
14
+
- A YAML installation suitable for production use.
15
+
- A Knative Operator installation suitable for production use.
16
16
17
-
- Use the [Knative Quickstart plugin](quickstart-install.md) to install a
18
-
preconfigured, local distribution of Knative for development purposes.
17
+
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.
19
18
20
-
- Use a YAML-based installation to install a production ready deployment:
21
-
-[Install Knative Serving by using YAML](yaml-install/serving/install-serving-with-yaml.md)
22
-
-[Install Knative Eventing by using YAML](yaml-install/eventing/install-eventing-with-yaml.md)
19
+
Supported platforms are Linux, MacOS, and Windows.
23
20
24
-
- Use the [Knative Operator](operator/knative-with-operators.md) to install and
25
-
configure a production-ready deployment.
21
+
## Installation roadmap
26
22
27
-
- Follow the documentation for vendor-managed [Knative offerings](knative-offerings.md).
23
+
Use the following table to evaluate your installation method.
28
24
29
-
You can also [upgrade an existing Knative installation](upgrade/README.md).
25
+
|| Quickstart | YAML | Knative Operator |
26
+
| --- | --- | --- | --- |
27
+
| Purpose | local | production | production |
28
+
| Kubernetes | local deployment of kind or Minikube | existing deployment | existing deployment |
29
+
| 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 |
30
30
31
-
!!! note
32
-
Knative installation instructions assume you are running Mac or Linux with a Bash shell.
33
-
<!-- TODO: Link to provisioning guide for advanced installation -->
31
+
Use the following steps to install Knative depending on your installation method.
32
+
33
+
**Quickstart**:
34
+
35
+
1. Install the [CLI Tools](../client/install-kn.md).
36
+
1. Install the [Knative Quickstart plugin](quickstart-install.md).
37
+
38
+
**YAML**:
39
+
40
+
1. Install the [CLI Tools](../client/install-kn.md).
1. Install the [CLI Tools](../client/install-kn.md) including the Knative Operator CLI plugin.
48
+
1. Install using the Knative Operator, and with it the Serving and Eventing components, by either of the following:
49
+
- The [Knative Operator](./operator/knative-with-operators.md) using K8S Manifests or via Helm.
50
+
- The [Knative Operator CLI](./operator/knative-with-operator-cli.md).
51
+
52
+
All installations require a supported Kubernetes version.
53
+
54
+
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.
55
+
56
+
For a list of commercial Knative products, see [Knative offerings](knative-offerings.md).
57
+
58
+
## Installation resources
59
+
60
+
Use the following links to maintain your installations.
Copy file name to clipboardExpand all lines: docs/install/operator/knative-with-operator-cli.md
+12-54Lines changed: 12 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,64 +8,22 @@ function: how-to
8
8
9
9
# Install by using the Knative Operator CLI Plugin
10
10
11
-
Knative provides a CLI Plugin to install, configure and manage Knative via the command lines. This CLI plugin facilitates
12
-
you with a parameter-driven way to configure the Knative cluster, without interacting with the complexities of the custom
13
-
resources.
11
+
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.
14
12
15
-
--8<-- "prerequisites.md"
16
-
--8<-- "security-prereqs-binaries.md"
13
+
This topic describes how to install the Knative Operator and the Serving and Eventing components using a CLI.
17
14
18
-
## Install the Knative Operator CLI Plugin
15
+
This installation requires the following prerequisites:
19
16
20
-
Before you install the Knative Operator CLI Plugin, first install the [Knative CLI](../../client/install-kn.md).
17
+
- The [CLI Tools](../../client/install-kn.md) are installed.
18
+
- Sufficient hardware:
21
19
22
-
=== "MacOS"
20
+
One node requires at least 6 CPUs, 6 GB of memory, and 30 GB of disk storage.
23
21
24
-
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).
22
+
Multiple nodes require 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
25
23
26
-
1. Rename the binary to `kn-operator`:
24
+
- The existing Kubernetes is running a supported version.
27
25
28
-
```bash
29
-
mv kn-operator-darwin-amd64 kn-operator
30
-
```
31
-
32
-
=== "Linux"
33
-
34
-
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).
35
-
36
-
1. Rename the binary to `kn-operator`:
37
-
38
-
```bash
39
-
mv kn-operator-linux-amd64 kn-operator
40
-
```
41
-
42
-
Make the plugin executable by running the command:
43
-
44
-
```bash
45
-
chmod +x kn-operator
46
-
```
47
-
48
-
Create the directory for the `kn` plugin:
49
-
50
-
```bash
51
-
mkdir -p ~/.config/kn/plugins
52
-
```
53
-
54
-
Move the file to a plugin directory for `kn`:
55
-
56
-
```bash
57
-
cp kn-operator ~/.config/kn/plugins
58
-
```
59
-
60
-
## Verify the installation of the Knative Operator CLI Plugin
61
-
62
-
You can run the following command to verify the installation:
63
-
64
-
```bash
65
-
kn operator -h
66
-
```
67
-
68
-
You should see more information about how to use this CLI plugin.
26
+
For information on other Knative installs, see the [Installation Roadmap](../README.md#installation-roadmap).
69
27
70
28
## Install the Knative Operator
71
29
@@ -90,7 +48,7 @@ To install Knative Operator of a specific version, e.g. 1.7.1, run:
90
48
kn operator install -v 1.7.1
91
49
```
92
50
93
-
## Installing the Knative Serving component
51
+
## Install the Knative Serving component
94
52
95
53
You can install Knative Serving of any specific version under any specific namespace. By default, the namespace is `knative-serving`,
96
54
and the version is the latest.
@@ -165,7 +123,7 @@ you can configure Knative Serving with different ingresses:
Copy file name to clipboardExpand all lines: docs/install/operator/knative-with-operators.md
+21-8Lines changed: 21 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,22 @@ function: how-to
8
8
9
9
# Install by using the Knative Operator
10
10
11
-
Knative provides a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to install, configure and manage Knative.
12
-
You can install the Serving component, Eventing component, or both on your cluster.
11
+
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.
13
12
14
-
The following table describes the supported versions of Serving and Eventing for the Knative Operator:
13
+
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).
Copy file name to clipboardExpand all lines: docs/install/quickstart-install.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,19 @@ components:
6
6
function: tutorial
7
7
---
8
8
9
-
# Install Knative using quickstart
9
+
# Install the Knative quickstart plugin
10
10
11
-
Following this quickstart tutorial provides you with a simplified, local Knative installation by using the Knative `quickstart` plugin.
11
+
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.
12
+
13
+
This installation requires the following prerequisites:
14
+
15
+
- The [CLI Tools](../client/install-kn.md) are installed.
16
+
- Sufficient hardware:
17
+
18
+
6 CPUs, 6 GB of memory, and 30 GB of disk storage.
19
+
20
+
For information on production installs, see the [Installation Roadmap](README.md#installation-roadmap).
0 commit comments