fab-city-os-core-chart/README.md

<p align="center">
  <img src="https://raw.githubusercontent.com/dyne/interfacer-docs/main/docs/_media/general/interfacer-logo.png" alt="Interfacer" />
</p>

<h1 align="center">FCOS Core Helm Chart for Kubernetes ⚓️</h1>

<h4 align="center">
  <a href="https://reflowos.dyne.org/docs/what_is_reflowOS">Documentation</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/fcoscore-chart/LICENSE"><img src="https://img.shields.io/badge/license-AGPL-informational" alt="License"></a>
  <a href="https://matrix.to/#/#fcos:fabcity.hamburg"><img src="https://img.shields.io/badge/Matrix-FCOS-blue.svg?logo=element" alt="Matrix"></a>
</p>

**FCOS 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.

This Helm chart is designed to be a lightweight way to configure the FCOS Core official Docker images.

## Table of Contents <!-- omit in toc -->

- [📖 Documentation](#-documentation)
- [🚀 Getting Started](#-getting-started)
  - [Install kubectl](#install-kubectl)
  - [Install helm](#install-helm)
  - [Install FCOS Core](#install-fcos-core)
    - [From the source files](#from-the-source-files)
    - [From the repository](#from-the-repository)
- [⚙️ 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 FCOS 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

`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/).

### Install helm

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 FCOS Core

#### From the source files

```sh
git clone https://gitlab.fabcity.hamburg/software/fcoscore-chart.git
cd fcoscore-chart
helm install fcoscore .
```

#### From the repository

```sh
helm repo add fcoscore-alpha https://gitlab.fabcity.hamburg/api/v4/projects/248/packages/helm/alpha
helm repo update fcoscore-alpha
helm install fcoscore fcoscore-alpha/fcoscore
```

### Uninstalling the Chart <!-- omit in toc -->

To uninstall/delete the FCOS Core deployment:

```sh
helm uninstall fcoscore
```

## ⚙️ 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!