Revise a few docs to make it more clear (#670)

* Revise a few docs to make it more clear

* Address commment
This commit is contained in:
Tao Li 2017-10-17 21:16:13 -07:00 committed by GitHub
parent 91494243e0
commit dd07e4c89d
3 changed files with 18 additions and 2 deletions

View File

@ -17,7 +17,8 @@ To run the site locally with Docker, use the following command from the toplevel
```bash
# First time: (slow)
docker run --name istio-jekyll --volume=$(pwd):/srv/jekyll -it -p 127.0.0.1:4000:4000 jekyll/jekyll:3.5.2 sh -c "bundle install && rake test && jekyll serve"
# Subsequent, each time you want to see a new change and you stopped the previous run: (much faster)
# Then open browser with url 127.0.0.1:4000 to see the change.
# Subsequent, each time you want to see a new change and you stopped the previous run by ctrl+c: (much faster)
docker start istio-jekyll -a -i
# Clean up, only needed if you won't be previewing website changes for a long time or you want to start over:
docker rm istio-jekyll

View File

@ -56,6 +56,8 @@ the cluster IP address ranges to intercept.
```bash
export GCP_OPTS="--zone MY_ZONE --project MY_PROJECT"
```
```bash
install/tools/setupMeshEx.sh generateClusterEnv MY_CLUSTER_NAME
```
@ -79,7 +81,7 @@ install/tools/setupMeshEx.sh generateDnsmasq
Example generated file:
```bash
cat /etc/dnsmasq.d/kubedns
cat kubedns
```
```
server=/svc.cluster.local/10.150.0.7
@ -100,11 +102,15 @@ and install the setup:
# Check what the script does to see that it meets your needs.
# On a Mac, either brew install base64 or set BASE64_DECODE="/usr/bin/base64 -D"
export GCP_OPTS="--zone MY_ZONE --project MY_PROJECT"
```
```bash
install/tools/setupMeshEx.sh machineSetup VM_NAME
```
Or the equivalent manual steps:
------ Manual setup steps begin ------
* Copy the configuration files and Istio Debian files to each machine joining the cluster.
Save the files as `/etc/dnsmasq.d/kubedns` and `/var/lib/istio/envoy/cluster.env`.
@ -116,6 +122,7 @@ On the VM/external host:
```bash
host istio-pilot.istio-system
```
Example generated message:
```
# Verify you get the same address as shown as "EXTERNAL-IP" in 'kubectl get svc -n istio-system istio-pilot-ilb'
istio-pilot.istio-system has address 10.150.0.6
@ -124,12 +131,14 @@ istio-pilot.istio-system has address 10.150.0.6
# Check that you can resolve cluster IPs. The actual address will depend on your deployment.
host istio-pilot.istio-system.svc.cluster.local.
```
Example generated message:
```
istio-pilot.istio-system.svc.cluster.local has address 10.63.247.248
```
```bash
host istio-ingress.istio-system.svc.cluster.local.
```
Example generated message:
```
istio-ingress.istio-system.svc.cluster.local has address 10.63.243.30
```
@ -192,6 +201,7 @@ Get the debian packages from [github releases](https://github.com/istio/istio/re
systemctl start istio-auth-node-agent
```
------ Manual setup steps end ------
After setup, the machine should be able to access services running in the Kubernetes cluster
or other mesh expansion machines.

View File

@ -87,6 +87,11 @@ run the following command to download and extract the latest release automatical
* The `istioctl` client binary in the `bin/` directory. `istioctl` is used when manually injecting Envoy as a sidecar proxy and for creating routing rules and policies.
* The `istio.VERSION` configuration file
1. Change directory to istio package. For example, if the package is istio-0.2.7
```bash
cd istio-0.2.7
```
1. Add the `istioctl` client to your PATH.
For example, run the following command on a MacOS or Linux system:
```bash