github.com/caos/orbos@v1.5.14-0.20221103111702-e6cd0cea7ad4/docs/boom/boom.md (about)

     1  # BOOM: the base tooling operator
     2  
     3  ## What is it
     4  
     5  `BOOM` is designed to ensure that someone can create a reproducable "platform" with tools which are tested for their interoperability.
     6  
     7  Currently we include the following tools:
     8  
     9  - Ambassador Edge Stack
    10  - Prometheus Operator
    11  - Grafana
    12  - logging-operator
    13  - kube-state-metrics
    14  - prometheus-node-exporter
    15  - prometheus-systemd-exporter
    16  - loki
    17  - ArgoCD
    18  
    19  Upcoming tools:
    20  
    21  - Flux
    22  
    23  ## How does it work
    24  
    25  The operator works by reading a configuration (crd) located in a GIT Repository.
    26  In our default setup our "cluster lifecycle" tool `ORBITER`, shares the repository and secrets with `BOOM`.
    27  
    28  ```yaml
    29  apiVersion: boom.caos.ch/v1beta1
    30  kind: Toolset
    31  metadata:
    32    name: caos
    33    namespace: caos-system
    34  spec:
    35    preApply:
    36      deploy: true
    37      folder: preapply
    38    postApply:
    39      deploy: true
    40      folder: postapply
    41    prometheus-operator:
    42      deploy: true
    43    logging-operator:
    44      deploy: true
    45    prometheus-node-exporter:
    46      deploy: true
    47    grafana:
    48      deploy: true
    49    ambassador:
    50      deploy: true
    51      service:
    52        type: LoadBalancer
    53    kube-state-metrics:
    54      deploy: true
    55    prometheus:
    56      deploy: true
    57      storage:
    58        size: 5Gi
    59        storageClass: standard
    60    loki:
    61      deploy: true
    62      storage:
    63        size: 5Gi
    64        storageClass: standard
    65  ```
    66  
    67  ## How to use it
    68  
    69  There has to be a git-repository with an boom.yml in the base. Then a `BOOM` instance can be started with 
    70  ```bash
    71  orbctl -f $HOME/.orb/config takeoff
    72  ```
    73  
    74  ## Structure of the used boom.yml 
    75  
    76  Jump to the [latest](yml/latest/Toolset.md) configuration options or to the older API versions [v1beta2](yml/v1beta2/Toolset.md) or [v1beta1](yml/v1beta1/Toolset.md)