From d2d8df035de7d6ce30c3d81f78345834a6794d7f Mon Sep 17 00:00:00 2001 From: wirth Date: Tue, 26 Jan 2021 12:17:43 +0100 Subject: [PATCH 1/3] docs: add documentation for boom without orbiter --- docs/boom/boom.md | 51 +++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 8 deletions(-) diff --git a/docs/boom/boom.md b/docs/boom/boom.md index e7bf82e16..5986f5653 100644 --- a/docs/boom/boom.md +++ b/docs/boom/boom.md @@ -20,6 +20,48 @@ Upcoming tools: - Flux +## How to use it + +There has to be a git-repository with an boom.yml in the base. Then a `BOOM` instance can be started with + +```bash +orbctl -f $HOME/.orb/config takeoff +``` + +If you want to run boom together with orbiter you can follow the documentation in the [readme.md](../../readme.md). If you want to run boom on a existing cluster + +## Boom on an existing Cluster + +If you just want to use Boom without Orbiter to bootstrap some tools you can follow these steps: + +1. Install orbctl locally + +``` +curl -s https://api.github.com/repos/caos/orbos/releases/latest | grep "browser_download_url.*orbctl-$(uname)-$(uname -m)" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/orbctl +sudo chmod +x /usr/local/bin/orbctl +sudo chown $(id -u):$(id -g) /usr/local/bin/orbctl +``` + +2. Create a git Repository with a [boom.yml](../../examples/boom/boom.yml) +3. Optional: [configure your boom.yml](yml/v1beta2/Toolset.md) +4. [Create SSH Key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key) +5. Add SSH Key to your repository (usually called deployment or access key depending on your git provider) +6. Create an orb config (usually in ~/.orb/config) + +```yaml +url: git@[your-git-provider]:[path-to-your-repository].git +repokey: | + -----BEGIN OPENSSH PRIVATE KEY----- + insert the generated private key + -----END OPENSSH PRIVATE KEY----- +masterkey: [create key with `openssl rand -base64 21`] +``` + +7. Commit / Push everything +8. Make sure your `~/.kube/config` contains a kubeconfig with access to your cluster (https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) +9. Start boom with `orbctl -f ~/.orb/config takeoff --kubeconfig ~/.kube/config` +10. Boom should now be provisioning the applications you configured in your `boom.yml` + ## How does it work The operator works by reading a configuration (crd) located in a GIT Repository. @@ -64,13 +106,6 @@ spec: storageClass: standard ``` -## How to use it - -There has to be a git-repository with an boom.yml in the base. Then a `BOOM` instance can be started with -```bash -orbctl -f $HOME/.orb/config takeoff -``` - -## Structure of the used boom.yml +## Structure of the used boom.yml 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) From 1bf4bb5838c92a3f846b605da0fe5a1bf187e261 Mon Sep 17 00:00:00 2001 From: virth Date: Tue, 26 Jan 2021 12:50:04 +0100 Subject: [PATCH 2/3] type Co-authored-by: Elio Bischof --- docs/boom/boom.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/boom/boom.md b/docs/boom/boom.md index 5986f5653..52867556d 100644 --- a/docs/boom/boom.md +++ b/docs/boom/boom.md @@ -28,7 +28,7 @@ There has to be a git-repository with an boom.yml in the base. Then a `BOOM` ins orbctl -f $HOME/.orb/config takeoff ``` -If you want to run boom together with orbiter you can follow the documentation in the [readme.md](../../readme.md). If you want to run boom on a existing cluster +If you want to run boom together with orbiter you can follow the documentation in the [README.md](../../README.md). If you want to run boom on a existing cluster ## Boom on an existing Cluster From 23969dc42c3df25c5a7c6b2d5a8ec5a044ffa6a0 Mon Sep 17 00:00:00 2001 From: virth Date: Tue, 26 Jan 2021 12:50:12 +0100 Subject: [PATCH 3/3] typo Co-authored-by: Elio Bischof --- docs/boom/boom.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/boom/boom.md b/docs/boom/boom.md index 52867556d..ee0890309 100644 --- a/docs/boom/boom.md +++ b/docs/boom/boom.md @@ -32,7 +32,7 @@ If you want to run boom together with orbiter you can follow the documentation i ## Boom on an existing Cluster -If you just want to use Boom without Orbiter to bootstrap some tools you can follow these steps: +If you just want to use `BOOM` without `ORBITER` to bootstrap some tools you can follow these steps: 1. Install orbctl locally