Skip to content

Commit

Permalink
Removed red boxes, and removed pages of untested instances and tried …
Browse files Browse the repository at this point in the history
…to remove references to other installation methods
  • Loading branch information
scoyle391 committed Dec 2, 2019
1 parent c6ac249 commit 4255701
Show file tree
Hide file tree
Showing 17 changed files with 11 additions and 641 deletions.
69 changes: 0 additions & 69 deletions about/quickstart.md

This file was deleted.

2 changes: 1 addition & 1 deletion concepts/ambassador-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In an on-premise data center, the Ambassador Edge Stack is deployed on the Kuber

## Hybrid data center

Many data centers include services that are running outside of Kubernetes on bare metal or virtual machines. In order for the Ambassador Edge Stack to route to services both inside and outside of Kubernetes, it needs the real-time network location of all services. This problem is known as "[service discovery](https://www.datawire.io/guide/traffic/service-discovery-microservices/)" and the Ambassador Edge Stack supports using [Consul](https://www.consul.io). Services in your data center register themselves with Consul, and the Ambassador Edge Stack uses Consul-supplied data to dynamically route requests to available services.
Many data centers include services that are running outside of Kubernetes on virtual machines. In order for the Ambassador Edge Stack to route to services both inside and outside of Kubernetes, it needs the real-time network location of all services. This problem is known as "[service discovery](https://www.datawire.io/guide/traffic/service-discovery-microservices/)" and the Ambassador Edge Stack supports using [Consul](https://www.consul.io). Services in your data center register themselves with Consul, and the Ambassador Edge Stack uses Consul-supplied data to dynamically route requests to available services.

## Hybrid on-premise data center

Expand Down
8 changes: 0 additions & 8 deletions doc-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,6 @@
link: /user-guide/install
- title: Kubernetes (YAML)
link: /user-guide/getting-started
- title: Kubernetes (Helm)
link: /user-guide/helm
- title: Kubernetes Bare Metal
link: /user-guide/bare-metal
- title: Docker Quickstart
link: /about/quickstart
- title: Docker Compose
link: /user-guide/docker-compose
- title: Other Install & Upgrade Options
items:
- title: Upgrade Ambassador OSS to Ambassador Edge Stack
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Ambassador Edge Stack is a production tested, open source API Gateway that exposes the power of [Envoy Proxy](https://www.envoyproxy.io) in Kubernetes.

* [Install Ambassador Edge Stack](/user-guide/install). Quick start instructions for deploying Ambassador Edge Stack for both development environments (Docker, Docker Compose) and Kubernetes (via Kubernetes YAML or Helm).
* [Install Ambassador Edge Stack](/user-guide/install). Quick start instructions for deploying Ambassador Edge Stack for development and Kubernetes environments.

* [Concepts](/concepts/overview). Core concepts that cover the architecure of Ambassador Edge Stack and how it should be used.

Expand Down
42 changes: 0 additions & 42 deletions reference/ambassador-with-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,48 +94,6 @@ spec:

In this configuration, an ELB is deployed with a multi-domain AWS Certificate Manager certificate and configured to terminate TLS on requests over port 443 and forward to Ambassador Edge Stack listening for cleartext on 8080. The ELB is configured to route TCP to support both WebSockets and HTTP. It also enables the proxy protocol so Ambassador Edge Stack needs to be configured to handle that by configuring an Ambassador Edge Stack `Module`.

## Helm Values Configuration

The following in a sample configuration for deploying Ambassador Edge Stack in AWS with some load balancer annotations using the Ambassador Edge Stack Helm chart.

Create a values file with the following content:

`values.aws.yaml`
```yaml
service:
http:
enabled: true
port: 80
targetPort: 8080

https:
enabled: true
port: 443
targetPort: 8443

annotations:
service.beta.kubernetes.io/aws-load-balancer-ssl-cert: "{{ tls certificate arn }}"
service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "443"
service.beta.kubernetes.io/aws-load-balancer-backend-protocol: "http"
service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: "true"
getambassador.io/config: |
---
apiVersion: getambassador.io/v2
kind: Module
name: ambassador
config:
use_proxy_proto: false
use_remote_address: false
x_forwarded_proto_redirect: true
```

Install with:
```
helm install --name ambassador stable/ambassador
```

In this configuration, an ELB is deployed with a multi-domain AWS Certificate Manager certificate. The ELB is configured to route in L7 mode, which means only HTTP(S) traffic is supported, and not web sockets. TLS termination occurs at the ELB. Automatic redirection of HTTP to HTTPS is enabled. Downstream services can extract the client IP from the `X-FORWARDED-FOR` header

## TLS Termination

As with any Kubernetes environment, Ambassador Edge Stack can be configured to perform SSL offload by configuring a tls [`Module`](/reference/core/tls) or [`TLSContext`](/user-guide/sni). Refer to the [TLS Termination](/user-guide/tls-termination) documentation for more information.
Expand Down
2 changes: 1 addition & 1 deletion reference/filter-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ spec:
starting indent level.

**Note**: If you are using a templating system for your YAML that also
makes use of Go templating (for instance, Helm), then you will need to
makes use of Go templating, then you will need to
escape the template strings meant to be interpreted by the Ambassador Edge
Stack.

Expand Down
2 changes: 1 addition & 1 deletion reference/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ existing file into a directory will fail.)

## Running as daemonset

Ambassador can be deployed as daemonset to have one pod per node in Kubernetes cluster. This setup is especially helpful when you have Kubernetes cluster running on bare metal or private cloud.
Ambassador can be deployed as daemonset to have one pod per node in Kubernetes cluster. This setup is especially helpful when you have Kubernetes cluster running on a private cloud.

* Ideal scenario could be when you are running containers on Kubernetes along side with your non containerized applications running exposed via VIP using BIG-IP or similar products. In such cases, east-west traffic is routed based on iRules to certain set of application pools consisting of application or web servers. In this setup, along side of traditonal application servers, two or more Ambassador pods can also be part of the application pools. In case of failure there is atleast one Ambassdor pod available to BIG-IP and can take care of routing traffic to kubernetes cluster.

Expand Down
15 changes: 0 additions & 15 deletions reference/statistics.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,21 +62,6 @@ For example, by default each service that the API Gateway serves will create a n

[Follow this guide](https://github.com/prometheus/statsd_exporter/tree/v0.6.0#metric-mapping-and-configuration) to learn how to modify your mappings.

#### Configuring for Helm

If you deploy using Helm the value that you should change is `prometheusExporter.configuration`. Set it to something like this:

```yaml
configuration: |
---
mappings:
- match: 'envoy.cluster.*.upstream_rq_total'
name: "envoy_cluster_upstream_rq_total"
timer_type: 'histogram'
labels:
cluster_name: "$1"
```

#### Configuring for kubectl

In the [ambassador-rbac-prometheus](https://github.com/datawire/ambassador/blob/master/templates) example template there is a `ConfigMap` that should be updated. Add your mapping to the `configuration` property.
Expand Down
98 changes: 0 additions & 98 deletions user-guide/bare-metal.md

This file was deleted.

8 changes: 2 additions & 6 deletions user-guide/consul.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Consul Integration

[Consul](https://www.consul.io) is a widely used service mesh. Ambassador Edge Stack natively supports Consul for service discovery and end-to-end TLS (including mTLS between services). This capability is particularly useful when deploying Ambassador Edge Stack in so-called hybrid clouds, where applications are deployed on bare metal, VMs, and Kubernetes. In this environment, Ambassador Edge Stack can securely route over TLS to any application regardless of where it is deployed.
[Consul](https://www.consul.io) is a widely used service mesh. Ambassador Edge Stack natively supports Consul for service discovery and end-to-end TLS (including mTLS between services). This capability is particularly useful when deploying Ambassador Edge Stack in so-called hybrid clouds, where applications are deployed on VMs and Kubernetes. In this environment, Ambassador Edge Stack can securely route over TLS to any application regardless of where it is deployed.

## Architecture Overview

Expand All @@ -14,10 +14,6 @@ In this guide, you will register a service with Consul and use Ambassador Edge S

1. Install and configure Consul ([instructions](https://www.consul.io/docs/platform/k8s/index.html)). Consul can be deployed anywhere in your data center.

**Note**
- If you are using the [Consul Helm Chart](https://www.consul.io/docs/platform/k8s/helm.html) for installation, you must install the latest version of both the [Chart](https://github.com/hashicorp/consul-helm) and the Consul binary itself (configurable via the [`values.yaml`](https://www.consul.io/docs/platform/k8s/helm.html#configuration-values-) file). `git checkout` the most recent tag in the [consul-helm](https://github.com/hashicorp/consul-helm) repository to get the latest version of the Consul Helm chart.
- If you would like to enable end-to-end TLS between all of your APIs in Kubernetes, you will need to set `connectInject.enabled: true` and `client.grpc: true` in the values.yaml file.

2. Deploy Ambassador Edge Stack. Note: If this is your first time deploying Ambassador Edge Stack, reviewing the [quick start guide](/user-guide/getting-started) is strongly recommended.

```
Expand Down Expand Up @@ -55,7 +51,7 @@ In this guide, you will register a service with Consul and use Ambassador Edge S

## Routing to Consul Services

You'll now register a demo application with Consul, and show how Ambassador Edge Stack can route to this application using endpoint data from Consul. To simplify this tutorial, you'll deploy the application in Kubernetes, although in practice this application can be deployed anywhere in your data center (e.g., on VMs or bare metal).
You'll now register a demo application with Consul, and show how Ambassador Edge Stack can route to this application using endpoint data from Consul. To simplify this tutorial, you'll deploy the application in Kubernetes, although in practice this application can be deployed anywhere in your data center (e.g., on VMs).

1. Deploy the QOTM demo application. The QOTM application contains code to automatically register itself with Consul, using the CONSUL_IP and POD_IP environment variables specified within the QOTM container spec.

Expand Down
Loading

0 comments on commit 4255701

Please sign in to comment.