-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Installation Doc Updates #6395
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Installation Doc Updates #6395
Changes from all commits
20ff9df
d9d3690
6ffb330
86bd901
1600db8
c966d84
8d0e25e
1a28179
5ffbfd3
14604c7
7afcf68
3c4cfc0
0d5c3a6
aa51212
62eb22f
b026363
c6182f2
1156da3
7ab0d5d
e7ee630
c8025f7
92f6808
0ed91d6
84a9af2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm okay with leaving a note here (though it seems odd that we mention the administrator-focused operator plugin but not the developer-focused There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agreed. Let's find a better place for the Operator content in a subsequent PR. |
||
|
|
||
| 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. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,12 +6,19 @@ components: | |
| function: tutorial | ||
| --- | ||
|
|
||
| # Install Knative using quickstart | ||
| # Install the Knative quickstart plugin | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This topic covers both installing the plugin, and using the plugin to get a cluster with Knative installed on it. Maybe just "quickstart" or "quickstart install"? |
||
|
|
||
| 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 | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The operator is part of the Knative CLI, but is primarily focused on administrators who have whole-cluster control. I think this documentation should be focused on developers, and we should leave out the operator bits.