Install on Google Kubernetes Engine

This guide walks you through the installation of the latest version of all Knative components using pre-built images.

You can find guides for other platforms here.

Before you begin

Cloud Run on GKE is a hosted offering on top of GKE that builds around Istio and Knative Serving.

Knative requires a Kubernetes cluster v1.11 or newer. kubectl v1.10 is also required. This guide walks you through creating a cluster with the correct specifications for Knative on Google Cloud Platform (GCP).

This guide assumes you are using bash in a Mac or Linux environment; some commands will need to be adjusted for use in a Windows environment.

Installing the Google Cloud SDK and kubectl

  1. If you already have gcloud installed with kubectl version 1.10 or newer, you can skip these steps.

Tip: To check which version of kubectl you have installed, enter:

   kubectl version
  1. Download and install the gcloud command line tool: https://cloud.google.com/sdk/install

  2. Install the kubectl component:

    gcloud components install kubectl
    
  3. Authorize gcloud:

    gcloud auth login
    

Setting environment variables

To simplify the command lines for this walkthrough, we need to define a few environment variables.

Set CLUSTER_NAME and CLUSTER_ZONE variables, you can replace knative and us-west1-c with cluster name and zone of your choosing.

The CLUSTER_NAME needs to be lowercase and unique among any other Kubernetes clusters in your GCP project. The zone can be any compute zone available on GCP. These variables are used later to create a Kubernetes cluster.

export CLUSTER_NAME=knative
export CLUSTER_ZONE=us-west1-c

Setting up a Google Cloud Platform project

You need a Google Cloud Platform (GCP) project to create a Google Kubernetes Engine cluster.

  1. Set PROJECT environment variable, you can replace my-knative-project with the desired name of your GCP project. If you don’t have one, we’ll create one in the next step.
   export PROJECT=my-knative-project
  1. If you don’t have a GCP project, create and set it as your gcloud default:
   gcloud projects create $PROJECT --set-as-default

You also need to enable billing for your new project.

  1. If you already have a GCP project, make sure your project is set as your gcloud default:
   gcloud config set core/project $PROJECT

Tip: Enter gcloud config get-value project to view the ID of your default GCP project.

  1. Enable the necessary APIs:
   gcloud services enable \
     cloudapis.googleapis.com \
     container.googleapis.com \
     containerregistry.googleapis.com

Creating a Kubernetes cluster

To make sure the cluster is large enough to host Knative and its dependencies, the recommended configuration for a cluster is:

  • Kubernetes version 1.11 or later
  • 4 vCPU nodes (n1-standard-4)
  • Node autoscaling, up to 10 nodes
  • API scopes for cloud-platform
  1. Create a Kubernetes cluster on GKE with the required specifications:

Note: If this setup is for development, or a non-Istio networking layer (e.g. Gloo) will be used, then you can remove the --addons line below.

Note: If you want to use Auto TLS feature, you need to remove the --addons line below, and follow the instructions to install Istio with Secret Discovery Service.

gcloud beta container clusters create $CLUSTER_NAME \
  --addons=HorizontalPodAutoscaling,HttpLoadBalancing,Istio \
  --machine-type=n1-standard-4 \
  --cluster-version=latest --zone=$CLUSTER_ZONE \
  --enable-stackdriver-kubernetes --enable-ip-alias \
  --enable-autoscaling --min-nodes=1 --max-nodes=10 \
  --enable-autorepair \
  --scopes cloud-platform
  1. Grant cluster-admin permissions to the current user:
   kubectl create clusterrolebinding cluster-admin-binding \
     --clusterrole=cluster-admin \
     --user=$(gcloud config get-value core/account)

Admin permissions are required to create the necessary RBAC rules for Knative.

Installing Knative

The following commands install all available Knative components as well as the standard set of observability plugins. To customize your Knative installation, see Performing a Custom Knative Installation.

  1. To install Knative, first install the CRDs by running the kubectl apply command once with the -l knative.dev/crd-install=true flag. This prevents race conditions during the install, which cause intermittent errors:
   kubectl apply --selector knative.dev/crd-install=true \
   --filename https://github.com/knative/serving/releases/download/v0.6.0/serving.yaml \
   --filename https://github.com/knative/build/releases/download/v0.6.0/build.yaml \
   --filename https://github.com/knative/eventing/releases/download/v0.6.0/release.yaml \
   --filename https://github.com/knative/eventing-sources/releases/download/v0.6.0/eventing-sources.yaml \
   --filename https://github.com/knative/serving/releases/download/v0.6.0/monitoring.yaml \
   --filename https://raw.githubusercontent.com/knative/serving/v0.6.0/third_party/config/build/clusterrole.yaml
  1. To complete the install of Knative and its dependencies, run the kubectl apply command again, this time without the --selector flag, to complete the install of Knative and its dependencies:
   kubectl apply --filename https://github.com/knative/serving/releases/download/v0.6.0/serving.yaml --selector networking.knative.dev/certificate-provider!=cert-manager \
   --filename https://github.com/knative/build/releases/download/v0.6.0/build.yaml \
   --filename https://github.com/knative/eventing/releases/download/v0.6.0/release.yaml \
   --filename https://github.com/knative/eventing-sources/releases/download/v0.6.0/eventing-sources.yaml \
   --filename https://github.com/knative/serving/releases/download/v0.6.0/monitoring.yaml \
   --filename https://raw.githubusercontent.com/knative/serving/v0.6.0/third_party/config/build/clusterrole.yaml

Notes: - By default, the Knative Serving component installation (serving.yaml) includes a controller for enabling automatic TLS certificate provisioning. If you do intend on immediately enabling auto certificates in Knative, you can remove the --selector networking.knative.dev/certificate-provider!=cert-manager statement to install the controller. Otherwise, you can choose to install the auto certificates feature and controller at a later time.

  • For the v0.4.0 release and newer, the clusterrole.yaml file is required to enable the Build and Serving components to interact with each other.
  1. Monitor the Knative components until all of the components show a STATUS of Running:
   kubectl get pods --namespace knative-serving
   kubectl get pods --namespace knative-build
   kubectl get pods --namespace knative-eventing
   kubectl get pods --namespace knative-sources
   kubectl get pods --namespace knative-monitoring

What’s next

Now that your cluster has Knative installed, you can see what Knative has to offer.

To deploy your first app with Knative, follow the step-by-step Getting Started with Knative App Deployment guide.

To get started with Knative Eventing, pick one of the Eventing Samples to walk through.

To get started with Knative Build, read the Build README, then choose a sample to walk through.

Cleaning up

Running a cluster in Kubernetes Engine costs money, so you might want to delete the cluster when you’re done if you’re not using it. Deleting the cluster will also remove Knative, Istio, and any apps you’ve deployed.

To delete the cluster, enter the following command:

gcloud container clusters delete $CLUSTER_NAME --zone $CLUSTER_ZONE

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.