mirror of
https://github.com/holos-run/holos.git
synced 2026-03-21 01:35:02 +00:00
98 lines
2.3 KiB
Plaintext
98 lines
2.3 KiB
Plaintext
---
|
|
slug: setup
|
|
title: Setup
|
|
description: Install Holos and build the initial structure.
|
|
sidebar_position: 20
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import RenderPlatformDiagram from '@site/src/diagrams/render-platform-sequence.mdx';
|
|
|
|
# Setup
|
|
|
|
## Overview
|
|
|
|
This tutorial will guide you through the installation of Holos and its
|
|
dependencies, as well as the initialization of a minimal Platform that you can
|
|
extend to meet your specific needs.
|
|
|
|
## Installing
|
|
|
|
Holos is distributed as a single file executable that can be installed in a
|
|
couple of ways.
|
|
|
|
<Tabs groupId="FE2C74C8-B3A3-4AEA-BBD3-F57FAA654B6F">
|
|
<TabItem value="brew" label="Install with brew">
|
|
```bash
|
|
brew install holos-run/tap/holos
|
|
```
|
|
</TabItem>
|
|
<TabItem value="go" label="Go">
|
|
```bash
|
|
go install github.com/holos-run/holos/cmd/holos@latest
|
|
```
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
### Completion
|
|
|
|
<Tabs groupId="65F79D28-2E57-4A90-8EBA-3D8758C80233">
|
|
<TabItem value="zsh" label="zsh">
|
|
```bash
|
|
source <(holos completion zsh)
|
|
```
|
|
</TabItem>
|
|
<TabItem value="bash" label="bash">
|
|
```bash
|
|
source <(holos completion bash)
|
|
```
|
|
</TabItem>
|
|
<TabItem value="fish" label="fish">
|
|
```bash
|
|
source <(holos completion fish)
|
|
```
|
|
</TabItem>
|
|
<TabItem value="ksh" label="ksh">
|
|
```bash
|
|
source <(holos completion ksh)
|
|
```
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
### Releases
|
|
|
|
Download `holos` from the [releases] page and place the executable into your
|
|
shell path.
|
|
|
|
### Dependencies
|
|
|
|
Holos integrates with the following tools that should be installed to enable
|
|
their functionality.
|
|
|
|
- [Helm] to fetch and render Helm chart Components.
|
|
- [Kubectl] to [kustomize] components.
|
|
|
|
:::note
|
|
Holos is tested with Helm version `v3.16.2`.
|
|
:::
|
|
|
|
Please try upgrading helm if you encounter `Error: chart requires kubeVersion
|
|
...` errors.
|
|
|
|
## Next Steps
|
|
|
|
You've got the structure of your platform configuration in place. Continue on to
|
|
[Hello Holos] where you'll learn how easy it is to manage a Helm chart with
|
|
holos.
|
|
|
|
[Helm]: https://github.com/helm/helm/releases
|
|
[Kubectl]: https://kubernetes.io/docs/tasks/tools/
|
|
[kustomize]: https://kustomize.io/
|
|
[Local Cluster]: ../topics/local-cluster.mdx
|
|
[Hello Holos]: ./hello-holos.mdx
|
|
[releases]: https://github.com/holos-run/holos/releases
|
|
[k3d]: https://k3d.io/
|
|
[OrbStack]: https://docs.orbstack.dev/install
|
|
[Docker]: https://docs.docker.com/get-started/get-docker/
|