Skip to content

Commit 5a68698

Browse files
committed
Update 1.14 for productName, OSSproductName, and AESproductName
Signed-off-by: Phil Peble <[email protected]>
1 parent df0216e commit 5a68698

File tree

101 files changed

+1172
-1172
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+1172
-1172
lines changed
+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# $productName$ vs. other software
1+
# Emissary vs. other software
22

3-
Alternatives to the $productName$ fall into three basic categories:
3+
Alternatives to the Emissary fall into three basic categories:
44

55
* Hosted API gateways, such as the [Amazon API gateway](https://aws.amazon.com/api-gateway/).
66
* Traditional API gateways, such as [Kong](https://konghq.org/).
@@ -12,8 +12,8 @@ Both hosted API gateways and traditional API gateways are:
1212
* Not Kubernetes-native. They're typically configured using REST APIs, making it challenging to adopt cloud-native patterns such as GitOps and declarative configuration.
1313
* [Designed for API management, versus microservices](../../topics/concepts/microservices-api-gateways).
1414

15-
A Layer 7 proxy can be used as an API gateway, but typically requires additional bespoke development to support microservices use cases. In fact, many API gateways package the additional features needed for an API gateway on top of an L7 proxy. The $productName$ uses Envoy, while Kong uses NGINX. If you're interested in deploying Envoy directly, we've written an [introductory tutorial](https://www.datawire.io/guide/traffic/getting-started-lyft-envoy-microservices-resilience/).
15+
A Layer 7 proxy can be used as an API gateway, but typically requires additional bespoke development to support microservices use cases. In fact, many API gateways package the additional features needed for an API gateway on top of an L7 proxy. The Emissary uses Envoy, while Kong uses NGINX. If you're interested in deploying Envoy directly, we've written an [introductory tutorial](https://www.datawire.io/guide/traffic/getting-started-lyft-envoy-microservices-resilience/).
1616

1717
## Istio
1818

19-
[Istio](https://istio.io) is an open-source service mesh, built on Envoy. A service mesh is designed to manage East/West traffic (traffic between servers and your data center), while an API gateway manages North/South traffic (in and out of your data center). Documentation on how to deploy the $productName$ with Istio is [here](../../howtos/istio). In general, we've found that North/South traffic is quite different from East/West traffic (i.e., you don't control the client in the North/South use case).
19+
[Istio](https://istio.io) is an open-source service mesh, built on Envoy. A service mesh is designed to manage East/West traffic (traffic between servers and your data center), while an API gateway manages North/South traffic (in and out of your data center). Documentation on how to deploy the Emissary with Istio is [here](../../howtos/istio). In general, we've found that North/South traffic is quite different from East/West traffic (i.e., you don't control the client in the North/South use case).

content/en/docs/1.14/about/faq.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,52 @@
22

33
## General
44

5-
### Why $productName$?
5+
### Why Emissary?
66

77
Kubernetes shifts application architecture for microservices, as well as the
8-
development workflow for a full-cycle development. $productName$ is designed for
8+
development workflow for a full-cycle development. Emissary is designed for
99
the Kubernetes world with:
1010

1111
* Sophisticated traffic management capabilities (thanks to its use of [Envoy Proxy](https://www.envoyproxy.io)), such as load balancing, circuit breakers, rate limits, and automatic retries.
1212
* API management capabilities such as a developer portal and OpenID Connect integration for Single Sign-On.
1313
* A declarative, self-service management model built on Kubernetes Custom Resource Definitions, enabling GitOps-style continuous delivery workflows.
1414

15-
We've written about [the history of $productName$](https://blog.getambassador.io/building-ambassador-an-open-source-api-gateway-on-kubernetes-and-envoy-ed01ed520844), [Why $productName$ In Depth](../why-ambassador), [Features and Benefits](../features-and-benefits) and about the [evolution of API Gateways](../../topics/concepts/microservices-api-gateways/).
15+
We've written about [the history of Emissary](https://blog.getambassador.io/building-ambassador-an-open-source-api-gateway-on-kubernetes-and-envoy-ed01ed520844), [Why Emissary In Depth](../why-ambassador), [Features and Benefits](../features-and-benefits) and about the [evolution of API Gateways](../../topics/concepts/microservices-api-gateways/).
1616

17-
### What's the difference between the $OSSproductName$ and the $AESproductName$?
17+
### What's the difference between the Emissary and the Ambassador Edge Stack?
1818

19-
The $OSSproductName$ was the name of the original open-source project. As the project evolved, we realized that the functionality we were building had extended far beyond an API Gateway. In particular, the $AESproductName$ is intended to provide all the functionality you need at the edge -- hence, an "edge stack." This includes an API Gateway, ingress controller, load balancer, developer portal, and more.
19+
The Emissary was the name of the original open-source project. As the project evolved, we realized that the functionality we were building had extended far beyond an API Gateway. In particular, the Ambassador Edge Stack is intended to provide all the functionality you need at the edge -- hence, an "edge stack." This includes an API Gateway, ingress controller, load balancer, developer portal, and more.
2020

21-
### How is $AESproductName$ licensed?
21+
### How is Ambassador Edge Stack licensed?
2222

23-
The core $OSSproductName$ is open source under the Apache Software License 2.0. The GitHub repository for the core is [https://github.com/datawire/ambassador](https://github.com/datawire/ambassador). Some additional features of the $AESproductName$ (e.g., Single Sign-On) are not open source and available under a proprietary license.
23+
The core Emissary is open source under the Apache Software License 2.0. The GitHub repository for the core is [https://github.com/datawire/ambassador](https://github.com/datawire/ambassador). Some additional features of the Ambassador Edge Stack (e.g., Single Sign-On) are not open source and available under a proprietary license.
2424

25-
### Can I use the add-on features for $AESproductName$ for free?
25+
### Can I use the add-on features for Ambassador Edge Stack for free?
2626

27-
Yes! The core functionality of the $AESproductName$ is free and has no limits whatsoever. If you wish to use one of our additional, proprietary features such as Single Sign-On, you can get a free community license for up to 5 requests per second. Please contact [sales](/contact-us/) if you need more than 5 RPS.
27+
Yes! The core functionality of the Ambassador Edge Stack is free and has no limits whatsoever. If you wish to use one of our additional, proprietary features such as Single Sign-On, you can get a free community license for up to 5 requests per second. Please contact [sales](/contact-us/) if you need more than 5 RPS.
2828

2929
For more details on core unlimited features and premium features, see the [editions page](/editions).
3030

31-
### How does $productName$ use Envoy Proxy?
31+
### How does Emissary use Envoy Proxy?
3232

33-
$productName$ uses [Envoy Proxy](https://www.envoyproxy.io) as its core proxy. Envoy is an open-source, high-performance proxy originally written by Lyft. Envoy is now part of the Cloud Native Computing Foundation.
33+
Emissary uses [Envoy Proxy](https://www.envoyproxy.io) as its core proxy. Envoy is an open-source, high-performance proxy originally written by Lyft. Envoy is now part of the Cloud Native Computing Foundation.
3434

35-
### Is $productName$ production ready?
35+
### Is Emissary production ready?
3636

37-
Yes. Thousands of organizations, large and small, run $productName$ in production.
37+
Yes. Thousands of organizations, large and small, run Emissary in production.
3838
Public users include Chick-Fil-A, ADP, Microsoft, NVidia, and AppDirect, among others.
3939

40-
### What is the performance of $productName$?
40+
### What is the performance of Emissary?
4141

42-
There are many dimensions to performance. We published a benchmark of [$productName$ performance on Kubernetes](/resources/envoyproxy-performance-on-k8s/). Our internal performance regressions cover many other scenarios; we expect to publish more data in the future.
42+
There are many dimensions to performance. We published a benchmark of [Emissary performance on Kubernetes](/resources/envoyproxy-performance-on-k8s/). Our internal performance regressions cover many other scenarios; we expect to publish more data in the future.
4343

44-
### What's the difference between a service mesh (such as Istio) and $productName$?
44+
### What's the difference between a service mesh (such as Istio) and Emissary?
4545

4646
Service meshes focus on routing internal traffic from service to service
47-
("east-west"). $productName$ focuses on traffic into your cluster ("north-south").
48-
While both a service mesh and $productName$ can route L7 traffic, the reality is that
49-
these use cases are quite different. Many users will integrate $productName$ with a
50-
service mesh. Production customers of $productName$ have integrated with Consul,
47+
("east-west"). Emissary focuses on traffic into your cluster ("north-south").
48+
While both a service mesh and Emissary can route L7 traffic, the reality is that
49+
these use cases are quite different. Many users will integrate Emissary with a
50+
service mesh. Production customers of Emissary have integrated with Consul,
5151
Istio, and Linkerd2.
5252

5353
## Common Configurations
@@ -56,7 +56,7 @@ Istio, and Linkerd2.
5656

5757
Established users will want to better control 404 behavior both for usability and
5858
security. You can leverage the Mapping resource to implement this functionality to
59-
your cluster. $productName$ users can use a 'catch-all' mapping using the '/'
59+
your cluster. Emissary users can use a 'catch-all' mapping using the '/'
6060
prefix in a mapping configuration. The simplest mapping, described below, returns only 404 text.
6161
To use a custom 404 landing page, simply insert your service and remove the rewrite value.
6262

@@ -78,7 +78,7 @@ For more information on the Mapping resource, see [Advanced Mapping Configuratio
7878
In a production environment, public access to the console and admin endpoints is not an
7979
ideal situation. To solve this, we will be using an Ambassador Module to remove the default
8080
mappings and create a new, host-based mapping to expose the Admin endpoint more securely. The
81-
Ambassador module applies system-wide configuration settings for $productName$ to follow.
81+
Ambassador module applies system-wide configuration settings for Emissary to follow.
8282
8383
```yaml
8484
apiVersion: getambassador.io/v2
@@ -113,7 +113,7 @@ learn more about Ambassador Module configurations, see [Ambassador Module](../..
113113
114114
## Troubleshooting
115115
116-
### How do I get help for $productName$?
116+
### How do I get help for Emissary?
117117
118118
We have an online [Slack community](http://a8r.io/slack) with thousands of
119119
users. We try to help out as often as possible, although we can't promise a
@@ -122,10 +122,10 @@ contracts. [Contact sales](/contact-us/) for more information.
122122
123123
### What do I do when I get the error `no healthy upstream`?
124124

125-
This error means that $productName$ could not connect to your backend service.
125+
This error means that Emissary could not connect to your backend service.
126126
Start by verifying that your backend service is actually available and
127127
responding by sending an HTTP response directly to the pod. Then, verify that
128-
$productName$ is routing by deploying a test service and seeing if the mapping
128+
Emissary is routing by deploying a test service and seeing if the mapping
129129
works. Then, verify that your load balancer is properly routing requests to
130-
$productName$. In general, verifying each network hop between your client and
130+
Emissary. In general, verifying each network hop between your client and
131131
backend service is critical to finding the source of the problem.
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
# Features and benefits
22

3-
In cloud-native organizations, developers frequently take on responsibility for the full development lifecycle of a service, from development to QA to operations. $productName$ was specifically designed for these organizations where developers have operational responsibility for their service(s).
3+
In cloud-native organizations, developers frequently take on responsibility for the full development lifecycle of a service, from development to QA to operations. Emissary was specifically designed for these organizations where developers have operational responsibility for their service(s).
44

5-
As such, the $productName$ is designed to be used by both developers and operators.
5+
As such, the Emissary is designed to be used by both developers and operators.
66

77
## Self-Service via Kubernetes Annotations
88

9-
$productName$ is built from the start to support _self-service_ deployments -- a developer working on a new service doesn't have to go to Operations to get their service added to the mesh, they can do it themselves in a matter of seconds. Likewise, a developer can remove their service from the mesh, or merge services, or separate services, as needed, at their convenience. All of these operations are performed via Kubernetes annotations, so it can easily integrate with your existing development workflow.
9+
Emissary is built from the start to support _self-service_ deployments -- a developer working on a new service doesn't have to go to Operations to get their service added to the mesh, they can do it themselves in a matter of seconds. Likewise, a developer can remove their service from the mesh, or merge services, or separate services, as needed, at their convenience. All of these operations are performed via Kubernetes annotations, so it can easily integrate with your existing development workflow.
1010

1111
## Flexible canary deployments
1212

13-
Canary deployments are an essential component of cloud-native development workflows. In a canary deployment, a small percentage of production traffic is routed to a new version of a service to test it under real-world conditions. $productName$ allows developers to easily control and manage the amount of traffic routed to a given service through annotations. [This tutorial](https://www.datawire.io/faster/canary-workflow/) covers a complete canary workflow using the $productName$.
13+
Canary deployments are an essential component of cloud-native development workflows. In a canary deployment, a small percentage of production traffic is routed to a new version of a service to test it under real-world conditions. Emissary allows developers to easily control and manage the amount of traffic routed to a given service through annotations. [This tutorial](https://www.datawire.io/faster/canary-workflow/) covers a complete canary workflow using the Emissary.
1414

1515
## Kubernetes-native architecture
1616

17-
$productName$ relies entirely on Kubernetes for reliability, availability, and scalability. For example, $productName$ persists all state in Kubernetes, instead of requiring a separate database. Scaling the $productName$ is as simple as changing the replicas in your deployment, or using a [horizontal pod autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/).
17+
Emissary relies entirely on Kubernetes for reliability, availability, and scalability. For example, Emissary persists all state in Kubernetes, instead of requiring a separate database. Scaling the Emissary is as simple as changing the replicas in your deployment, or using a [horizontal pod autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/).
1818

19-
$productName$ uses [Envoy](https://www.envoyproxy.io) for all traffic routing and proxying. Envoy is a modern L7 proxy that is used in production at companies including Lyft, Apple, Google, and Stripe.
19+
Emissary uses [Envoy](https://www.envoyproxy.io) for all traffic routing and proxying. Envoy is a modern L7 proxy that is used in production at companies including Lyft, Apple, Google, and Stripe.
2020

2121
## gRPC and HTTP/2 support
2222

23-
$productName$ fully supports gRPC and HTTP/2 routing, thanks to Envoy's extensive capabilities in this area. See [gRPC and the $productName$](../../howtos/grpc) for more information.
23+
Emissary fully supports gRPC and HTTP/2 routing, thanks to Envoy's extensive capabilities in this area. See [gRPC and the Emissary](../../howtos/grpc) for more information.
2424

2525
## Istio Integration
2626

27-
$productName$ integrates with the [Istio](https://istio.io) service mesh as the edge proxy. In this configuration, $productName$ routes external traffic to the internal Istio service mesh. See [Istio and the $productName$](../../howtos/istio) for details.
27+
Emissary integrates with the [Istio](https://istio.io) service mesh as the edge proxy. In this configuration, Emissary routes external traffic to the internal Istio service mesh. See [Istio and the Emissary](../../howtos/istio) for details.
2828

2929
## Authentication
3030

31-
$productName$ supports authenticating incoming requests with a [custom authentication service](../../howtos/basic-auth/), and $AESproductName$ natively supports OAuth/OpenID Connect, or JWT. When configured, the $AESproductName$ will check with a third party authentication service prior to routing an incoming request. For more information, see the [authentication guide](/docs/edge-stack/latest/topics/using/filters/).
31+
Emissary supports authenticating incoming requests with a [custom authentication service](../../howtos/basic-auth/), and Ambassador Edge Stack natively supports OAuth/OpenID Connect, or JWT. When configured, the Ambassador Edge Stack will check with a third party authentication service prior to routing an incoming request. For more information, see the [authentication guide](/docs/edge-stack/latest/topics/using/filters/).
3232

3333
## Rate limiting
3434

35-
$productName$ supports rate limiting incoming requests. When configured, the $productName$ will check with a third party rate limit service prior to routing an incoming request. For more information, see the [rate limiting guide](../../topics/using/rate-limits/).
35+
Emissary supports rate limiting incoming requests. When configured, the Emissary will check with a third party rate limit service prior to routing an incoming request. For more information, see the [rate limiting guide](../../topics/using/rate-limits/).
3636

3737
## Integrated UI
3838

39-
$productName$ includes a diagnostics service so that you can quickly debug issues associated with configuring the $productName$. For more information, see [running $productName$ in Production](../../topics/running).
39+
Emissary includes a diagnostics service so that you can quickly debug issues associated with configuring the Emissary. For more information, see [running Emissary in Production](../../topics/running).

0 commit comments

Comments
 (0)