mirrors/khuedoan-homelab
1
0
Fork 0
mirror of https://github.com/khuedoan/homelab.git synced 2025-01-08 14:33:52 +07:00
Code Issues Packages Projects Releases Wiki Activity
cd41343580
khuedoan-homelab/docs/installation/development.md
Khue Doan cd41343580
refactor(docs): migrate to mkdocs (#68) 
* refactor(docs): migrate to mkdocs

* More markdown

* Admonitions
2022-07-06 12:33:35 +07:00

1.1 KiB
Raw Blame History

Development environment

Caveats compare to production environment

The development cluster doesn't have the following features:

  • There is no valid domain name, hence no SSL certificates (some services require valid SSL certificates)
  • Only accessible on the host machine
  • No backup

Please keep in mind that the development cluster may be unstable and things may break (it's for development after all).

Prerequisites

Host machine:

  • OS: Linux (Windows and macOS will not work due to networking limitations, you can use a Linux VM)
  • Recommended hardware specifications:
    • CPU: 4 cores
    • RAM: 16 GiB

Install the following packages:

  • docker
  • make

Clone the repository and checkout the development branch:

git clone https://github.com/khuedoan/homelab
git checkout dev

Build

Open the tools container:

make tools

Build a development cluster and bootstrap it:

make

Look for the dashboard URL in the command output.

Clean up

Delete the cluster:

k3d cluster delete homelab-dev