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
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
- If you already have
kubectlversion 1.10 or newer, you can skip these steps.
Tip: To check which version of
kubectlyou have installed, enter:
Download and install the
gcloudcommand line tool: https://cloud.google.com/sdk/install
gcloud components install kubectl
gcloud auth login
Setting environment variables
To simplify the command lines for this walkthrough, we need to define a few environment variables.
CLUSTER_ZONE variables, you can replace
us-west1-c with cluster name and zone of your choosing.
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.
PROJECTenvironment variable, you can replace
my-knative-projectwith the desired name of your GCP project. If you don’t have one, we’ll create one in the next step.
- If you don’t have a GCP project, create and set it as your
gcloud projects create $PROJECT --set-as-default
You also need to enable billing for your new project.
- If you already have a GCP project, make sure your project is set as your
gcloud config set core/project $PROJECT
gcloud config get-value projectto view the ID of your default GCP project.
- 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 all the Knative and Istio components, the recommended configuration for a cluster is:
- Kubernetes version 1.11 or later
- 4 vCPU nodes (
- Node autoscaling, up to 10 nodes
- API scopes for
pubsub(if those features will be used)
- Create a Kubernetes cluster on GKE with the required specifications:
gcloud container clusters create $CLUSTER_NAME \ --zone=$CLUSTER_ZONE \ --cluster-version=latest \ --machine-type=n1-standard-4 \ --enable-autoscaling --min-nodes=1 --max-nodes=10 \ --enable-autorepair \ --scopes=service-control,service-management,compute-rw,storage-ro,cloud-platform,logging-write,monitoring-write,pubsub,datastore \ --num-nodes=3
- 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 Istio.
Knative depends on Istio.
- Install Istio:
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/istio-crds.yaml && \ kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/istio.yaml
Note: the resources (CRDs) defined in the
istio-crds.yamlfile are also
included in the
istio.yaml file, but they are pulled out so that the CRD
definitions are created first. If you see an error when creating resources
about an unknown type, run the second
kubectl apply command again.
- Label the default namespace with
kubectl label namespace default istio-injection=enabled
- Monitor the Istio components until all of the components show a
kubectl get pods --namespace istio-system
It will take a few minutes for all the components to be up and running; you can rerun the command to see the current status.
Note: Instead of rerunning the command, you can add
--watchto the above command to view the component’s status updates in real time. Use CTRL + C to exit watch mode.
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.
- If you are upgrading from Knative 0.3.x: Update your domain and static IP
address to be associated with the LoadBalancer
knative-ingressgateway. Then run the following to clean up leftover resources:
kubectl delete svc knative-ingressgateway -n istio-system kubectl delete deploy knative-ingressgateway -n istio-system
If you have the Knative Eventing Sources component installed, you will also need to delete the following resource before upgrading:
kubectl delete statefulset/controller-manager -n knative-sources
While the deletion of this resource during the upgrade process will not prevent modifications to Eventing Source resources, those changes will not be completed until the upgrade process finishes.
- Run the
kubectl applycommand to install Knative and its dependencies:
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/serving.yaml \ --filename https://github.com/knative/build/releases/download/v0.5.0/build.yaml \ --filename https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml \ --filename https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml \ --filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring.yaml \ --filename https://raw.githubusercontent.com/knative/serving/v0.5.0/third_party/config/build/clusterrole.yaml
Note: If your install fails on the first attempt, try rerunning the commands. They will likely succeed on the second attempt. For background info and to track the upcoming solution to this problem, see issues #968 and #1036.
Note: For the v0.4.0 release and newer, the
clusterrole.yamlfile is required to enable the Build and Serving components to interact with each other.
- Monitor the Knative components until all of the components show a
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
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.
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
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.