Skip to content

README.md

Latest commit

 

History

History
128 lines (86 loc) · 4.33 KB

README.md

File metadata and controls

128 lines (86 loc) · 4.33 KB

kn-plugin-quickstart

This component is BETA

kn-plugin-quickstart is a plugin of the Knative Client, to enable users to quickly set up a local Knative environment from the command line.

Getting Started

In order to use the quickstart plugin, you must install:

Installation

You can download the latest binaries from the Releases page.

There are two ways to run kn quickstart:

  1. You can run it standalone, just put it on your system path and make sure it is executable.
  2. You can install it as a plugin of the kn client to run:
    • Follow the documentation to install kn client if you don't have it.
    • Copy the kn-quickstart binary to a directory on your PATH (for example, /usr/local/bin) and make sure its filename is kn-quickstart.
    • Run kn plugin list to verify that the kn-quickstart plugin is installed successfully.

After the plugin is installed, you can use kn quickstart to run its related subcommands.

Usage

Get up and running with a local Knative environment

Usage:
  kn-quickstart [command]

Available Commands:
  completion  generate the autocompletion script for the specified shell
  help        Help about any command
  kind        Quickstart with Kind
  minikube    Quickstart with Minikube
  version     Prints the plugin version

Flags:
  -h, --help   help for kn-quickstart

Use "kn-quickstart [command] --help" for more information about a command.

Quickstart with KinD

Set up a local Knative cluster using KinD:

kn quickstart kind

Kind can also be configured with an extra mount so your containers can access files on your local machine.

kn quickstart kind --extraMountHostPath /home/myname/foo --extraMountContainerPath /foo

Quickstart with Minikube

Set up a local Knative cluster using Minikube:

kn quickstart minikube

Tip

If you want to use custom minikube flags not included in the command, append them after --, for Example:

kn quickstart minikube -- --ports 5000

Most recent values will take precedent

Note: for Windows/Mac users, after the above command completes, you will need to run the following in a separate terminal window:

minikube tunnel --profile minikube-knative

Building from Source

You must set up your development environment before you build kn-plugin-quickstart.

Once you've set up your development environment, you can build the plugin by running the following commands:

git clone git@github.com:knative-sandbox/kn-plugin-quickstart.git
cd kn-plugin-quickstart
./hack/build.sh

Using local registry on Kind

Kind can be configured with a local container image registry by passing the --registry flag:

kn quickstart kind --registry

Note: we automatically configure tag resolution for the local registry when this flag is passed

You can pull or build an image:

docker build -t <image-name>:<tag> .
docker pull ghcr.io/knative/helloworld-go:latest

Then tag it and push to the registry:

docker tag ghcr.io/knative/helloworld-go:latest localhost:5001/helloworld-go:latest
docker push localhost:5001/helloworld-go:latest

Using the Nightlies

You can grab the latest nightly binary executable for:

Add the binary to the system PATH and ensure that it is executable.