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.
By default the UI and the API will be available at
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:
This will execute the following actions:
- Create the
my-airydirectory 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
- Start a minikube cluster on your system and install Airy Core on it.
- Prints a URL for the
Airy CoreUI/APIs and another
ngroktunnel URL to connect your
Airy Coreinstance to different sources (see recording)
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
memory attributes in the following manner:
If you want to customize your
Airy Core instance please see our Configuration
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 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.
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:
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
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
change the setting for
server_addr in the ConfigMap.
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 can be activated in the
airy.yaml configuration file, under the
For more details please see our Configuration Section.
You can remove the Airy Core minikube node from your machine completely running the following command: