Skip to content

Commit f6eb275

Browse files
authored
Merge pull request #7 from ppeble/version-38-fixes
Update AESproductName to Ambassador Edge Stack, productName to Emissary, and OSSproductName to Emissary
2 parents 2226973 + 7c97b54 commit f6eb275

File tree

114 files changed

+1350
-1224
lines changed

Some content is hidden

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

114 files changed

+1350
-1224
lines changed

content/en/docs/3.8/about/changes-2.x.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ the `AMBASSADOR_ENVOY_API_VERSION` environment variable) will be removed.
204204

205205
### More Performant Reconfiguration by Default
206206

207-
In Emissary 1.X, the environment variable `AMBASSADOR_FAST_RECONFIGURE` could be used to enable a higher performance implementation of the code Emissary uses to validate and generate Envoy configuration. In $productName$ 2.X, this higher-performance mode is always enabled.
207+
In Emissary 1.X, the environment variable `AMBASSADOR_FAST_RECONFIGURE` could be used to enable a higher performance implementation of the code Emissary uses to validate and generate Envoy configuration. In Emissary 2.X, this higher-performance mode is always enabled.
208208

209209
### Changes to the `ambassador` `Module`, and the `tls` `Module`
210210

content/en/docs/3.8/about/changes-3.y.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
title: Major Changes in Emissary 3.X
33
---
44

