|
| 1 | +# Contributing |
| 2 | + |
| 3 | +In this file you'll find all the references needed for you to start contributing with the HTTP Add-on project. |
| 4 | + |
| 5 | +## Getting started |
| 6 | + |
| 7 | +To get started, first [fork](https://github.com/kedacore/http-add-on/fork) this repository to your account. You'll need |
| 8 | +to have the following tools installed: |
| 9 | + |
| 10 | +- [Golang](http://golang.org/) for development |
| 11 | +- [Docker](https://docker.com) for building the images and testing it locally |
| 12 | + |
| 13 | +## Prerequisites |
| 14 | + |
| 15 | +### Kubernetes cluster |
| 16 | + |
| 17 | +It's recommended to have a running Kubernetes cluster to test the development, there are faster approaches using public |
| 18 | +clouds like: |
| 19 | + |
| 20 | +- Azure with [AKS](https://azure.microsoft.com/services/kubernetes-service/?WT.mc_id=opensource-12724-ludossan) |
| 21 | +- Google Cloud with [GKE](https://cloud.google.com/kubernetes-engine) |
| 22 | +- AWS with [EKS](https://aws.amazon.com/eks/) |
| 23 | +- [Digital Ocean](https://www.digitalocean.com/products/kubernetes/) |
| 24 | + |
| 25 | +These providers will let you deploy a simple and quick K8S cluster, however, they're paid. If you don't want to pay for |
| 26 | +the service, you can host your own with a series of amazing tools like: |
| 27 | + |
| 28 | +- [Microk8s](https://microk8s.io/) |
| 29 | +- [Minikube](https://minikube.sigs.k8s.io/docs/) |
| 30 | +- [K3S](https://k3s.io/) |
| 31 | +- [KinD (Kubernetes in Docker)](https://kind.sigs.k8s.io/) |
| 32 | + |
| 33 | +### Keda |
| 34 | + |
| 35 | +Follow the [install instructions](./install.md) to check out how to install and get this add-on up and running. |
| 36 | + |
| 37 | +## Build scripts |
| 38 | + |
| 39 | +This project uses [Mage](https://magefile.org) as opposed to Make because it's way faster to build and push images, as |
| 40 | +well as to run tests and other common tasks. Please install it to have access to the task runner. |
| 41 | + |
| 42 | +> **Note:** The Magefile located in the root directory is related to the whole project, so it gives you the ability to control the build and install process of all the modules in this project. On the other hand, the build binary located in the [operator](../operator/magefile.go) directory, is **just related to the operator module**. |
| 43 | +
|
| 44 | +The usage is as follows: |
| 45 | + |
| 46 | +- Type `mage -l` on the magefile directory to print a list of all available commands |
| 47 | +- Type `mage -h <command>` to check the help for that specific command |
| 48 | +- `mage -h` shows the general help |
| 49 | + |
| 50 | +Most of the commands are simple, and we have a few commands that chain other commands together, for reference on chains, |
| 51 | +check the [Magefile](../magefile.go) source code. Below is a list of the most common build commands |
| 52 | + |
| 53 | +> All commands are case insensitive, so `buildAll` and `buildall` are the same. |
| 54 | +
|
| 55 | +In the root directory: |
| 56 | + |
| 57 | +- `mage All`: Builds all the binaries for local testing. |
| 58 | +- `mage deleteOperator [namespace]`: Deletes the installed add-on in the given `namespace` for the active K8S |
| 59 | + cluster. |
| 60 | +- `mage dockerBuildAll <repository>`: Builds all the images for the `interceptor`, `scaler`, and `operator` modules |
| 61 | + for the specified `repository`. |
| 62 | + - You can also build specific images by using `mage dockerBuild <repository> <module>`, where module is one |
| 63 | + of `interceptor`, `scaler`, or `operator`. |
| 64 | +- `mage dockerPushAll <repository>`: Pushes all the built images for a given repository. |
| 65 | + - You can push the images using `mage dockerPush <repository> <module>` like the `dockerBuild` command. |
| 66 | +- `mage installKeda [namespace]`: will install KEDA on the given namespace. |
| 67 | +- `mage upgradeOperator [namespace] <image>`: Will install the add-on in the given `namespace` if not installed, or |
| 68 | + update it using the provided `image`. |
| 69 | +- `mage Operator`: Alias to `mage -d operator All`, just to have everything on the same dir level. |
| 70 | +- `mage Manifests`: Alias to `mage -d operator Manifests`. |
| 71 | + |
| 72 | +> The default values for the `namespace` if not provided (when passed as `""`, like `mage upgradeOperator "" image`) is `kedahttp` |
| 73 | +
|
| 74 | +In the operator directory: |
| 75 | + |
| 76 | +- `mage Manifests`: Builds all the manifest files for Kubernetes, it's important to build after every change |
| 77 | + to a Kustomize annotation. |
| 78 | +- `mage All`: Generates the operator. |
0 commit comments