diff --git a/docs/docs/concepts/release-process.md b/docs/docs/concepts/release-process.md index 15d541eb21..ee51b5898a 100644 --- a/docs/docs/concepts/release-process.md +++ b/docs/docs/concepts/release-process.md @@ -25,12 +25,11 @@ Once a release day comes, we execute the following steps: - `chmod +x airy` - We test the release using `./airy create --provider=minikube`. - We run the Cypress tests with the command `./node_modules/.bin/cypress open -C integration/cypress.config.ts` - Note that: - - Any additional hot-fix is committed directly to the release branch - - You must wait for all the images to be pushed via CI -- We create the draft release which is used for the Changelog `./scripts/release.sh changelog x.y.z`. -- Once we're satisfied with the release, we publish the release (we wait for the CI to complete before proceeding): - - We clean up the draft release. If the upgrade to the new version requires manual steps, we detail them. +- Any additional fix is committed directly to the release branch. Then we must wait for all the images to be pushed via CI and test again. +- Once we're satisfied with the release we execute the following steps: + - We create the draft release through the CI which used for the Changelog `./scripts/release.sh changelog x.y.z`. + - We clean up the draft release once it is there. + - If the upgrade to the new version requires manual steps, we detail them. - We run `./scripts/release.sh finish x.y.z` - We update the version string to `x.y.z` and the sha to `https://airy-core-binaries.s3.amazonaws.com/x.y.z/darwin/amd64/airy_darwin_sha256sum.txt` in the [Homebrew Formula](https://github.com/airyhq/homebrew-airy/blob/main/Formula/cli.rb) diff --git a/docs/docs/getting-started/installation/aws.md b/docs/docs/getting-started/installation/aws.md index 42903b2118..acc45b6f3e 100644 --- a/docs/docs/getting-started/installation/aws.md +++ b/docs/docs/getting-started/installation/aws.md @@ -19,7 +19,7 @@ The goal of this document is to provide an overview of how to run Airy Core on AWS cloud platform, using the [AWS Elastic Kubernetes Service](https://aws.amazon.com/eks/). -## Configure AWS +## Configure :::note @@ -79,7 +79,7 @@ Refer to the following links for more information on AWS Service Limits: - [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) - [AWS Well-Architected Framework Concepts](https://wa.aws.amazon.com/wellarchitected/2020-07-02T19-33-23/wat.concept.service-limits.en.html) -## Create a cluster +## Install To create the cluster you must setup your local AWS environment, by [configuring your local AWS diff --git a/docs/docs/getting-started/installation/minikube.md b/docs/docs/getting-started/installation/minikube.md index 6853e8c9b2..71f234fdf4 100644 --- a/docs/docs/getting-started/installation/minikube.md +++ b/docs/docs/getting-started/installation/minikube.md @@ -14,7 +14,7 @@ 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](https://minikube.sigs.k8s.io/). -## Create a minikube cluster +## Install :::note @@ -35,16 +35,16 @@ airy create --provider=minikube my-airy This will execute the following actions: 1. 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. -2. Start a minikube cluster on your system and install Airy Core on it. -3. Prints a URL for the `Airy Core` UI/APIs and another `ngrok` tunnel URL to connect your `Airy Core` instance to different [sources](../../sources/introduction.md) (see recording) +2. Fetch the required Terraform modules in the `terraform` subdirectory, including the `install.sh` and `uninstall.sh` scripts. +3. Run the `install.sh` script +4. Start a minikube cluster on your system using Terraform, under the profile `airy-core`. +5. Install the `Airy Core` helm chart on the minikube instance using Terraform (in a separate Terraform state then the minikube instance). +6. Print the resulting URLs on which you can access the `Airy Core` installation and some additional information. -import Script from "@site/src/components/Script"; - - - -::: note +:::note The base URL for the [API](../../api/introduction.md) is the same to access the UI through your browser. +You can use the printed `ngrok` URL to connect to different [sources](../../sources/introduction.md) to the instance running on your local machine. ::: @@ -57,15 +57,18 @@ airy create --provider=minikube --provider-config driver=virtualbox,cpus=4,memor If you want to customize your `Airy Core` instance please see our [Configuration Section](configuration.md). -After the installation, you can also interact with the components of `Airy Core` with the [kubectl](https://kubernetes.io/docs/tasks/tools/) 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`. +After the installation, you can also interact with the components of `Airy Core` with the [kubectl](https://kubernetes.io/docs/tasks/tools/) command line utility. `airy create` creates the kubeconfig file `kube.conf` under the `terraform` directory in your workspace. :::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. +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. More information will be printed in the output from the Terraform installation. ::: +## Configure + +For more details on configuring your `Airy Core` instance please see our [Configuration Section](configuration.md). Under the `tools` section you can also find information on installing and activating third party tools for more detailed Kafka and data debugging. + ## Integrate public webhooks In order to integrate with the webhook of most sources on your local machine, we @@ -79,6 +82,7 @@ inside the Kubernetes cluster. To get the ngrok URL of your local Airy Core installation you can run: ```sh +export KUBECONFIG=./terraform/kube.conf echo "https://$(minikube -p airy-core kubectl -- get cm core-config -o jsonpath='{.data.CORE_ID}').tunnel.airy.co" ``` @@ -115,15 +119,16 @@ description='Learn the Airy Basics with our Quick Start' link='getting-started/quickstart' /> -## Third party tools +## Uninstall -Third party tools can be activated in the `airy.yaml` configuration file, under the `tools` section. -For more details please see our [Configuration Section](configuration.md). +To uninstall `Airy Core` from AWS, run the `uninstall.sh` script located in the `WORKSPACE/terraform` directory. This script will run `terraform destroy` on both the `kubernetes` (minikube) and the `airy-core` state. -## Uninstall Airy Core +``` +cd terraform +./uninstall.sh +``` -You can remove the Airy Core minikube node from your machine completely running -the following command: +Deleting the minikube instance also removes Airy completely from your system: ```sh minikube -p airy-core delete