Docsright arrowEmissary-ingressright arrowEmissary-ingress quick start

4 min • read

Emissary-ingress quick start


1. Installation

We'll start by installing Emissary-ingress into your cluster.

We recommend using Helm but there are other options below to choose from.

Connecting your installation to Ambassador Cloud

Now is a great moment to connect your new installation to Ambassador Cloud in order to fully leverage the power of Emissary-ingress and the Developer Control Plane (DCP).

  1. Log in to Ambassador Cloud with GitHub, GitLab or Google and select your team account.

  2. Provide a name to identify your Kubernetes cluster and then press Generate Key

  3. Copy the token and follow along here.

  4. Once your cluster is connected to Ambassador Cloud, a community license is automatically applied.

We recommend using Helm to install but there are other options below to choose from.

2. Routing traffic from the edge

Emissary-ingress uses Kubernetes Custom Resource Definitions (CRDs) to declaratively define its desired state. The workflow you are going to build uses a simple demo app, a Listener CRD, and a Mapping CRD. The Listener CRD tells Emissary-ingress what port to listen on, and the Mapping CRD tells Emissary-ingress how to route incoming requests by host and URL path from the edge of your cluster to Kubernetes services.

  1. Start by creating a Listener resource for HTTP on port 8080:

  2. Apply the YAML for the "Quote" service.

  3. Generate the YAML for a Mapping to tell Emissary-ingress to route all traffic inbound to the /backend/ path to the quote Service.

    In this step, we'll be using the Mapping Editor, which you can find in the service details view of your Ambassador Cloud connected installation. Open your browser to and click on New Mapping.

    Default options are automatically populated. Enable and configure the following settings, then click Generate Mapping:

    • Path Matching: /backend/

    • OpenAPI Docs: /.ambassador-internal/openapi-docs

      mapping editor

    Whether you decide to automatically push the change to Git for this newly create Mapping resource or not, the resulting Mapping should be similar to the example below.

    Apply this YAML to your target cluster now.

  4. Store the Emissary-ingress load balancer IP address to a local environment variable. You will use this variable to test access to your service.

  5. Test the configuration by accessing the service through the Emissary-ingress load balancer:

What's next?

Explore some of the popular tutorials on Emissary-ingress:

Emissary-ingress has a comprehensive range of features to support the requirements of any edge microservice.

To learn more about how Emissary-ingress works, read the Emissary-ingress Story.