Upgrade Emissary-ingress 3.9.1 to Ambassador Edge Stack 3.12.1 (YAML)

You can upgrade from Emissary-ingress to Ambassador Edge Stack with a few simple commands. When you upgrade to Ambassador Edge Stack, you'll be able to access additional capabilities such as automatic HTTPS/TLS termination, Swagger/OpenAPI support, API catalog, Single Sign-On, and more.

Migration Overview

The recommended strategy for migration is to run Emissary-ingress 3.12.1 and Ambassador Edge Stack 3.12.1 side-by-side in the same cluster. This gives Ambassador Edge Stack 3.12.1 and Ambassador Edge Stack 3.12.1 access to all the same configuration resources, with some important notes:

1. If needed, you can use labels to further isolate configurations.

   If you need to prevent your Ambassador Edge Stack 3.12.1 installation from seeing a particular bit of Emissary-ingress 3.12.1 configuration, you can apply a Kubernetes label to the configuration resources that should be seen by your Ambassador Edge Stack 3.12.1 installation, then set its AMBASSADOR_LABEL_SELECTOR environment variable to restrict its configuration to only the labelled resources.

   For example, you could apply a version-two: true label to all resources that should be visible to Ambassador Edge Stack 3.12.1, then set AMBASSADOR_LABEL_SELECTOR=version-two=true in its Deployment.

2. Ambassador Edge Stack ACME and Filters will be disabled while Emissary-ingress is still running.

   Since Ambassador Edge Stack and Emissary-ingress share configuration, Ambassador Edge Stack cannot configure its ACME or other filter processors without also affecting Emissary-ingress. This migration process is written to simply disable these Ambassador Edge Stack features to make it simpler to roll back, if needed. Alternate, you can isolate the two configurations as described above.

3. Be careful to only have one Ambassador Edge Stack Agent running at a time.

   The Ambassador Edge Stack Agent is responsible for communications between Ambassador Edge Stack and Ambassador Cloud. If multiple versions of the Agent are running simultaneously, Ambassador Cloud could see conflicting information about your cluster.

   The best way to avoid multiple agents when installing with Helm is to use --set emissary-ingress.agent.enabled=false to tell Helm not to install a new Agent with Ambassador Edge Stack 3.12.1. Once testing is done, you can switch Agents safely.

4. Be careful about label selectors on Kubernetes Services!

   If you have services in Emissary-ingress 3.X that use selectors that will match Pods from Ambassador Edge Stack 3.12.1, traffic will be erroneously split between Emissary-ingress 2.4 and Ambassador Edge Stack 3.12.1. The labels used by Ambassador Edge Stack 3.12.1 include:

You can also migrate by installing Ambassador Edge Stack 3.12.1 in a separate cluster. This permits absolute certainty that your Emissary-ingress 3.12.1 configuration will not be affected by changes meant for Ambassador Edge Stack 3.12.1, but it is more effort.

Side-by-Side Migration Steps

Migration is a six-step process:

1. Install new CRDs.

   Before installing Ambassador Edge Stack 3.12.1 itself, you need to update the CRDs in your cluster. This is mandatory during any upgrade of Ambassador Edge Stack.

   Ambassador Edge Stack 3.12.1 includes a Deployment in the `emissary-system` namespace called emissary-apiext. This is the APIserver extension that supports converting Emissary-ingress CRDs between getambassador.io/v2and getambassador.io/v3alpha1. This Deployment needs to be running at all times.
   If the emissary-apiext Deployment's Pods all stop running, you will not be able to use getambassador.io/v3alpha1 CRDs until restarting the emissary-apiext Deployment.
   There is a known issue with the emissary-apiext service that impacts all Ambassador Edge Stack 2.x and 3.x users. Specifically, the TLS certificate used by apiext expires one year after creation and does not auto-renew. All users who are running Ambassador Edge Stack/Emissary-ingress 2.x or 3.x with the apiext service should proactively renew their certificate as soon as practical by running kubectl delete --all secrets --namespace=emissary-system to delete the existing certificate, and then restart the emissary-apiext deployment with kubectl rollout restart deploy/emissary-apiext -n emissary-system. This will create a new certificate with a one year expiration. We will issue a software patch to address this issue well before the one year expiration. Note that certificate renewal will not cause any downtime.

