refactor sandboxes -> getting started (#469)

Signed-off-by: Richard Li <richard@datawire.io>
pull/481/head
Richard Li 7 years ago committed by Matt Klein
parent 8185065874
commit dedd9ecac9
  1. 54
      docs/root/install/getting_started.rst
  2. 2
      docs/root/install/install.rst
  3. 12
      docs/root/install/ref_configs.rst
  4. 17
      docs/root/install/sandboxes/sandboxes.rst

@ -0,0 +1,54 @@
.. _install_getting_started:
Getting Started
===============
This section features sample configurations and guides to quickly getting started with Envoy.
A basic configuration
---------------------
A very minimal Envoy configuration that can be used to validate basic plain HTTP
proxying is available in :repo:`configs/google_com_proxy.v2.yaml`. This is not
intended to represent a realistic Envoy deployment.
Copy both :repo:`configs/Dockerfile` and
:repo:`configs/google_com_proxy.v2.yaml` to the same directory on your local
disk. Then, build and run the Dockerfile, and test out Envoy by sending a
request to port 10000::
$ docker build -t envoy-google-test:v1 .
$ docker run -d -p 10000:10000 envoy-google-test:v1
$ curl -v localhost:10000
The Dockerfile will build a container containing the latest version of Envoy,
and copy a basic Envoy configuration into the container. This basic
configuration tells Envoy to route incoming requests to \*.google.com.
Sandboxes
---------
We've created a number of sandboxes using Docker Compose that set up different
environments to test out Envoy's features and show sample configurations. As we
gauge peoples' interests we will add more sandboxes demonstrating different
features. The following sandboxes are available:
.. toctree::
:maxdepth: 1
sandboxes/front_proxy
sandboxes/zipkin_tracing
sandboxes/jaeger_tracing
sandboxes/grpc_bridge
Modifying Envoy
---------------
If you're interested in modifying Envoy and testing your changes, one approach
is to use Docker. This guide will walk through the process of building your own
Envoy binary, and putting the binary in an Ubuntu container.
.. toctree::
:maxdepth: 1
sandboxes/local_docker_build

@ -7,6 +7,6 @@ Building and installation
:maxdepth: 2
building
getting_started
ref_configs
sandboxes/sandboxes.rst
tools/tools

@ -56,15 +56,3 @@ A few notes about the example configurations:
reference configuration and it is assumed to be running at `rds.yourcompany.net`.
* :ref:`Cluster discovery service <config_cluster_manager_cds>` is configured for the service to
service reference configuration and it is assumed that be running at `cds.yourcompany.net`.
Smoketest configuration
-----------------------
A very minimal Envoy configuration that can be used to validate basic plain HTTP proxying is
available in :repo:`configs/google_com_proxy.json`. This is not intended to represent a realistic
Envoy deployment. To smoketest Envoy with this, run:
.. code-block:: console
build/source/exe/envoy -c configs/google_com_proxy.json -l debug
curl -v localhost:10000

@ -1,17 +0,0 @@
.. _install_sandboxes:
Sandboxes
=========
The docker-compose sandboxes give you different environments to test out Envoy's
features. As we gauge people's interests we will add more sandboxes demonstrating
different features. The following sandboxes are available:
.. toctree::
:maxdepth: 1
front_proxy
zipkin_tracing
jaeger_tracing
grpc_bridge
local_docker_build
Loading…
Cancel
Save