5-
The 3.X family introduces a number of changes to ensure $productName$
5+
The 3.X family introduces a number of changes to ensure Emissary
66
keeps up with latest Envoy versions and to support new features such as HTTP/3.
77
We welcome feedback! Join us on [Slack](http://a8r.io/slack) and let us know what you think.
88

9-
$productName$ 3 is functionally compatible with $productName$ 2.x, but with any major upgrade there are some changes to consider. Such as, Envoy removing support for V2 Transport Protocol features. Below we will outline some of these changes and things to consider when upgrading.
9+
Emissary 3 is functionally compatible with Emissary 2.x, but with any major upgrade there are some changes to consider. Such as, Envoy removing support for V2 Transport Protocol features. Below we will outline some of these changes and things to consider when upgrading.
1010

1111
## 1. Envoy Upgraded to 1.22
1212

13-
$productName$ 3.X has been upgraded from Envoy 1.17.X to Envoy **1.22** which keeps $productName$ up-to-date with
13+
Emissary 3.X has been upgraded from Envoy 1.17.X to Envoy **1.22** which keeps Emissary up-to-date with
1414
the latest security fixes, bug fixes, performance improvements and feature enhancements provided by Envoy Proxy. Most of the changes are under the hood but the most notable change to developers is the removal of support for Envoy V2 Transport Protocol. This means all AuthServices and LogServices must be updated to use the V3 Protocol.
1515

1616
This also means some of the v2 runtime bootstrap flags have been removed as well:
1717

1818
```yaml
1919
# No longer necessary because this was removed from Envoy
20-
# $productName$ already was converted to use the compressor API
20+
# Emissary already was converted to use the compressor API
2121
# https://www.envoyproxy.io/docs/envoy/v1.22.0/configuration/http/http_filters/compressor_filter#config-http-filters-compressor
2222
"envoy.deprecated_features.allow_deprecated_gzip_http_filter": true,
2323

@@ -39,13 +39,13 @@ This also means some of the v2 runtime bootstrap flags have been removed as well
3939
## 2. Envoy V2 Protocol Support Removed
4040
4141
With the upgrade to Envoy **1.22**, the V2 Envoy Transport Protocol is no longer supported.
42-
$productName$ 3.X **only** supports [V3 Envoy API](https://www.envoyproxy.io/docs/envoy/latest/api-v3/api).
42+
Emissary 3.X **only** supports [V3 Envoy API](https://www.envoyproxy.io/docs/envoy/latest/api-v3/api).
4343
4444
<Alert severity="warn">
4545
The environment variable <code>AMBASSADOR_ENVOY_API_VERSION</code> has been removed and will no longer have the affect
4646
of changing the transport protocol.
4747
</Alert>
4848
4949
<Alert severity="warn">
50-
The setting of <code>transport_protocol</code> to <code>v2</code> is no longer supported within CRDS (AuthService, etc...). An error will now be logged and $productName$ will not configure envoy correctly. You should remove this field from your CRD's or convert it to <code>v3</code> the only supported version at this time.
50+
The setting of <code>transport_protocol</code> to <code>v2</code> is no longer supported within CRDS (AuthService, etc...). An error will now be logged and Emissary will not configure envoy correctly. You should remove this field from your CRD's or convert it to <code>v3</code> the only supported version at this time.
5151
</Alert>

content/en/docs/3.8/about/features-and-benefits.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,44 @@
22
title: Features and Benefits
33
---
44

5-
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).
5+
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).
66

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

99
## Self-Service via Kubernetes Annotations
1010

11-
$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 resources or annotations, so they can easily integrate with your existing development workflow.
11+
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 resources or annotations, so they can easily integrate with your existing development workflow.
1212

1313
## Flexible canary deployments
1414

1515
[//]: # (+FIX+ Forge is no more)
1616

17-
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$.
17+
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.
1818

1919
## Kubernetes-native architecture
2020

2121
[//]: # (+FIX+ we've come to realize that it's better to scale vertically)
2222

23-
$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/).
23+
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/).
2424

25-
$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.
25+
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.
2626

2727
## gRPC and HTTP/2 support
2828

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

3131
## Istio Integration
3232

33-
$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 $productName$](../../howtos/istio) for details.
33+
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 Emissary](../../howtos/istio) for details.
3434

3535
## Authentication
3636

37-
$productName$ supports authenticating incoming requests using a custom authentication service. When configured, the $productName$ will check with your external authentication service prior to routing an incoming request. For more information, see the [authentication guide](../../topics/running/services/auth-service).
37+
Emissary supports authenticating incoming requests using a custom authentication service. When configured, the Emissary will check with your external authentication service prior to routing an incoming request. For more information, see the [authentication guide](../../topics/running/services/auth-service).
3838

3939
## Rate limiting
4040

41-
$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/).
41+
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/).
4242

4343
## Integrated UI
4444

45-
$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).
45+
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).

content/en/docs/3.8/about/known-issues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ title: Known Issues
55
## 2.2.1
66

77
- TLS certificates using elliptic curves were incorrectly flagged as invalid. This issue is
8-
corrected in $productName$ 2.2.2.
8+
corrected in Emissary 2.2.2.

content/en/docs/3.8/about/support.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ If you need help deploying Emissary at your organization, there are several diff
1010

1111
When running Emissary$ with free community licenses, [join our Slack channel](http://a8r.io/slack) to talk with other users in the community and get your questions answered.
1212

13-
If you can’t find an answer there, [contact us](/contact-us) to learn more about the support options available with $AESproductName$ Enterprise.
13+
If you can’t find an answer there, [contact us](/contact-us) to learn more about the support options available with Ambassador Edge Stack Enterprise.
1414

15-
### $AESproductName$ Enterprise
15+
### Ambassador Edge Stack Enterprise
1616

17-
With $AESproductName$ Enterprise, you have access to deployment and production support. To learn more, [contact sales](/contact-us).
17+
With Ambassador Edge Stack Enterprise, you have access to deployment and production support. To learn more, [contact sales](/contact-us).
1818

19-
**Deployment and Update Support**: $AESproductName$ can accelerate your migration to Kubernetes, or your upgrade between versions of $AESproductName$. Deployment support helps you with the $AESproductName$ and Kubernetes migration, before you move to production.
19+
**Deployment and Update Support**: Ambassador Edge Stack can accelerate your migration to Kubernetes, or your upgrade between versions of Ambassador Edge Stack. Deployment support helps you with the Ambassador Edge Stack and Kubernetes migration, before you move to production.
2020

21-
**Production Support**: We offer two types of production support contracts for users deploying the $AESproductName$ in production. We offer both business hour (8am - 5pm EST, M-F) and 24x7 Sev 1 support for the $AESproductName$. 24x7 Sev 1 support includes custom hotfix support for production outages if necessary.
21+
**Production Support**: We offer two types of production support contracts for users deploying the Ambassador Edge Stack in production. We offer both business hour (8am - 5pm EST, M-F) and 24x7 Sev 1 support for the Ambassador Edge Stack. 24x7 Sev 1 support includes custom hotfix support for production outages if necessary.
2222

2323
## File a Github Issue
2424

content/en/docs/3.8/howtos/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ These guides are designed to help users quickly accomplish common tasks. The gui
2121
* Security. Emissary supports a number of strategies for securing Kubernetes services.
2222
* [Protecting the Diagnostics Interface](protecting-diag-access)
2323
* [HTTPS and TLS termination](tls-termination)
24-
* [Certificate Manager](cert-manager) can be used to automatically obtain and renew TLS certificates; $AESproductName$ natively integrates this functionality.
24+
* [Certificate Manager](cert-manager) can be used to automatically obtain and renew TLS certificates; Ambassador Edge Stack natively integrates this functionality.
2525
* [Client Certificate Validation](client-cert-validation)
2626
* [Basic Authentication](basic-auth) is a tutorial on how to use the external authentication API to code your own authentication service.
2727
* [Basic Rate Limiting](rate-limiting-tutorial)

content/en/docs/3.8/howtos/cert-manager.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: Using cert-manager
33
---
44

5-
$AESproductName$ has simple and easy built-in support for automatically [using ACME] with the
5+
Ambassador Edge Stack has simple and easy built-in support for automatically [using ACME] with the
66
`http-01` challenge to create and renew TLS certificates. However, this support is not available
7-
in $OSSproductName$, and it is limited to the ACME `http-01` challenge type. If you're running
8-
$OSSproductName$, or if you require more flexible certificate management (such as using ACME's
7+
in Emissary, and it is limited to the ACME `http-01` challenge type. If you're running
8+
Emissary, or if you require more flexible certificate management (such as using ACME's
99
`dns-01` challenge, or using a non-ACME certificate source), external certificate management
1010
tools are also supported.
1111

1212
[using ACME]: ../../topics/running/host-crd
1313

1414
One such tool is Jetstack's [cert-manager](https://github.com/jetstack/cert-manager), which is a general-purpose tool
1515
for managing certificates in Kubernetes. Cert-manager will automatically create and renew TLS certificates and store
16-
them as Kubernetes secrets for easy use in a cluster. $productName$ will automatically watch for secret
16+
them as Kubernetes secrets for easy use in a cluster. Emissary will automatically watch for secret
1717
changes and reload certificates upon renewal.
1818

1919
> **Note:** This document assumes cert-manager v0.15 or greater. This document has been updated to use CRD standards

content/en/docs/3.8/howtos/client-cert-validation.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ Sometimes, for additional security or authentication purposes, you will want
66
the server to validate who the client is before establishing an encrypted
77
connection.
88

9-
To support this, $productName$ can be configured to use a provided CA certificate
9+
To support this, Emissary can be configured to use a provided CA certificate
1010
to validate certificates sent from your clients. This allows for client-side
11-
mTLS where both $productName$ and the client provide and validate each other's
11+
mTLS where both Emissary and the client provide and validate each other's
1212
certificates.
1313

1414
## Prerequisites
1515

1616
- [openssl](https://www.openssl.org/source/) For creating client certificates
1717
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
18-
- [$productName$](../../tutorials/getting-started)
18+
- [Emissary](../../tutorials/getting-started)
1919
- [cURL](https://curl.haxx.se/download.html)
2020

2121

@@ -30,7 +30,7 @@ certificates.
3030
```
3131

3232
Enter a passcode for PEM files and fill in the certificate information.
33-
Since this certificate will only be shared between a client and $productName$,
33+
Since this certificate will only be shared between a client and Emissary,
3434
the Common Name must be set to something. Everything else can be left blank.
3535

3636
**Note:** If using MacOS,
@@ -55,7 +55,7 @@ certificates.
5555
kubectl create secret generic client-cacert --from-file=tls.crt=cert.pem
5656
```
5757
58-
3. Configure $productName$ to use this certificate for client certificate validation.
58+
3. Configure Emissary to use this certificate for client certificate validation.
5959
6060
First create a `Host` to manage your domain:
6161
@@ -84,14 +84,14 @@ certificates.
8484
- host.example.com
8585
secret: host.example.com
8686
ca_secret: client-cacert
87-
cert_required: false # Optional: Configures $productName$ to reject the request if the client does not provide a certificate. Default: false
87+
cert_required: false # Optional: Configures Emissary to reject the request if the client does not provide a certificate. Default: false
8888
```
8989
90-
**Note**: Client certificate validation requires $productName$ be configured to terminate TLS
90+
**Note**: Client certificate validation requires Emissary be configured to terminate TLS
9191
92-
$productName$ is now be configured to validate certificates that the client provides.
92+
Emissary is now be configured to validate certificates that the client provides.
9393
94-
4. Test that $productName$ is validating the client certificates with `curl`
94+
4. Test that Emissary is validating the client certificates with `curl`
9595

9696
**Linux**:
9797
```
@@ -104,7 +104,7 @@ certificates.
104104
```
105105
106106
Looking through the verbose output, you can see we are sending a client
107-
certificate and $productName$ is validating it.
107+
certificate and Emissary is validating it.
108108
109109
If you need further proof, simply create a new set of certificates and
110-
try sending the curl with those. You will see $productName$ deny the request.
110+
try sending the curl with those. You will see Emissary deny the request.

0 commit comments

Comments
 (0)