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.

# Add the Repo:
helm repo add datawire https://app.getambassador.io
helm repo update
# Create Namespace and Install:
kubectl create namespace emissary && \
kubectl apply -f https://app.getambassador.io/yaml/emissary/3.0.0/emissary-crds.yaml
kubectl wait --timeout=90s --for=condition=available deployment emissary-apiext -n emissary-system
helm install emissary-ingress --namespace emissary datawire/emissary-ingress && \
kubectl -n emissary wait --for condition=available --timeout=90s deploy -lapp.kubernetes.io/instance=emissary-ingress

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. At the top, click Add Services then click Connection Instructions in the "Connect your installation" section.

  3. Follow the prompts to name the cluster and click Generate a Cloud Token.

  4. Follow the prompts to install the cloud token into your cluster.

  5. When the token installation completes, your services will be listed in the DCP.

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:

    kubectl apply -f - <<EOF
    apiVersion: getambassador.io/v3alpha1
    kind: Listener
    name: emissary-ingress-listener-8080
    namespace: emissary
    port: 8080
    protocol: HTTP
    securityModel: XFP
    from: ALL
  2. Apply the YAML for the "Quote" service.

    kubectl apply -f https://app.getambassador.io/yaml/v2-docs/3.0.0/quickstart/qotm.yaml
  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 https://app.getambassador.io/cloud/services/quote/details 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

    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.

    kubectl apply -f - <<EOF
    apiVersion: getambassador.io/v3alpha1
    kind: Mapping
    name: quote-backend
    hostname: "*"
    prefix: /backend/
    service: quote
    path: "/.ambassador-internal/openapi-docs"
  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.

    export LB_ENDPOINT=$(kubectl -n emissary get svc emissary-ingress \
    -o "go-template={{range .status.loadBalancer.ingress}}{{or .ip .hostname}}{{end}}")
  5. Test the configuration by accessing the service through the Emissary-ingress load balancer:

    $ curl -i http://$LB_ENDPOINT/backend/
    HTTP/1.1 200 OK
    content-type: application/json
    date: Wed, 23 Jun 2021 15:49:02 GMT
    content-length: 137
    x-envoy-upstream-service-time: 0
    server: envoy
    "server": "ginormous-kumquat-7mkgucxo",
    "quote": "Abstraction is ever present.",
    "time": "2021-06-23T15:49:02.255042819Z"

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.