Skip to content

Commit

Permalink
cloud-in-a-box: improve & add /etc/hosts entries (#744)
Browse files Browse the repository at this point in the history
Part of osism/cloud-in-a-box#336

Signed-off-by: Christian Berendt <[email protected]>
  • Loading branch information
berendt authored Jan 5, 2025
1 parent 0e692e8 commit c3bd79d
Showing 1 changed file with 35 additions and 8 deletions.
43 changes: 35 additions & 8 deletions docs/guides/other-guides/cloud-in-a-box/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
sidebar_label: Cloud in a Box Guide
---

# Cloud in a Box - CiaB
# Cloud in a Box

💡 Cloud in a Box (CiaB) is a minimalistic installation of the latest stable OSISM release with only services which are needed to
make it work with Kubernetes. It is intended for use as a development
system on bare-metal or for use in edge environments.
make it work with Kubernetes. It is intended for use as a development system on bare-metal or for use in edge environments or for
training purposes. Its flexibility makes it ideal for building, testing, and refining cloud infrastructure setups in controlled
environments, enabling teams to experiment with different configurations and scenarios before deploying them to production

:::warning

Expand All @@ -29,7 +30,7 @@ The system to be used as Cloud in a Box must fulfill these minimum requirements.

## Types

There are two types of Cloud in a Box.
There are three types of Cloud in a Box.

1. The **sandbox** type is intended for developers and demonstrations. A full OSISM installation
is one there which also includes Ceph and OpenSearch, for example. In the course of the
Expand All @@ -41,6 +42,9 @@ There are two types of Cloud in a Box.
delivered to a central location. The storage backend will also be implemented differently there
in the future instead of Ceph.

3. The **kubernetes** type is intended to be deployed as an appliance to provide a edge Kubernetes
cluster on a single node.

## Installation

### Automated installation (recommended)
Expand Down Expand Up @@ -170,7 +174,7 @@ start over with fresh installation.
### Wireguard VPN service access

Copy the `/home/dragon/wireguard-client.conf` file from Cloud in a Box to your workstation. This is necessary
for using the web endpoints on your workstation. Rename the wireguard config file to something
for using the web endpoints on your workstation. Rename the Wireguard config file to something
like `cloud-in-a-box.conf`.

If you want to connect to the Cloud in a Box system from multiple clients, change the client IP
Expand All @@ -180,16 +184,39 @@ address in the config file to be different on each client.
scp dragon@IP_FROM_YOUR_SERVER:/home/dragon/wireguard-client.conf $HOME/cloud-in-a-box.conf
```

Install wireguard on your workstation, if you have not done this before. For instructions how to do
Install Wireguard on your workstation, if you have not done this before. For instructions how to do
it on your workstation, please have a look on the documentation of your used distribution. The
wireguard documentation you will find [here](https://www.wireguard.com).
Wireguard documentation you will find [here](https://www.wireguard.com).

Start the wireguard tunnel.
Start the Wireguard tunnel.

```bash
sudo wg-quick up $HOME/cloud-in-a-box.conf
```

Once the Wireguard tunnel has been set up, it is possible to access individual services on a name-based basis.
As a test, you can try whether the name `api.in-a-box.cloud` resolves correctly to the IP address `192.168.16.254`.

```
dig +short A api.in-a-box.cloud
192.168.16.254
```

If this does not work, a DNS filter such as Pi-hole or AdGuard will most likely be used. This ensures that private
IP ranges such as `192.168.16.0/20` are not resolved via a public DNS server. If this is the case, the following
entries must be added to the local `/etc/hosts` file for the name resolution to work.

```
192.166.16.10 cgit.services.in-a-box.cloud
192.166.16.10 netbox.services.in-a-box.cloud
192.168.16.10 ara.services.in-a-box.cloud
192.168.16.10 flower.services.in-a-box.cloud
192.168.16.10 homer.services.in-a-box.cloud
192.168.16.10 phpmyadmin.services.in-a-box.cloud
192.168.16.10 manager.systems.in-a-box.cloud
192.168.16.254 api.in-a-box.cloud
```

### Webinterfaces

If you want to access the services please choose the URL from the following list:
Expand Down

0 comments on commit c3bd79d

Please sign in to comment.