Ambassador Logo

Version:

Pre-releaseLatest1.121.111.101.91.81.71.61.51.41.3

Search the Docs

Quick Start Installation Guide

In just four minutes, your cluster will be routing HTTPS requests from the Internet to a backend service.

The Ambassador Edge Stack is deployed to Kubernetes via YAML for MacOS, Linux, and Windows. For other options, such as Docker, read the [detailed instructions] (../../topics/install/).

Install on MacOS

  1. Download the edgectl file here or download it with a curl command:

    sudo curl -fL https://metriton.datawire.io/downloads/darwin/edgectl -o /usr/local/bin/edgectl && sudo chmod a+x /usr/local/bin/edgectl

    If you decide to download the file, you may encounter a security block. To change this:

    • Go to System Preferences > Security & Privacy > General.
    • Click the Open Anyway button.
    • On the new dialog, click the Open button.

  2. Run the installer with edgectl install

Install on Linux

  1. Download the edgectl file here or download it with a curl command:

    sudo curl -fL https://metriton.datawire.io/downloads/linux/edgectl -o /usr/local/bin/edgectl && sudo chmod a+x /usr/local/bin/edgectl

  2. Run the installer with edgectl install

Install on Windows

  1. Download the edgectl.exe file here.
  2. Run the installer with edgectl install

Installation

Your terminal will show you something similar to the following as the installer provisions a load balancer, configures TLS, and provides you with an edgestack.me subdomain:

$ edgectl install
-> Installing the Ambassador Edge Stack 1.3.2.
Downloading images. (This may take a minute.)

-> Provisioning a cloud load balancer. (This may take a minute, depending on your cloud provider.)

Your AES installation's IP address is 4.3.2.1 -> Automatically configuring TLS

Please enter an email address. We'll use this email address to notify you prior to domain and certificate expiration. We also share this email address with Let's Encrypt to acquire your certificate for TLS.

Provide an email address as required by the ACME TLS certificate provider, Let's Encrypt. Then your terminal will print something similar to the following:

Email address [john@example.com]:

-> Acquiring DNS name random-word-3421.edgestack.me -> Obtaining a TLS certificate from Let's Encrypt -> TLS configured successfully

Congratulations! You've successfully installed the Ambassador Edge Stack in your Kubernetes cluster. Visit random-word-3421.edgestack.me to access your Edge Stack installation and for additional configuration.

The random-word-3421.edgestack.me is a provided subdomain that allows the Ambassador Edge Stack to automatically provision TLS and HTTPS for a domain name, so you can get started right away.

Your new Edge Policy Console will open automatically in your browser at the provided URL or IP address.

AES success

Minikube

Minikube users will see something similar to the following:

$ edgectl install
-> Installing the Ambassador Edge Stack 1.3.2.
Downloading images. (This may take a minute.)

-> Local cluster detected. Now configuring automatic TLS.

Congratulations! You've successfully installed the Ambassador Edge Stack in your Kubernetes cluster. However, we cannot connect to your cluster from the Internet, so we could not configure TLS automatically.

Determine the IP address and port number of your Ambassador service. (e.g., minikube service -n ambassador ambassador)

The following command will open the Edge Policy Console once you accept a self-signed certificate in your browser. $ edgectl login -n ambassador IP_ADDRESS:PORT

See https://www.getambassador.io/docs/latest/tutorials/getting-started/

Installation Success

Congratulations, you've installed the Ambassador Edge Stack! Take advantage of the quick start demo by creating a mapping on your cluster using the Ambassador Edge Stack.

What’s Next?

The Ambassador Edge Stack has a comprehensive range of features to support the requirements of any edge microservice. To learn more about how the Ambassador Edge Stack works, along with use cases, best practices, and more, check out the Welcome page or read the Ambassador Story.

For a custom configuration, you can install the Ambassador Edge Stack manually.

Note that the provided random-word-3421.edgestack.me domain name will expire after 90 days.

Questions?

We’re here to help. If you have questions, join our Slack or contact us.