mirror of
https://gitlab.fabcity.hamburg/software/fab-city-os-core-chart.git
synced 2024-09-20 04:18:52 +02:00
82 lines
4.2 KiB
Markdown
82 lines
4.2 KiB
Markdown
<p align="center">
|
||
<img src="https://www.fabcity.hamburg/wp-content/uploads/2021/04/cropped-Fab_City_Hamburg@4x-192x192.png" alt="FabCity Hamburg" width="192" height="192" />
|
||
</p>
|
||
|
||
<h1 align="center">FabCityOS Core Kubernetes Helm Chart</h1>
|
||
|
||
<h4 align="center">
|
||
<a href="https://github.com/FabCityOS Core/FabCityOS Core">Helm Chart</a> |
|
||
<a href="https://reflowos.dyne.org/docs/what_is_reflowOS">Documentation</a> |
|
||
<a href="https://matrix.to/#/#fcos:fabcity.hamburg">Element</a> |
|
||
<a href="https://www.interfacerproject.eu/">Website</a> |
|
||
<a href="https://www.interfacerproject.eu/#news">Blog</a> |
|
||
</h4>
|
||
|
||
<p align="center">
|
||
<a href="https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart/LICENSE"><img src="https://img.shields.io/badge/license-AGPL-informational" alt="License"></a>
|
||
<a href="https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart/-/pipelines"><img src="https://gitlab.fabcity.hamburg/software/fabcity-os-core-chart/badges/main/pipeline.svg" alt="Build status"></a>
|
||
<a href="https://matrix.to/#/#fcos:fabcity.hamburg"><img src="https://img.shields.io/badge/Matrix-FCOS-blue.svg?logo=element" alt="Element"></a>
|
||
</p>
|
||
|
||
<p align="center">The FabCityOS Core Helm Chart for Kubernetes ⚓️</p>
|
||
|
||
This Helm chart is designed to be a lightweight way to configure FabCityOS Core official Docker images.
|
||
|
||
**FabCityOS Core** is an operating system for communities who want to create federated and secure economic networks to foster the creation and coordination of distributed value chains.
|
||
|
||
## Table of Contents <!-- omit in toc -->
|
||
|
||
- [📖 Documentation](#-documentation)
|
||
- [🚀 Getting Started](#-getting-started)
|
||
- [🤖 Compatibility with FabCityOS Core](#-compatibility-with-fabcityos-core)
|
||
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
|
||
|
||
## 📖 Documentation
|
||
|
||
See our [Documentation](https://reflowos.dyne.org/docs/what_is_reflowOS).
|
||
|
||
## 🚀 Getting Started
|
||
|
||
Kubernetes (K8s), is an open-source system for automating deployment, scaling, and management of containerized applications. You can run a FabCityOS Core instance inside your Kubernetes cluster, either if you want to expose it to the outside world or just let some other applications use it inside your cluster and take advantage of the instant and powerful search engine.
|
||
|
||
First of all, you will need a Kubernetes cluster up and running. If you are not familiar with how Kuberentes works or need some help with this step, please check the [Kubernetes documentation](https://kubernetes.io/docs/home/).
|
||
|
||
### Install kubectl <!-- omit in toc -->
|
||
|
||
`kubectl` is the most commonly used CLI to manage a Kubernetes cluster. The installation instructions are [available here](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
|
||
|
||
### Deploy FabCityOS Core using Helm <!-- omit in toc -->
|
||
|
||
#### Install helm <!-- omit in toc -->
|
||
|
||
Helm CLI is a Command Line Interface which will automate chart management and installation on your Kubernetes cluster. To install Helm, follow the [Helm installation instructions](https://helm.sh/docs/intro/install/).
|
||
|
||
#### Install and run FabCityOS Core <!-- omit in toc -->
|
||
|
||
```bash
|
||
helm install fcoscore .
|
||
```
|
||
|
||
#### Uninstalling the Chart <!-- omit in toc -->
|
||
|
||
To uninstall/delete the FabCityOS Core deployment:
|
||
|
||
```bash
|
||
helm uninstall fcoscore
|
||
```
|
||
|
||
## 🤖 Compatibility with FabCityOS Core
|
||
|
||
We recommend that the Helm chart version is aligned to the version of the product you want to deploy. This will ensure that you are using a chart version that has been tested against the corresponding production version.
|
||
This will also ensure that the documentation and examples for the chart will work with the version of the product, you are installing.
|
||
|
||
For example, if you want to deploy an fcoscore `0.1.0` cluster, use the corresponding `0.1.0` [tag][fcoscore-010].
|
||
|
||
The `master` version of these charts is intended to support the latest pre-release versions of our products, and therefore may or may not work with current released versions.
|
||
|
||
## ⚙️ Development Workflow and Contributing
|
||
|
||
Any new contribution is more than welcome in this project!
|
||
|
||
If you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions!
|