mirror of https://github.com/knative/docs.git
Updating quickstart to use the plugin (#4046)
* updating quickstart to use the plugin * lint: removing extra whitespace * adding homebrew, simplifying binary install * linting: white space * fixing link to brew * removing unneeded brew install command * need kn version 0.25 or later * add to path, not plugin dir * when installing put binary in path not plugin dir * use markdown for links
This commit is contained in:
parent
9a0b7a6dbd
commit
58b2667e8b
|
|
@ -3,7 +3,7 @@
|
||||||
!!! warning
|
!!! warning
|
||||||
Knative Quickstart Environments are for experimentation use only. For production installation, see our [Administrator's Guide](../admin/README.md)
|
Knative Quickstart Environments are for experimentation use only. For production installation, see our [Administrator's Guide](../admin/README.md)
|
||||||
|
|
||||||
Before you can get started with a Knative Quickstart deployment you must install kind and the Kubernetes CLI.
|
Before you can get started with a Knative Quickstart deployment you must install kind, the Kubernetes CLI, and the Knative CLI.
|
||||||
|
|
||||||
### Install Kind (Kubernetes in Docker)
|
### Install Kind (Kubernetes in Docker)
|
||||||
|
|
||||||
|
|
@ -13,17 +13,17 @@ You can use [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start){target=_bla
|
||||||
|
|
||||||
The [Kubernetes CLI (`kubectl`)](https://kubernetes.io/docs/tasks/tools/install-kubectl){target=_blank}, allows you to run commands against Kubernetes clusters. You can use `kubectl` to deploy applications, inspect and manage cluster resources, and view logs.
|
The [Kubernetes CLI (`kubectl`)](https://kubernetes.io/docs/tasks/tools/install-kubectl){target=_blank}, allows you to run commands against Kubernetes clusters. You can use `kubectl` to deploy applications, inspect and manage cluster resources, and view logs.
|
||||||
|
|
||||||
|
### Install the Knative CLI
|
||||||
## Install the Knative "Quickstart" environment
|
|
||||||
|
|
||||||
You can get started with a local deployment of Knative by using _Knative on Kind_ (`konk`):
|
|
||||||
|
|
||||||
--8<-- "quickstart-install.md"
|
|
||||||
|
|
||||||
## Install the Knative CLI
|
|
||||||
|
|
||||||
The Knative CLI (`kn`) provides a quick and easy interface for creating Knative resources, such as Knative Services and Event Sources, without the need to create or modify YAML files directly.
|
The Knative CLI (`kn`) provides a quick and easy interface for creating Knative resources, such as Knative Services and Event Sources, without the need to create or modify YAML files directly.
|
||||||
|
|
||||||
`kn` also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting.
|
`kn` also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting.
|
||||||
|
|
||||||
--8<-- "install-kn.md"
|
--8<-- "install-kn.md"
|
||||||
|
|
||||||
|
## Install the Knative "Quickstart" environment
|
||||||
|
|
||||||
|
You can get started with a local deployment of Knative by using the Knative `quickstart` plugin.
|
||||||
|
|
||||||
|
--8<-- "quickstart-install.md"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,17 @@
|
||||||
!!! todo "Installing the `kn` CLI"
|
!!! todo "Installing the `kn` CLI"
|
||||||
|
|
||||||
=== "Using Homebrew"
|
=== "Using Homebrew"
|
||||||
For macOS, you can install `kn` by using [Homebrew](https://github.com/knative/homebrew-client){target=_blank}.
|
For macOS, you can install `kn` by using [Homebrew](https://brew.sh"){target=_blank}.
|
||||||
|
|
||||||
```
|
```
|
||||||
brew install knative/client/kn
|
brew install knative/client/kn
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note: Quickstart requires `kn` version 0.25 or later. To upgrade an existing install to the latest version, run `brew upgrade kn`.
|
||||||
|
|
||||||
=== "Using a binary"
|
=== "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. Note that you will need `kn` version 0.25 or later.
|
||||||
|
|
||||||
1. Download the binary for your system from the [`kn` release page](https://github.com/knative/client/releases){target=_blank}.
|
1. Download the binary for your system from the [`kn` release page](https://github.com/knative/client/releases){target=_blank}.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,22 +1,58 @@
|
||||||
|
!!! todo "Installing the `quickstart` plugin"
|
||||||
|
=== "Using Homebrew"
|
||||||
|
For macOS, you can install the `quickstart` plugin by using [Homebrew](https://brew.sh){target=_blank}.
|
||||||
|
```
|
||||||
|
brew install knative-sandbox/kn-plugins/quickstart
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Using a binary"
|
||||||
|
You can install the `quickstart` plugin by downloading the executable binary for your system and placing it on your `PATH` (for example, in `/usr/local/bin`).
|
||||||
|
|
||||||
`konk` is a shell script that completes the following functions:
|
A link to the latest stable binary release is available on the [`quickstart` release page](https://github.com/knative-sandbox/kn-plugin-quickstart/releases){target=_blank}.
|
||||||
|
|
||||||
|
=== "Using Go"
|
||||||
|
1. Check out the `kn-plugin-quickstart` repository:
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/knative-sandbox/kn-plugin-quickstart.git
|
||||||
|
cd kn-plugin-quickstart/
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Build an executable binary:
|
||||||
|
|
||||||
|
```
|
||||||
|
hack/build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Move the executable binary file to a directory on your `PATH`:
|
||||||
|
|
||||||
|
```
|
||||||
|
mv kn-quickstart /usr/local/bin
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Verify that the plugin is working, for example:
|
||||||
|
|
||||||
|
```
|
||||||
|
kn quickstart --help
|
||||||
|
```
|
||||||
|
|
||||||
|
The `quickstart` plugin completes the following functions:
|
||||||
|
|
||||||
1. **Checks if you have [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start){target=_blank} installed,** and creates a cluster called `knative`.
|
1. **Checks if you have [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start){target=_blank} installed,** and creates a cluster called `knative`.
|
||||||
1. **Installs Knative Serving with Kourier** as the default networking layer, and nip.io as the DNS.
|
1. **Installs Knative Serving with Kourier** as the default networking layer, and nip.io as the DNS.
|
||||||
1. **Installs Knative Eventing** and creates an in-memory Broker and Channel implementation.
|
1. **Installs Knative Eventing** and creates an in-memory Broker and Channel implementation.
|
||||||
|
|
||||||
!!! todo "Install Knative and Kubernetes on a local Docker Daemon using `konk`"
|
!!! todo "Install Knative and Kubernetes on a local Docker Daemon using `kn quickstart`"
|
||||||
```bash
|
```bash
|
||||||
curl -sL install.konk.dev | bash
|
kn quickstart kind
|
||||||
```
|
```
|
||||||
|
|
||||||
??? bug "Having issues with Kind?"
|
??? bug "Having issues with Kind?"
|
||||||
We've found that some users (specifically Linux) may have trouble with Docker and, subsequently, Kind. Though this tutorial assumes you have KonK installed, you can easily follow along with a different installation.
|
We've found that some users (specifically Linux) may have trouble with Docker and, subsequently, Kind. Though this tutorial assumes you have Kind installed, you can easily follow along with a different installation.
|
||||||
|
|
||||||
We have provide an alternative Quickstart on `minikube` here: [https://github.com/csantanapr/knative-minikube](https://github.com/csantanapr/knative-minikube){_target="_blank"}
|
We have provide an alternative Quickstart on `minikube` here: [https://github.com/csantanapr/knative-minikube](https://github.com/csantanapr/knative-minikube){_target="_blank"}
|
||||||
|
|
||||||
Installing `konk` may take a few minutes. After the script is finished, check to make sure you have a Cluster called `knative`
|
Installing may take a few minutes. After the plugin is finished, check to make sure you have a Cluster called `knative`
|
||||||
!!! success "Verify Installation"
|
!!! success "Verify Installation"
|
||||||
```bash
|
```bash
|
||||||
kind get clusters
|
kind get clusters
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue