From f57f42545e5da2a0ae65ea892d5cd51fa6cbcc39 Mon Sep 17 00:00:00 2001 From: Evan Anderson Date: Mon, 6 Jan 2020 09:45:49 -0800 Subject: [PATCH] Update documentation to clean up Docker for Mac and remove some old Istio-1.0-isms. (#2082) --- docs/install/Knative-with-Docker-for-Mac.md | 41 +++++++++------------ docs/install/installing-istio.md | 12 +++--- 2 files changed, 23 insertions(+), 30 deletions(-) diff --git a/docs/install/Knative-with-Docker-for-Mac.md b/docs/install/Knative-with-Docker-for-Mac.md index 73c48277f..024ddc1ea 100644 --- a/docs/install/Knative-with-Docker-for-Mac.md +++ b/docs/install/Knative-with-Docker-for-Mac.md @@ -25,43 +25,37 @@ continuing. 1. After Docker for Mac is installed, configure it with sufficient resources. You can do that via the [_Advanced_ menu](https://docs.docker.com/docker-for-mac/#advanced) in Docker - for Mac's preferences. Set **CPUs** to at least **6** and **Memory** to at - least **8.0 GiB**. + for Mac's preferences. Set **CPUs** to at least **2** and **Memory** to at + least **6.0 GiB**. 1. Now enable Docker for Mac's [Kubernetes capabilities](https://docs.docker.com/docker-for-mac/#kubernetes) and wait for the cluster to start up. ## Installing Istio -Knative depends on [Istio](https://istio.io/docs/concepts/what-is-istio/) for -traffic routing and ingress. You have the option of injecting Istio sidecars and -enabling the Istio service mesh, but it's not required for all Knative -components. - -If your cloud platform offers a managed Istio installation, we recommend -installing Istio that way, unless you need the ability to customize your -installation. - -If you prefer to install Istio manually, if your cloud provider doesn't offer a -managed Istio installation, or if you're installing Knative locally using -Minkube or similar, see the -[Installing Istio for Knative guide](./installing-istio.md). +Knative depends on [Istio](https://istio.io/docs/concepts/what-is-istio/) or +other HTTP loadbalancers for traffic routing and ingress. See the +[installing Istio for Knative guide](./installing-istio.md), and +[select the minimal install without sidecar injection or SSL](./installing-istio.md#installing-istio-without-sidecar-injection). ## Installing `cluster-local-gateway` for serving cluster-internal traffic -If you installed Istio, you can install a `cluster-local-gateway` within your Knative cluster so that you can serve cluster-internal traffic. If you want to configure your revisions to use routes that are visible only within your cluster, [install and use the `cluster-local-gateway`](./installing-istio.md#updating-your-install-to-use-cluster-local-gateway). +If you installed Istio, you can install a `cluster-local-gateway` within your +Knative cluster so that you can serve cluster-internal traffic. If you want to +configure your revisions to use routes that are visible only within your +cluster, +[install and use the `cluster-local-gateway`](./installing-istio.md#updating-your-install-to-use-cluster-local-gateway). ## Installing Knative Serving Next, install [Knative Serving](https://github.com/knative/serving). Because you have limited resources available, use the -`https://github.com/knative/serving/releases/download/{{< version >}}/serving.yaml` file, -which installs only Knative Serving: +`https://github.com/knative/serving/releases/download/{{< version >}}/serving.yaml` +file, which installs only Knative Serving: ```shell curl -L https://github.com/knative/serving/releases/download/{{< version >}}/serving.yaml \ - | sed 's/LoadBalancer/NodePort/' \ | kubectl apply --filename - ``` @@ -93,7 +87,8 @@ Now that your cluster has Knative installed, you're ready to deploy an app. If you'd like to follow a step-by-step guide for deploying your first app on Knative, check out the [Getting Started with Knative App Deployment](../serving/getting-started-knative-app.md) -guide. +guide. Note that (as of 1.11) you'll need to push your docker images to +DockerHub rather than only building them locally. If you'd like to view the available sample apps and deploy one of your choosing, head to the [sample apps](../serving/samples/README.md) repo. @@ -104,8 +99,8 @@ head to the [sample apps](../serving/samples/README.md) repo. Get started with Knative Eventing by walking through one of the [Eventing Samples](../eventing/samples/). -[Install Cert-Manager](../serving/installing-cert-manager.md) if you want to use the -[automatic TLS cert provisioning feature](../serving/using-auto-tls.md). +[Install Cert-Manager](../serving/installing-cert-manager.md) if you want to use +the [automatic TLS cert provisioning feature](../serving/using-auto-tls.md). ## Cleaning up @@ -115,5 +110,3 @@ up. To reset only the Kubernetes cluster to a fresh one, click "Reset Kubernetes cluster" in the [_Reset_ preferences](https://docs.docker.com/docker-for-mac/#reset). - - diff --git a/docs/install/installing-istio.md b/docs/install/installing-istio.md index af5726e73..4afe62e8b 100644 --- a/docs/install/installing-istio.md +++ b/docs/install/installing-istio.md @@ -57,7 +57,7 @@ without automatic sidecar injection. ```shell # Download and unpack Istio - export ISTIO_VERSION=1.3.5 + export ISTIO_VERSION=1.3.6 curl -L https://git.io/getLatestIstio | sh - cd istio-${ISTIO_VERSION} ``` @@ -220,9 +220,9 @@ helm template --namespace=istio-system \ ### Updating your install to use cluster local gateway If you want your Routes to be visible only inside the cluster, you may want to -enable [cluster local routes](../serving/cluster-local-route.md). To use -this feature, add an extra Istio cluster local gateway to your cluster. Enter -the following command to add the cluster local gateway to an existing Istio +enable [cluster local routes](../serving/cluster-local-route.md). To use this +feature, add an extra Istio cluster local gateway to your cluster. Enter the +following command to add the cluster local gateway to an existing Istio installation: ```shell @@ -274,12 +274,12 @@ kubectl get pods --namespace istio-system > Tip: You can append the `--watch` flag to the `kubectl get` commands to view > the pod status in realtime. You use `CTRL + C` to exit watch mode. - ### Configuring DNS Knative dispatches to different services based on their hostname, so it greatly simplifies things to have DNS properly configured. For this, we must look up the -external IP address that Gloo received. This can be done with the following command: +external IP address that Istio received. This can be done with the following +command: ``` $ kubectl get svc -nistio-system