2. Install Ambassador Edge Stack 3.12.1.

   After installing the new CRDs, you need to install Ambassador Edge Stack 3.12.1 itself in the same namespace as your existing Emissary-ingress 3.12.1 installation. It's important to use the same namespace so that the two installations can see the same secrets, etc.

   We publish three manifests for different namespaces. Use only the one that matches the namespace into which you installed Emissary-ingress 3.12.1:

   • aes-emissaryns-migration.yaml for the emissary namespace;
   • aes-defaultns-migration.yaml for the default namespace; and
   • aes-ambassadorns-migration.yaml for the ambassador namespace.

   All three files are set up as follows:

   • They set the AES_ACME_LEADER_DISABLE environment variable; you'll enable ACME towards the end of the migration.
   • They do NOT create any AuthService or a RateLimitService, since your Emissary-ingress may have these defined. Again, you'll manage these at the end of migration.
   • They do NOT set AMBASSADOR_LABEL_SELECTOR.
   • They do NOT install the Ambassador Agent, since there is already an Ambassador Agent running for Emissary-ingress 3.12.1.

   If any of these do not match your situation, download aes-emissaryns-migration.yaml and edit it as needed.

   Assuming you're using the emissary namespace, as was typical for Emissary-ingress 3.12.1:

   If you need to set AMBASSADOR_LABEL_SELECTOR, download aes-emissaryns-migration.yaml and edit it to do so.

3. Create an Ambassador Cloud Connect Token

   Ambassador Edge Stack requires a license to operate. Licenses are obtained and refreshed automatically using an API Token. If your installation of Ambassador Edge Stack is already connected to the cloud then you can skip this step. Otherwise, you can create a Cloud Connect Token in Ambassador Cloud and apply it using the command below. For more information on licensing please refer to the license page.

4. Test!

   Your Ambassador Edge Stack 3.12.1 installation should come up running with the configuration resources used by Emissary-ingress 3.12.1, including Listeners and Hosts.

   If you find that your Ambassador Edge Stack 3.12.1 installation and your Emissary-ingress 3.12.1 installation absolutely must have resources that are only seen by one version or the other way, see overview section 1, "If needed, you can use labels to further isolate configurations".

   If you find that you need to roll back, just reinstall your Emissary-ingress 3.12.1 CRDs and delete your installation of Ambassador Edge Stack 3.12.1.

5. When ready, switch over to Ambassador Edge Stack 3.12.1.

   You can run Emissary-ingress 3.12.1 and Ambassador Edge Stack 3.12.1 side-by-side as long as you care to. When you're ready to have Ambassador Edge Stack 3.12.1 handle traffic on its own, switch your original Emissary-ingress 3.12.1 Service to point to Ambassador Edge Stack 3.12.1. Use kubectl edit -n emissary service emissary-ingress and change the selectors to:

   Repeat using kubectl edit service ambassador-admin for the ambassador-admin Service.

6. Install the Ambassador Edge Stack 3.12.1 Ambassador Agent.

   First, scale the Emissary-ingress agent to 0:

   Once that's done, install the new Agent:

7. Finally, enable ACME and filtering in Ambassador Edge Stack 3.12.1.

   Enabling filtering correctly in Ambassador Edge Stack 3.12.1 requires that noAuthService or RateLimitService resources be present; see below for more.

   First, make sure that no AuthService or RateLimitService resources are present; delete these if necessary.

   • If you are currently using an external authentication service that provides functionality you'll still require, turn it into an External Filter (with a FilterPolicy to direct requests that need it correctly).

   • If you are currently using a RateLimitService, you can set up Edge Stack Rate Limiting instead.

   After making sure no AuthService or RateLimitService resources are present, scale the Emissary-ingress Deployment to 0:

   Once that's done, apply resources specific to Ambassador Edge Stack:

   Then, finally, enable ACME and filtering in Ambassador Edge Stack 3.12.1:

Congratulations! At this point, Ambassador Edge Stack 3.12.1 is fully running, and it's safe to remove the old emissary and emissary-agent Deployments:

You may also want to redirect DNS to the edge-stack Service and remove the ambassador Service.