Skip to content

Commit

Permalink
add docs for application configs (#304)
Browse files Browse the repository at this point in the history
Signed-off-by: Dejan Pejchev <pejcev.dejan@gmail.com>
  • Loading branch information
dejanzele authored Jun 10, 2024
1 parent 096fc03 commit ef0664c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,21 @@ please read the Quickstart guide in the [documentation](./dev/quickstart/README.

For more info on Armada, please visit the [Armada website](https://armadaproject.io) and the GitHub repository [armadaproject/armada](https://github.com/armadaproject/armada)

For understanding the minimal configuration required to deploy Armada services, please refer to the [armada-crds.yaml](./dev/quickstart/armada-crds.yaml) file.

For advanced usage, please refer to the Armada CRD reference docs in `dev/crd/` directory.

Each Armada Operator CRD supports a field `.spec.applicationConfig` which injects configuration into the Armada component.
Here is a list of support Armada component configurations:
* [Armada Server](https://pkg.go.dev/github.com/armadaproject/armada/internal/armada/configuration#ArmadaConfig)
* [Armada Executor](https://pkg.go.dev/github.com/armadaproject/armada/internal/executor/configuration#ApplicationConfiguration)
* [Armada Scheduler](https://pkg.go.dev/github.com/armadaproject/armada/internal/scheduler/configuration#Configuration)
* [Armada Scheduler Ingester](https://pkg.go.dev/github.com/armadaproject/armada/internal/scheduleringester#Configuration)
* [Armada Lookout](https://pkg.go.dev/github.com/armadaproject/armada/internal/lookoutv2/configuration#LookoutV2Config)
* [Armada Lookout Ingester](https://pkg.go.dev/github.com/armadaproject/armada/internal/lookoutingesterv2/configuration#LookoutIngesterV2Configuration)
* [Armada Event Ingester](https://pkg.go.dev/github.com/armadaproject/armada/internal/eventingester/configuration#EventIngesterConfiguration)
* [Armada Binoculars](https://pkg.go.dev/github.com/armadaproject/armada/internal/binoculars/configuration#BinocularsConfig)

## Local development

This section assumes you have a `kind` cluster named `armada` running on your machine (it will appear as `kind-armada` in your kubeconfig).
Expand Down

0 comments on commit ef0664c

Please sign in to comment.