Setup cleanup (#509)

* categorizing install docs

* merge and clean

* nits

* final nit

* fixing links
This commit is contained in:
Shriram Rajagopalan 2017-09-25 10:02:05 -04:00 committed by GitHub
parent 9213aca4bf
commit 4072cd3f99
37 changed files with 163 additions and 68 deletions

View File

@ -17,7 +17,7 @@ this infrastructure as a single mesh.
* Describe installation options. * Describe installation options.
* Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the * Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the
[Installation guide]({{home}}/docs/setup/install-kubernetes.html). [Installation guide]({{home}}/docs/setup/kubernetes/).
## Overview ## Overview

View File

@ -16,7 +16,7 @@ of Istio service mesh running on Kubernetes.
* Describe installation options. * Describe installation options.
* Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the * Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the
[Installation guide]({{home}}/docs/setup/install-kubernetes.html). [Installation guide]({{home}}/docs/setup/kubernetes/quick-start.html).
## Overview ## Overview

View File

@ -15,7 +15,7 @@ This sample uses the Bookinfo application to demonstrate policy enforcement usin
* Describe installation options. * Describe installation options.
* Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the * Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the
[Installation guide]({{home}}/docs/setup/install-kubernetes.html). [Installation guide]({{home}}/docs/setup/kubernetes/quick-start.html).
## Overview ## Overview

View File

@ -15,7 +15,7 @@ This sample demonstrates how to obtain uniform metrics, logs, traces across diff
* Describe installation options. * Describe installation options.
* Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the * Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the
[Installation guide]({{home}}/docs/setup/install-kubernetes.html). [Installation guide]({{home}}/docs/setup/kubernetes/quick-start.html).
## Overview ## Overview

View File

@ -15,7 +15,7 @@ This sample demonstrates how to obtain uniform metrics, logs, traces across diff
* Describe installation options. * Describe installation options.
* Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the * Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the
[Installation guide]({{home}}/docs/setup/install-kubernetes.html). [Installation guide]({{home}}/docs/setup/kubernetes/quick-start.html).
## Overview ## Overview

View File

@ -11,12 +11,6 @@ type: markdown
This guide demonstrates how to upgrade the Istio control plane and data plane independently. This guide demonstrates how to upgrade the Istio control plane and data plane independently.
## Before you begin
* Describe installation options.
* Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the
[Installation guide]({{home}}/docs/setup/install-kubernetes.html).
## Overview ## Overview
Placeholder. Placeholder.

View File

@ -11,12 +11,6 @@ type: markdown
This sample integrates third party services with Bookinfo and demonstrates how to use Istio service mesh to provide metrics, and routing functions for these services. This sample integrates third party services with Bookinfo and demonstrates how to use Istio service mesh to provide metrics, and routing functions for these services.
## Before you begin
* Describe installation options.
* Install Istio control plane in a Kubernetes cluster by following the quick start instructions in the
[Installation guide]({{home}}/docs/setup/install-kubernetes.html).
## Overview ## Overview
Placeholder. Placeholder.

View File

@ -10,9 +10,7 @@ type: markdown
--- ---
{% include home.html %} {% include home.html %}
Follow this link for the archive of [most recent stable release (0.1) documentation](https://istio.io/v-0.1/docs/). # Welcome to Istio
# Welcome to Istio {{site.data.istio.version}}
Welcome to Istio's latest documentation home page. From here you can learn all about Istio by following Welcome to Istio's latest documentation home page. From here you can learn all about Istio by following
the links below: the links below:

View File

@ -0,0 +1,12 @@
---
title: FAQ
overview: Frequently asked questions, current limitations and troubleshooting tips.
order: 100
draft: true
layout: docs
type: markdown
---
_This document is under construction._

View File

@ -0,0 +1,17 @@
---
title: Cloud Foundry
overview: Instructions for installing the Istio control plane in Cloud Foundry.
order: 30
layout: docs
type: markdown
---
{% include section-index.html %}
We are working with the Cloud Foundry developers to integrate Istio
natively into the Cloud Foundry platform. Tune
into the
[Istio Developers](https://groups.google.com/forum/#!forum/istio-dev)
mailing list for updates.

View File

@ -0,0 +1,15 @@
---
title: Installation
overview: Instructions for installing the Istio control plane in Cloud Foundry.
order: 10
layout: docs
type: markdown
---
We are working with the Cloud Foundry developers to integrate Istio
natively into the Cloud Foundry platform. Tune
into the
[Istio Developers](https://groups.google.com/forum/#!forum/istio-dev)
mailing list for updates.

12
_docs/setup/consul/faq.md Normal file
View File

@ -0,0 +1,12 @@
---
title: FAQ
overview: Frequently asked questions, current limitations and troubleshooting tips.
order: 100
draft: true
layout: docs
type: markdown
---
_This document is under construction._

View File

@ -0,0 +1,11 @@
---
title: Nomad & Consul
overview: Instructions for installing the Istio control plane in a Consul based environment, with or without Nomad.
order: 20
layout: docs
type: markdown
---
{% include section-index.html %}

View File

@ -1,6 +1,6 @@
--- ---
title: Istio with Consul title: Installation
overview: Quick Start instructions to setup the Istio service mesh in Consul-based infrastructure. overview: Instructions for installing the Istio control plane in a Consul based environment, with or without Nomad.
order: 30 order: 30

View File

@ -1,15 +1,15 @@
--- ---
title: Using the Istio Initializer title: Automatic sidecar injection
overview: This task shows you how to use the Istio Initializer for automatic sidecar proxy injection overview: Instructions for installing the Istio initializer in Kubernetes to automatically inject the Istio sidecar into pods.
order: 40 order: 50
layout: docs layout: docs
type: markdown type: markdown
--- ---
{% include home.html %} {% include home.html %}
This task shows how to use the Istio Initializer for automatic sidecar This page provides instructions to setup the Istio Initializer for automatic sidecar
proxy injection. You'll learn how to enable the prerequisite alpha proxy injection. You'll learn how to enable the prerequisite alpha
features in your cluster, enable the initializer, and fine-tune the features in your cluster, enable the initializer, and fine-tune the
configuration of the initializer itself and your workloads to enable configuration of the initializer itself and your workloads to enable
@ -327,7 +327,3 @@ workloads.
```bash ```bash
kubectl delete -f install/kubernetes/istio-initializer.yaml kubectl delete -f install/kubernetes/istio-initializer.yaml
``` ```
## What's next
* See the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample for a more complete example of applications integrated on Kubernetes with Istio.

View File

@ -0,0 +1,11 @@
---
title: FAQ
overview: Frequently asked questions, current limitations and troubleshooting tips.
order: 100
layout: docs
type: markdown
---
_This document is under construction._

View File

Before

Width:  |  Height:  |  Size: 176 KiB

After

Width:  |  Height:  |  Size: 176 KiB

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

@ -0,0 +1,12 @@
---
title: Kubernetes
overview: Instructions for installing the Istio control plane on Kubernetes and adding VMs into the mesh.
order: 10
layout: docs
type: markdown
redirect_from: "/docs/tasks/installing-istio.html"
---
{% include section-index.html %}

View File

@ -1,6 +1,6 @@
--- ---
title: Installing Istio Sidecar title: Manual Sidecar Installation
overview: This task shows you how to integrate your applications with the Istio service mesh. overview: Instructions for manually adding the Istio sidecar into application pods.
order: 40 order: 40

View File

@ -1,8 +1,8 @@
--- ---
title: Istio Quick Start - Kubernetes title: Quick Start
overview: Quick Start instructions to setup the Istio service mesh in a Kubernetes cluster. overview: Quick Start instructions to setup the Istio service mesh in a Kubernetes cluster.
order: 20 order: 10
layout: docs layout: docs
type: markdown type: markdown

12
_docs/setup/mesos/faq.md Normal file
View File

@ -0,0 +1,12 @@
---
title: FAQ
overview: Frequently asked questions, current limitations and troubleshooting tips.
order: 100
draft: true
layout: docs
type: markdown
---
_This document is under construction._

View File

@ -0,0 +1,11 @@
---
title: Mesos
overview: Instructions for installing the Istio control plane in Apache Mesos.
order: 40
layout: docs
type: markdown
---
{% include section-index.html %}

View File

@ -0,0 +1,14 @@
---
title: Installation
overview: Instructions for installing the Istio control plane in Apache Mesos.
order: 10
layout: docs
type: markdown
---
Native support for Istio is currently unavailable in Mesos. However, you
might be able to leverage our Consul integration to run an Istio Mesh on
Mesos along with Consul. Refer to the
[Consul installation]({{home}}/docs/setup/consul/install.html) for more details.

View File

@ -14,8 +14,8 @@ This task shows you how to use Istio to dynamically limit the traffic to a servi
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the * Setup Istio in a Kubernetes cluster by following the quick start instructions in the
[Installation guide](({{home}}/docs/setup/). [Installation guide]({{home}}/docs/setup/kubernetes/quick-start.html).
* Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application. * Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application.

View File

@ -15,7 +15,7 @@ This task shows how to use Istio to control access to a service.
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the * Setup Istio by following the instructions in the
[Installation guide](({{home}}/docs/setup/). [Installation guide]({{home}}/docs/setup/kubernetes/quick-start.html).
* Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application. * Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application.

View File

@ -9,10 +9,7 @@ type: markdown
--- ---
{% include home.html %} {% include home.html %}
This page summarizes frequently asked questions and the team can be reached via slack (istio.slack.com ### Can a service with Istio Auth enabled communicate with a service without Istio?
#auth channel) or google groups (https://groups.google.com/forum/#!forum/istio-users).
### Can a service with Istio Auth enabled communicate a service without Istio?
Currently it is not well supported. But we do have plan to support this in the near future. Currently it is not well supported. But we do have plan to support this in the near future.
@ -28,20 +25,9 @@ Istio Auth issued certs. A workaround is to use command option for health check,
curl in the service pod and curl itself within the pod. Moreover, this is a temporary workaround. The curl in the service pod and curl itself within the pod. Moreover, this is a temporary workaround. The
Auth team is actively working on a real solution. Auth team is actively working on a real solution.
### How can I access Kubernetes ApiServer with Auth enabled? ### Can I access the Kubernetes API Server with Auth enabled?
It will not work from service container since the traffic will be intercepted by Istio proxy, and The Kubernetes API server does not support mutual TLS
ApiServer cannot recognize Istio Auth issued certs. You can either turn off Istio Auth or access authentication. Hence, when Istio mTLS authentication is enabled, it is
ApiServer in the proxy container. currently not possible to communicate from a pod with Istio sidecar to the
Kubernetes API server.
To ssh into the proxy container:
```bash
$ kubectl exec -it myPod -c istio-proxy /bin/bash
```
Access ApiServer within the proxy container:
```bash
# curl https://kubernetes/api/v1/namespaces/default/secrets -H "Authorization: Bearer $(cat /var/run/secrets/kubernetes.io/serviceaccount/token)" -k -v
```

View File

@ -2,7 +2,7 @@
title: Security title: Security
overview: Describes tasks that help securing the service mesh traffic. overview: Describes tasks that help securing the service mesh traffic.
order: 20 order: 40
layout: docs layout: docs
type: markdown type: markdown

View File

@ -21,9 +21,9 @@ Through this task, you will learn how to:
This task assumes you have a Kubernetes cluster: This task assumes you have a Kubernetes cluster:
* Installed Istio with Auth by following * Installed Istio with Auth by following
[the Istio installation task]({{home}}/docs/setup/install-kubernetes.html). [the Istio installation task]({{home}}/docs/setup/kubernetes/quick-start.html).
Note to choose "enable Istio Auth feature" at step 5 in Note to choose "enable Istio Auth feature" at step 5 in
"[Installation steps]({{home}}/docs/setup/install-kubernetes.html#installation-steps)". "[Installation steps]({{home}}/docs/setup/kubernetes/quick-start.html#installation-steps)".
## Verifying Istio Auth setup ## Verifying Istio Auth setup

View File

@ -22,7 +22,7 @@ example application for this task.
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the [Installation guide](({{home}}/docs/setup/). * Setup Istio by following the instructions in the [Installation guide]({{home}}/docs/setup/).
If you didn't start the Zipkin or Jaeger addon during installation, If you didn't start the Zipkin or Jaeger addon during installation,
you can run the following command to start it now: you can run the following command to start it now:

View File

@ -2,7 +2,7 @@
title: Metrics, Logs, and Traces title: Metrics, Logs, and Traces
overview: Describes tasks that demonstrate how to collect telemetry information from the service mesh. overview: Describes tasks that demonstrate how to collect telemetry information from the service mesh.
order: 20 order: 30
layout: docs layout: docs
type: markdown type: markdown

View File

@ -21,7 +21,7 @@ or alternatively, to simply bypass the Istio proxy for a specific range of IPs.
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the * Setup Istio by following the instructions in the
[Installation guide](({{home}}/docs/setup/). [Installation guide]({{home}}/docs/setup/).
* Start the [sleep](https://github.com/istio/istio/tree/master/samples/sleep) sample * Start the [sleep](https://github.com/istio/istio/tree/master/samples/sleep) sample
which will be used as a test source for external calls. which will be used as a test source for external calls.

View File

@ -15,7 +15,7 @@ This task shows how to inject delays and test the resiliency of your application
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the * Setup Istio by following the instructions in the
[Installation guide](({{home}}/docs/setup/). [Installation guide]({{home}}/docs/setup/).
* Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application. * Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application.

View File

@ -2,7 +2,7 @@
title: Traffic Management title: Traffic Management
overview: Describes tasks that demonstrate traffic routing features of Istio service mesh. overview: Describes tasks that demonstrate traffic routing features of Istio service mesh.
order: 20 order: 10
layout: docs layout: docs
type: markdown type: markdown

View File

@ -18,7 +18,7 @@ to configure ingress behavior.
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the * Setup Istio by following the instructions in the
[Installation guide](({{home}}/docs/setup/). [Installation guide]({{home}}/docs/setup/).
* Make sure your current directory is the `istio` directory. * Make sure your current directory is the `istio` directory.

View File

@ -15,7 +15,7 @@ This task shows you how to configure dynamic request routing based on weights an
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the * Setup Istio by following the instructions in the
[Installation guide](({{home}}/docs/setup/). [Installation guide]({{home}}/docs/setup/).
* Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application. * Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application.

View File

@ -16,7 +16,7 @@ This task shows you how to setup request timeouts in Envoy using Istio.
## Before you begin ## Before you begin
* Setup Istio by following the instructions in the * Setup Istio by following the instructions in the
[Installation guide](({{home}}/docs/setup/). [Installation guide]({{home}}/docs/setup/).
* Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application. * Deploy the [BookInfo]({{home}}/docs/guides/bookinfo.html) sample application.