From 4ae9e7ea692ab2e3c7326eb7b585e835b2840137 Mon Sep 17 00:00:00 2001 From: Steven Dake Date: Wed, 25 Jul 2018 14:11:45 -0700 Subject: [PATCH] Clean up of the platform section (#1960) * Clean up of the platform section This cleans up the platform section into its own subdirectory. I am not all that happy about how "see-also" works, but maybe that is how it is meant to work, or alternatively I'm doing it wrong :) * Apply reviewer comments and add the index file _index.md was missing from prior commit accidentally. Removed all "Platform setup for" text in all platform docs. * Apply reviewer comments Some wordsmithing. weight = 3 is intentional to fit alphabet. Assuming nobody will require ASCIIbetical. * Fix US English lint errors * Revert the Chinese translation of the platforms PR The Chinese language version needs to be ported. This PR was merged manually which probably has broken the gate. --- .spelling | 1 - .../export-logs-through-stackdriver/index.md | 4 ++-- content/docs/examples/endpoints/index.md | 2 +- .../setup/kubernetes/ansible-install/index.md | 2 +- .../kubernetes/download-release/index.md | 2 +- .../setup/kubernetes/helm-install/index.md | 16 ++++++++-------- .../setup/kubernetes/mesh-expansion/index.md | 2 +- .../kubernetes/multicluster-install/index.md | 2 +- .../setup/kubernetes/platform-setup/_index.md | 7 +++++++ .../{ => platform-setup}/aws/index.md | 8 ++++---- .../{ => platform-setup}/azure/index.md | 8 ++++---- .../{ => platform-setup}/gke/index.md | 8 ++++---- .../{ => platform-setup}/ibm/index.md | 6 +++--- .../{ => platform-setup}/minikube/index.md | 8 ++++---- .../{ => platform-setup}/openshift/index.md | 10 +++++----- .../kubernetes/quick-start-gke-dm/index.md | 2 +- .../setup/kubernetes/quick-start/index.md | 19 +++++++++---------- .../kubernetes/sidecar-injection/index.md | 2 +- .../setup/kubernetes/upgrading-istio/index.md | 2 +- .../setup/kubernetes/helm-install/index.md | 10 ++-------- 20 files changed, 60 insertions(+), 61 deletions(-) create mode 100644 content/docs/setup/kubernetes/platform-setup/_index.md rename content/docs/setup/kubernetes/{ => platform-setup}/aws/index.md (92%) rename content/docs/setup/kubernetes/{ => platform-setup}/azure/index.md (97%) rename content/docs/setup/kubernetes/{ => platform-setup}/gke/index.md (83%) rename content/docs/setup/kubernetes/{ => platform-setup}/ibm/index.md (84%) rename content/docs/setup/kubernetes/{ => platform-setup}/minikube/index.md (84%) rename content/docs/setup/kubernetes/{ => platform-setup}/openshift/index.md (90%) diff --git a/.spelling b/.spelling index 73833f4e4f..6e2caba97b 100644 --- a/.spelling +++ b/.spelling @@ -126,7 +126,6 @@ OP_QUERY OpenID_Connect OpenSSL OpenShift -openshift Ostrowski PaaS Papertrail diff --git a/content/blog/2018/export-logs-through-stackdriver/index.md b/content/blog/2018/export-logs-through-stackdriver/index.md index a9501a4771..25e3ba7962 100644 --- a/content/blog/2018/export-logs-through-stackdriver/index.md +++ b/content/blog/2018/export-logs-through-stackdriver/index.md @@ -50,7 +50,7 @@ Common setup for all sinks: 1. Record the ID of the dataset. It will be needed to configure the Stackdriver handler. It would be of the form `bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET_ID]` 1. Give [sink’s writer identity](https://cloud.google.com/logging/docs/api/tasks/exporting-logs#writing_to_the_destination): `cloud-logs@system.gserviceaccount.com` BigQuery Data Editor role in IAM. -1. If using [Google Kubernetes Engine](/docs/setup/kubernetes/gke/), make sure `bigquery` [Scope](https://cloud.google.com/sdk/gcloud/reference/container/clusters/create) is enabled on the cluster. +1. If using [Google Kubernetes Engine](/docs/setup/kubernetes/platform-setup/gke/), make sure `bigquery` [Scope](https://cloud.google.com/sdk/gcloud/reference/container/clusters/create) is enabled on the cluster. #### Google Cloud Storage (GCS) @@ -65,7 +65,7 @@ Common setup for all sinks: 1. Recode the ID of the topic. It will be needed to configure Stackdriver. It would be of the form `pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]` 1. Give [sink’s writer identity](https://cloud.google.com/logging/docs/api/tasks/exporting-logs#writing_to_the_destination): `cloud-logs@system.gserviceaccount.com` Pub/Sub Publisher role in IAM. -1. If using [Google Kubernetes Engine](/docs/setup/kubernetes/gke/), make sure `pubsub` [Scope](https://cloud.google.com/sdk/gcloud/reference/container/clusters/create) is enabled on the cluster. +1. If using [Google Kubernetes Engine](/docs/setup/kubernetes/platform-setup/gke/), make sure `pubsub` [Scope](https://cloud.google.com/sdk/gcloud/reference/container/clusters/create) is enabled on the cluster. ### Setting up Stackdriver diff --git a/content/docs/examples/endpoints/index.md b/content/docs/examples/endpoints/index.md index a939dc0164..dfebf06e8c 100644 --- a/content/docs/examples/endpoints/index.md +++ b/content/docs/examples/endpoints/index.md @@ -21,7 +21,7 @@ You may test the service using the following command: $ curl --request POST --header "content-type:application/json" --data '{"message":"hello world"}' "http://${EXTERNAL_IP}:80/echo?key=${ENDPOINTS_KEY}" {{< /text >}} -To install Istio for GKE, follow our [Quick Start with Google Kubernetes Engine](/docs/setup/kubernetes/gke). +To install Istio for GKE, follow our [Quick Start with Google Kubernetes Engine](/docs/setup/kubernetes/platform-setup/gke). ## HTTP Endpoints service diff --git a/content/docs/setup/kubernetes/ansible-install/index.md b/content/docs/setup/kubernetes/ansible-install/index.md index 82a74ded13..f036cdd300 100644 --- a/content/docs/setup/kubernetes/ansible-install/index.md +++ b/content/docs/setup/kubernetes/ansible-install/index.md @@ -1,7 +1,7 @@ --- title: Installation with Ansible description: Install Istio with the included Ansible playbook. -weight: 4 +weight: 40 keywords: [kubernetes,ansible] --- diff --git a/content/docs/setup/kubernetes/download-release/index.md b/content/docs/setup/kubernetes/download-release/index.md index 63c41fa15c..b068f04d36 100644 --- a/content/docs/setup/kubernetes/download-release/index.md +++ b/content/docs/setup/kubernetes/download-release/index.md @@ -1,7 +1,7 @@ --- title: Download the Istio release description: Instructions to download the Istio release. -weight: 9 +weight: 90 keywords: [kubernetes] --- diff --git a/content/docs/setup/kubernetes/helm-install/index.md b/content/docs/setup/kubernetes/helm-install/index.md index 79c4940803..357a702e07 100644 --- a/content/docs/setup/kubernetes/helm-install/index.md +++ b/content/docs/setup/kubernetes/helm-install/index.md @@ -1,7 +1,7 @@ --- title: Installation with Helm description: Install Istio with the included Helm chart. -weight: 3 +weight: 30 keywords: [kubernetes,helm] aliases: - /docs/setup/kubernetes/helm.html @@ -17,13 +17,13 @@ plane and the sidecars for the Istio data plane. 1. [Download the Istio release](/docs/setup/kubernetes/download-release/). -1. Kubernetes platform setup - * [Minikube](/docs/setup/kubernetes/minikube/) - * [Google Container Engine (GKE)](/docs/setup/kubernetes/gke/) - * [IBM Cloud Kubernetes Service (IKS)](/docs/setup/kubernetes/ibm/) - * [Openshift Origin](/docs/setup/kubernetes/openshift/) - * [Amazon Web Services (AWS) with Kops](/docs/setup/kubernetes/aws/) - * [Azure](/docs/setup/kubernetes/azure/) +1. [Kubernetes platform setup](/docs/setup/kubernetes/platform-setup/): + * [Minikube](/docs/setup/kubernetes/platform-setup/minikube/) + * [Google Container Engine (GKE)](/docs/setup/kubernetes/platform-setup/gke/) + * [IBM Cloud Kubernetes Service (IKS)](/docs/setup/kubernetes/platform-setup/ibm/) + * [OpenShift Origin](/docs/setup/kubernetes/platform-setup/openshift/) + * [Amazon Web Services (AWS) with Kops](/docs/setup/kubernetes/platform-setup/aws/) + * [Azure](/docs/setup/kubernetes/platform-setup/azure/) 1. [Install the Helm client](https://docs.helm.sh/using_helm/#installing-helm). diff --git a/content/docs/setup/kubernetes/mesh-expansion/index.md b/content/docs/setup/kubernetes/mesh-expansion/index.md index c077c4fcf4..2d6b7db5b0 100644 --- a/content/docs/setup/kubernetes/mesh-expansion/index.md +++ b/content/docs/setup/kubernetes/mesh-expansion/index.md @@ -1,7 +1,7 @@ --- title: Mesh Expansion description: Instructions for integrating VMs and bare metal hosts into an Istio mesh deployed on Kubernetes. -weight: 5 +weight: 50 keywords: [kubernetes,vms] --- diff --git a/content/docs/setup/kubernetes/multicluster-install/index.md b/content/docs/setup/kubernetes/multicluster-install/index.md index 3b7523f2ea..d1c0c56d95 100644 --- a/content/docs/setup/kubernetes/multicluster-install/index.md +++ b/content/docs/setup/kubernetes/multicluster-install/index.md @@ -1,7 +1,7 @@ --- title: Istio Multicluster description: Install Istio with multicluster support. -weight: 6 +weight: 60 keywords: [kubernetes,multicluster] --- diff --git a/content/docs/setup/kubernetes/platform-setup/_index.md b/content/docs/setup/kubernetes/platform-setup/_index.md new file mode 100644 index 0000000000..00f7c79bd8 --- /dev/null +++ b/content/docs/setup/kubernetes/platform-setup/_index.md @@ -0,0 +1,7 @@ +--- +title: Platform Setup +description: How to prepare various Kubernetes platforms before installing Istio. +weight: 1 +keywords: [platform-setup] +type: section-index +--- diff --git a/content/docs/setup/kubernetes/aws/index.md b/content/docs/setup/kubernetes/platform-setup/aws/index.md similarity index 92% rename from content/docs/setup/kubernetes/aws/index.md rename to content/docs/setup/kubernetes/platform-setup/aws/index.md index 096dfa0793..4df0730a62 100644 --- a/content/docs/setup/kubernetes/aws/index.md +++ b/content/docs/setup/kubernetes/platform-setup/aws/index.md @@ -1,8 +1,8 @@ --- -title: Platform setup for Amazon Web Services -description: Instructions to setup the AWS with Kops cluster for Istio. -weight: 14 -keywords: [aws] +title: Amazon Web Services +description: Instructions to setup an AWS cluster with Kops cluster for Istio. +weight: 3 +keywords: [platform-setup,aws] --- To setup the AWS with Kops cluster for Istio, follow these instructions: diff --git a/content/docs/setup/kubernetes/azure/index.md b/content/docs/setup/kubernetes/platform-setup/azure/index.md similarity index 97% rename from content/docs/setup/kubernetes/azure/index.md rename to content/docs/setup/kubernetes/platform-setup/azure/index.md index 08b79d0503..3cc18b93e1 100644 --- a/content/docs/setup/kubernetes/azure/index.md +++ b/content/docs/setup/kubernetes/platform-setup/azure/index.md @@ -1,8 +1,8 @@ --- -title: Platform setup for Azure -description: Instructions to setup the Azure cluster for Istio. -weight: 15 -keywords: [azure] +title: Azure +description: Instructions to setup an Azure cluster for Istio. +weight: 6 +keywords: [platform-setup,azure] --- To setup the Azure cluster for Istio, follow these instructions: diff --git a/content/docs/setup/kubernetes/gke/index.md b/content/docs/setup/kubernetes/platform-setup/gke/index.md similarity index 83% rename from content/docs/setup/kubernetes/gke/index.md rename to content/docs/setup/kubernetes/platform-setup/gke/index.md index 24db934e76..f2f464cc89 100644 --- a/content/docs/setup/kubernetes/gke/index.md +++ b/content/docs/setup/kubernetes/platform-setup/gke/index.md @@ -1,8 +1,8 @@ --- -title: Platform setup for Google Kubernetes Engine -description: Instructions to setup the Google Kubernetes Engine cluster for Istio. -weight: 11 -keywords: [kubernetes,gke,google] +title: Google Kubernetes Engine +description: Instructions to setup a Google Kubernetes Engine cluster for Istio. +weight: 9 +keywords: [platform-setup,kubernetes,gke,google] --- To setup the Google Kubernetes Engine cluster for Istio, follow these instructions: diff --git a/content/docs/setup/kubernetes/ibm/index.md b/content/docs/setup/kubernetes/platform-setup/ibm/index.md similarity index 84% rename from content/docs/setup/kubernetes/ibm/index.md rename to content/docs/setup/kubernetes/platform-setup/ibm/index.md index 32b967f50e..4042c2d250 100644 --- a/content/docs/setup/kubernetes/ibm/index.md +++ b/content/docs/setup/kubernetes/platform-setup/ibm/index.md @@ -1,8 +1,8 @@ --- -title: Platform setup for IBM Cloud Kubernetes Service -description: Instructions to setup the IBM Cloud Kubernetes Service (IKS) cluster for Istio. +title: IBM Cloud Kubernetes Service +description: Instructions to setup a IBM Cloud Kubernetes Service (IKS) cluster for Istio. weight: 12 -keywords: [ibm,iks] +keywords: [platform-setup,ibm,iks] --- To setup the IBM Cloud Kubernetes Service (IKS) cluster for Istio, follow these instructions: diff --git a/content/docs/setup/kubernetes/minikube/index.md b/content/docs/setup/kubernetes/platform-setup/minikube/index.md similarity index 84% rename from content/docs/setup/kubernetes/minikube/index.md rename to content/docs/setup/kubernetes/platform-setup/minikube/index.md index 2819acd454..ed0dcbe0a4 100644 --- a/content/docs/setup/kubernetes/minikube/index.md +++ b/content/docs/setup/kubernetes/platform-setup/minikube/index.md @@ -1,8 +1,8 @@ --- -title: Platform setup for Minikube -description: Instructions to setup Minikube for use with Istio -weight: 10 -keywords: [kubernetes,minikube] +title: Minikube +description: Instructions to setup Minikube for use with Istio. +weight: 15 +keywords: [platform-setup,kubernetes,minikube] --- To setup the Kubernetes cluster for Istio with Minikube, follow these instructions: diff --git a/content/docs/setup/kubernetes/openshift/index.md b/content/docs/setup/kubernetes/platform-setup/openshift/index.md similarity index 90% rename from content/docs/setup/kubernetes/openshift/index.md rename to content/docs/setup/kubernetes/platform-setup/openshift/index.md index ab3010c1e8..3da5a47cd9 100644 --- a/content/docs/setup/kubernetes/openshift/index.md +++ b/content/docs/setup/kubernetes/platform-setup/openshift/index.md @@ -1,11 +1,11 @@ --- -title: Platform setup for Openshift -description: Instructions to setup the Openshift cluster for Istio. -weight: 13 -keywords: [openshift] +title: OpenShift +description: Instructions to setup an OpenShift cluster for Istio. +weight: 18 +keywords: [platform-setup,openshift] --- -To setup the Openshift cluster for Istio, follow these instructions: +To setup an OpenShift cluster for Istio, follow these instructions: By default, OpenShift doesn't allow containers running with user ID 0. diff --git a/content/docs/setup/kubernetes/quick-start-gke-dm/index.md b/content/docs/setup/kubernetes/quick-start-gke-dm/index.md index 0e4f6e2b7b..6bdc5a57d7 100644 --- a/content/docs/setup/kubernetes/quick-start-gke-dm/index.md +++ b/content/docs/setup/kubernetes/quick-start-gke-dm/index.md @@ -1,7 +1,7 @@ --- title: Quick Start with Google Kubernetes Engine description: Quick Start instructions to setup the Istio service using Google Kubernetes Engine (GKE) -weight: 2 +weight: 20 keywords: [kubernetes,gke,google] --- diff --git a/content/docs/setup/kubernetes/quick-start/index.md b/content/docs/setup/kubernetes/quick-start/index.md index b4dc09fa8f..a896fa9070 100644 --- a/content/docs/setup/kubernetes/quick-start/index.md +++ b/content/docs/setup/kubernetes/quick-start/index.md @@ -1,24 +1,23 @@ --- title: Quick Start with Kubernetes description: Instructions to setup the Istio service mesh in a Kubernetes cluster. -weight: 1 +weight: 5 keywords: [kubernetes] --- -To install and configure Istio in a Kubernetes -cluster, follow these instructions: +To install and configure Istio in a Kubernetes cluster, follow these instructions: ## Prerequisites 1. [Download the Istio release](/docs/setup/kubernetes/download-release/). -1. Kubernetes platform setup - * [Minikube](/docs/setup/kubernetes/minikube/) - * [Google Container Engine (GKE)](/docs/setup/kubernetes/gke/) - * [IBM Cloud Kubernetes Service (IKS)](/docs/setup/kubernetes/ibm/) - * [Openshift Origin](/docs/setup/kubernetes/openshift/) - * [Amazon Web Services (AWS) with Kops](/docs/setup/kubernetes/aws/) - * [Azure](/docs/setup/kubernetes/azure/) +1. [Kubernetes platform setup](/docs/setup/kubernetes/platform-setup/): + * [Minikube](/docs/setup/kubernetes/platform-setup/minikube/) + * [Google Container Engine (GKE)](/docs/setup/kubernetes/platform-setup/gke/) + * [IBM Cloud Kubernetes Service (IKS)](/docs/setup/kubernetes/platform-setup/ibm/) + * [OpenShift Origin](/docs/setup/kubernetes/platform-setup/openshift/) + * [Amazon Web Services (AWS) with Kops](/docs/setup/kubernetes/platform-setup/aws/) + * [Azure](/docs/setup/kubernetes/platform-setup/azure/) ## Installation steps diff --git a/content/docs/setup/kubernetes/sidecar-injection/index.md b/content/docs/setup/kubernetes/sidecar-injection/index.md index 3cc884bcce..6c115376db 100644 --- a/content/docs/setup/kubernetes/sidecar-injection/index.md +++ b/content/docs/setup/kubernetes/sidecar-injection/index.md @@ -1,7 +1,7 @@ --- title: Installing the Istio sidecar description: Instructions for installing the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI. -weight: 3 +weight: 30 keywords: [kubernetes,sidecar,sidecar-injection] aliases: - /docs/setup/kubernetes/automatic-sidecar-inject.html diff --git a/content/docs/setup/kubernetes/upgrading-istio/index.md b/content/docs/setup/kubernetes/upgrading-istio/index.md index 3151a37e11..c27f595ef2 100644 --- a/content/docs/setup/kubernetes/upgrading-istio/index.md +++ b/content/docs/setup/kubernetes/upgrading-istio/index.md @@ -1,7 +1,7 @@ --- title: Upgrading Istio description: Demonstrates how to upgrade the Istio control plane and data plane independently. -weight: 7 +weight: 70 keywords: [kubernetes,upgrading] --- diff --git a/content_zh/docs/setup/kubernetes/helm-install/index.md b/content_zh/docs/setup/kubernetes/helm-install/index.md index cf6eaa3230..bd6ac9b6dd 100644 --- a/content_zh/docs/setup/kubernetes/helm-install/index.md +++ b/content_zh/docs/setup/kubernetes/helm-install/index.md @@ -14,13 +14,7 @@ aliases: ## 先决条件 1. [下载 Istio 的发布版本](/docs/setup/kubernetes/download-release/)。 -1. [在 Kubernetes 中安装 Istio] - * [Minikube](/docs/setup/kubernetes/minikube/) - * [Google Container Engine (GKE)](/docs/setup/kubernetes/gke/) - * [IBM Cloud Kubernetes Service (IKS)](/docs/setup/kubernetes/ibm/) - * [Openshift Origin](/docs/setup/kubernetes/openshift/) - * [Amazon Web Services (AWS) with Kops](/docs/setup/kubernetes/aws/) - * [Azure](/docs/setup/kubernetes/azure/) +1. [在 Kubernetes 中安装 Istio](/docs/setup/kubernetes/platform-setup/) ## 安装步骤 @@ -119,4 +113,4 @@ istio-pilot-58c65f74bc-2f5xn 2/2 Running 0 1m {{< text bash >}} $ kubectl -n istio-system delete job --all - {{< /text >}} \ No newline at end of file + {{< /text >}}