Fixing the kn cli references (#3422)

* Update _index.md

Changing link on the install page to link to pre-requisites

* Update prerequisites.md

Added links to install either Serving or Eventing in Pre-Req

* Update prerequisites.md

- Edited to include `kn` CLI as a pre-req
- pulled out Homebrew command 
- bolded important portions of the page
- conformed "Serving" and "Eventing" to the  [Knative Word and Phrase List](https://docs.google.com/spreadsheets/d/1p1_kBUd6ZvonxHkMcEJPayf6QIpExuFf5cFq0ptar7I/edit#gid=0) 
- Added link to Private Registry documentation

* Update install-serving-with-yaml.md

- removed reference to KN CLI (now in Pre-Reqs) 
- trimmed the fat around Installing Kantive Eventing
- Added relevant context to optional extensions

* Update install-serving-with-yaml.md

Added same context from Eventing Page

* Update install-serving-with-yaml.md

Added same context from Eventing Page, added (like TLS) to second bullet.

* Update install-eventing-with-yaml.md

Removed reference to KN CLI (now in Pre-Reqs)

* Update install-serving-with-yaml.md

added reference to install files

* Update install-extensions.md

Fix broken link

* Create install-extensions.md

Fix broken link

* Update install-eventing-with-yaml.md

* Update prerequisites.md

made wording less bad

* Make Homebrew installation the first option for `kn`, pull command to install out of Github and into knative.dev site (#3410)

* Update install-kn.md

Adding brew install kn command directly to page and making it the first option

* Update docs/client/install-kn.md

Co-authored-by: Mike Petersen <mpetason@gmail.com>

Co-authored-by: Mike Petersen <mpetason@gmail.com>

* Create prerequisites.md (#3413)

whitespace fix

* Update prerequisites.md (#3414)

more whitespace

* remove (like TLS)

* Update install-serving-with-yaml.md (#3420)

Adding `kn` CLI to Next Steps

* Update install-eventing-with-yaml.md (#3421)

* Removing `kn` from required

Co-authored-by: Mike Petersen <mpetason@gmail.com>
This commit is contained in:
Omer B 2021-04-05 18:24:27 -04:00 committed by GitHub
parent 047befdfcf
commit dd79063068
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 41 additions and 18 deletions

View File

@ -8,6 +8,15 @@ aliases:
This guide provides details about how you can set up the Knative `kn` CLI. 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 ## Install kn using a binary
You can install `kn` by downloading the executable binary for your system and placing it in the system path. You can install `kn` by downloading the executable binary for your system and placing it in the system path.
@ -47,10 +56,6 @@ Links to the latest nightly-built executable binaries are available here:
kn version 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 ## 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. **WARNING:** Nightly container images include features which may not be included in the latest Knative release and are not considered to be stable.

View File

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

View File

@ -31,6 +31,9 @@ To install the Eventing component:
kubectl apply -f {{< artifact repo="eventing" file="eventing-core.yaml" >}} 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 ## Verify the installation
@ -218,6 +221,8 @@ data:
After installing Knative Eventing: After installing Knative Eventing:
- If you want to add extra features to your installation, see [Installing optional extensions](./install-extensions.md). - To easily interact with Knative Eventing Components, [download the `kn` CLI](/docs/client/install-kn.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. - 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)

View File

@ -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. Before you install any optional extensions, you must install Knative Serving or Eventing.
See [Installing Serving using YAML files](./install-serving-with-yaml.md) 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 ## Install optional Serving extensions
@ -276,3 +276,7 @@ To learn more about the VMware sources and bindings, try
{{< /tab >}} {{< /tab >}}
{{< /tabs >}} {{< /tabs >}}
## Next steps
- To easily interact with Knative Services and Eventing Components, [download the `kn` CLI](/docs/client/install-kn.md)

View File

@ -25,11 +25,13 @@ To install the serving component:
kubectl apply -f {{< artifact repo="serving" file="serving-crds.yaml" >}} 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 ```bash
kubectl apply -f {{< artifact repo="serving" file="serving-core.yaml" >}} 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 ## Install a networking layer
@ -373,6 +375,8 @@ Refer to the "Real DNS" method for a permanent solution.
After installing Knative Serving: After installing Knative Serving:
- If you want to add extra features to your installation, see [Installing optional extensions](./install-extensions.md). - [Installing Knative Eventing using YAML files](./install-eventing-with-yaml.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. - 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)

View File

@ -9,10 +9,10 @@ Before installing Knative, you must meet the following prerequisites:
## System requirements ## 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 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 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. - 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--> <!--TODO: Verify these requirements-->
@ -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 a cluster that uses Kubernetes v1.18 or newer.
- You have installed the [`kubectl` CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/). - 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)