Getting Started with Emissary
Contents
1. Installation
We’ll start by installing Emissary into your cluster.
We recommend using Helm but there are other options below to choose from.
2. Routing traffic from the edge
Like any other Kubernetes object, Custom Resource Definitions (CRDs) are used to declaratively define Emissary’s desired state. The workflow you are going to build uses a simple demo app and the Mapping CRD, which is the core resource that you will use with Emissary. It lets you route requests by host and URL path from the edge of your cluster to Kubernetes services.
- First, apply the YAML for the “Quote of the Moment" service.
kubectl apply -f https://app.getambassador.io/yaml/ambassador-docs/$version$/quickstart/qotm.yaml
kubectl get services,deployments quote
to see their status.
- Copy the configuration below and save it to a file called
quote-backend.yaml
so that you can create a Mapping on your cluster. This Mapping tells Emissary to route all traffic inbound to the/backend/
path to thequote
Service.
---
apiVersion: getambassador.io/v2
kind: Mapping
metadata:
name: quote-backend
spec:
prefix: /backend/
service: quote
- Apply the configuration to the cluster:
kubectl apply -f quote-backend.yaml
With our Mapping created, now we need to access it!
- Store the Emissary load balancer IP address to a local environment variable. You will use this variable to test accessing your service.
export EMISSARY_LB_ENDPOINT=$(kubectl get svc ambassador \
-o "go-template={{range .status.loadBalancer.ingress}}{{or .ip .hostname}}{{end}}")
- Test the configuration by accessing the service through the Emissary load balancer:
curl -Lk http://$EMISSARY_LB_ENDPOINT/backend/
$ curl -Lk http://$EMISSARY_LB_ENDPOINT/backend/
{
"server": "idle-cranberry-8tbb6iks",
"quote": "Non-locality is the driver of truth. By summoning, we vibrate.",
"time": "2021-02-26T15:55:06.884798988Z"
}
3. Connect your cluster to Ambassador Cloud
The Service Catalog is a web-based interface that lists all of your cluster’s Services. You can view, add, and update metadata associated with each Service, such as the owner, version control repository, and associated Slack channel.
-
-
At the top, click Add Services then click Connection Instructions in the Edge Stack installation section.
-
Follow the prompts to name the cluster and click Generate a Cloud Token.
-
Follow the prompts to install the cloud token into your cluster.
-
When the token installation completes, refresh the Service Catalog page.
What’s next?
Explore some of the popular tutorials on Emissary:
- Intro to Mappings: declaratively routes traffic from the edge of your cluster to a Kubernetes service
- Host resource: configure a hostname and TLS options for your ingress.
- Rate Limiting: create policies to control sustained traffic loads
Emissary has a comprehensive range of features to support the requirements of any edge microservice.
To learn more about how Emissary works, read the Emissary Story.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.