Skip to content

Commit

Permalink
docs: finalizing Horizon installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mherwig committed Mar 12, 2024
1 parent bb92ead commit c344a47
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,13 @@ A simple example Subscription for callback delivery would look like this:

If the creation, update and deletion of subscriptions is to be automated, it is advisable to install a service account with appropriate rights in the cluster namespace in advance. A corresponding example can be found here: [resources/rbac.yaml](https://github.com/telekom/pubsub-horizon/blob/main/resources/rbac.yaml)


## Getting started

If you want to learn more about how to install and run Horizon in a Kubernetes environment in general, visit: [Installing Horizon](https://github.com/telekom/pubsub-horizon/blob/main/docs/installation.md)
But if you want to get started right away with a non-productive local environment and try out Horizon, we recommend visting: [Local installation (Quickstart)](https://github.com/telekom/pubsub-horizon/blob/main/docs/quickstart.md).


## Code of Conduct

This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.1 as our code of conduct. Please see the details in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). All contributors must abide by the code of conduct.
Expand Down
13 changes: 8 additions & 5 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Installing Horizon

## Preface

This article describes more generally how Horizon can be installed and operated in a Kubernetes environment. It serves less as a step-by-step guide.

If you want to get started right away, we recommend visting: [Local installation (Quickstart)](https://github.com/telekom/pubsub-horizon/blob/main/docs/quickstart.md).
By following the instructions there, you can very quickly create a non-production environment locally on your system in which Horizon can be tested.

## Prerequisites

### Kubernetes
Expand Down Expand Up @@ -247,8 +254,4 @@ Additionally you should set the correct image repository for each sub-product im

```
helm upgrade -i -n horizon -f horizon-nonprod.yaml horizon ./horizon-all
```

## 4. Test

*// work in progress*
```
14 changes: 14 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ By following this quickstarter guide line by line, you will obtain an running in

>*This guide has been written for and tested with k3d version v5.6.0, k3s version v1.27.4-k3s1, kubernetes version v1.27.4, and Helm version v3.14.1 on Microsoft Windows 10 (x64) with Docker Desktop version 4.28.0.*

## System requirements

* Microsoft Windows 10 (x64) or later
* Docker Desktop installed
* At least 6 GB free RAM recommended

If needed, limit the memory usage of Docker Desktop when creating/adjusting the `%USERPROFILE%/.wsl2config`:
```
[wsl2]
memory=6GB
````
## Prepare the environment
* Install `scoop` CLI package manager:
Expand Down

0 comments on commit c344a47

Please sign in to comment.