docs: add docs on omni with external etcd#448
Open
Iheanacho-ai wants to merge 1 commit intosiderolabs:mainfrom
Open
docs: add docs on omni with external etcd#448Iheanacho-ai wants to merge 1 commit intosiderolabs:mainfrom
Iheanacho-ai wants to merge 1 commit intosiderolabs:mainfrom
Conversation
Iheanacho-ai
force-pushed
the
external-etcd
branch
from
0b40d38 to
f10ce8f
Compare
Iheanacho-ai
force-pushed
the
external-etcd
branch
5 times, most recently
from
a4c4bf3 to
a3fa826
Compare
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
Iheanacho-ai
force-pushed
the
external-etcd
branch
from
a3fa826 to
de513c5
Compare
rothgar
reviewed
Mar 30, 2026
| Run the following on each node that does not already have Docker installed. | ||
|
|
||
| ```bash | ||
| sudo apt-get update |
Member
There was a problem hiding this comment.
Instead of manual steps that only work on ubuntu I prefer
curl -fsSL https://get.docker.com | sudo bashThis works on every supported distro and automatically installs/uninstalls required dependencies.
rothgar
reviewed
Mar 30, 2026
| Omni and its supporting services run as Docker containers. | ||
|
|
||
| ```bash | ||
| sudo apt-get update |
Member
There was a problem hiding this comment.
use script here too
curl -fsSL https://get.docker.com | sudo bash
rothgar
reviewed
Mar 30, 2026
|
|
||
| There are two easy ways to run Omni: docker-compose and a simple `docker run`. We recommend using docker-compose, but both are detailed in separate tabs below. | ||
| ```bash | ||
| sudo apt-get install -y apache2-utils |
Member
There was a problem hiding this comment.
This only works on Ubuntu. We can use the apache2 docker container to run htpasswd command. There's an example in our docs already.
rothgar
reviewed
Mar 30, 2026
| -v $(pwd)/omni.asc:/omni.asc:ro,Z \ | ||
| -v $HOME/sqlite:/_out/sqlite:rw,Z \ | ||
| ghcr.io/siderolabs/omni:${OMNI_VERSION} \ | ||
| --name=onprem-omni \ |
rothgar
reviewed
Mar 30, 2026
| -v $HOME/etcd-certs/client-key.pem:/etcd/client.key:ro,Z \ | ||
| -v $HOME/sqlite:/_out/sqlite:rw,Z \ | ||
| ghcr.io/siderolabs/omni:${OMNI_VERSION} \ | ||
| --name=onprem-omni \ |
rothgar
reviewed
Mar 30, 2026
|
|
||
| You will need to specify some customizations for your installation. Export these variables with your information to use in the provided templates | ||
| </Tab> | ||
| <Tab title="Linux"> |
Member
There was a problem hiding this comment.
Ubuntu/Debian and Red Hat/centos/fedora have different commands. You'll want tabs for both. (see the air gapped guide for examples)
rothgar
reviewed
Mar 30, 2026
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### 9.4: Flush your DNS cache |
Member
There was a problem hiding this comment.
I'm pretty sure /etc/hosts is always read before DNS cache from a local resolver so this step shouldn't be needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #307