Run Airy on minikube

Run Airy on minikube with one command.

The goal of this document is to provide an overview of how to run Airy Core on your local machine using minikube.

Create a minikube cluster#

note

By default the UI and the API will be available at http://localhost. Make sure you don't have any other process using port 80 on your localhost interface

First install minikube using their documentation. Minikube version v1.19.0 or higher is required.

Next you also need to install the Airy CLI. Now you can run this command, which will create a new minikube cluster on your system and install Airy core on it:

airy create --provider=minikube my-airy

This will execute the following actions:

Create the my-airy directory and populate it with the configuration that the CLI will need. All subsequent commands need to either be run from this directory or use the --workspace flag.
Start a minikube cluster on your system and install Airy Core on it.
Prints a URL for the Airy Core UI/APIs and another ngrok tunnel URL to connect your Airy Core instance to different sources (see recording)

::: note

The base URL for the API is the same to access the UI through your browser.

:::

To customize your Minikube instance, you can adjust the driver, cpus and memory attributes in the following manner:

airy create --provider=minikube --provider-config driver=virtualbox,cpus=4,memory=8192 my-airy

If you want to customize your Airy Core instance please see our Configuration Section.

After the installation, you can also interact with the components of Airy Core with the kubectl command line utility. airy create adds the kubeconfig of your Airy Core instance to the default kubeconfig file ~/.kube/config, under the context airy-core.

note

If the airy create command fails and you have installed a hypervisor for the first time, double-check that you have given it all the necessary permissions on your local machine.

Integrate public webhooks#

In order to integrate with the webhook of most sources on your local machine, we include a ngrok as a deployment to tunnel the traffic to the ingress controller. ngrok is an open source reverse proxy which creates a secure tunnel from a public endpoint to a local service. The ngrok client connects to a ngrok server which has public access to the internet and then provides a reversed proxy connectivity back to the webhook services, running inside the Kubernetes cluster.

To get the ngrok URL of your local Airy Core installation you can run:

echo "https://$(minikube -p airy-core kubectl -- get cm core-config -o jsonpath='{.data.CORE_ID}').tunnel.airy.co"

By default, the ngrok client is configured to use the ngrok server created by Airy and runs on https://tunnel.airy.co. This configuration is specified in the ngrok-client-config ConfigMap.

apiVersion: v1
kind: ConfigMap
metadata:
  name: ngrok-client-config
  namespace: default
data:
  config.yml: |
    server_addr: proxy.tunnel.airy.co:4443
    trust_host_root_certs: true

If you prefer to use your own ngrok implementation or point the ngrok client to connect to the service provided by the ngrok company at https://ngrok.io, change the setting for server_addr in the ConfigMap.

Next steps#

Now that you have a running local installation of minikube you can connect it to messaging sources. Check out our Quickstart guide to learn more:

To the Quick Start

Learn the Airy Basics with our Quick Start

Third party tools#

Third party tools can be activated in the airy.yaml configuration file, under the tools section. For more details please see our Configuration Section.

Uninstall Airy Core#

You can remove the Airy Core minikube node from your machine completely running the following command:

minikube -p airy-core delete