mirror of
https://gitlab.fabcity.hamburg/software/fab-city-software-kit.git
synced 2024-09-20 04:18:51 +02:00
86 lines
4.6 KiB
Markdown
86 lines
4.6 KiB
Markdown
<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">Interfacer SWKit for Kubernetes ⚓️</h1>
|
||
|
||
<h4 align="center">
|
||
<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/interfacer-swkit/LICENSE"><img src="https://img.shields.io/badge/license-AGPL-informational" alt="License"></a>
|
||
<a href="https://gitlab.fabcity.hamburg/software/interfacer-swkit/-/pipelines"><img src="https://gitlab.fabcity.hamburg/software/interfacer-swkit/badges/main/pipeline.svg" alt="Pipeline"></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>
|
||
|
||
This Repo is designed to be a lightweight way to configure the Interfacer SWKit applications. Interfacer SWKit is a bundle of Applications to enabling a data-based circular economy via global collaboration and local production.
|
||
|
||
## Table of Contents <!-- omit in toc -->
|
||
|
||
- [📖 Documentation](#-documentation)
|
||
- [🚀 Getting Started](#-getting-started)
|
||
- [Repository structure](#repository-structure)
|
||
- [Install kubectl](#install-kubectl)
|
||
- [Install helm](#install-helm)
|
||
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
|
||
|
||
## 📖 Documentation
|
||
|
||
- [kubectl](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands)
|
||
- [kustomize](https://kubectl.docs.kubernetes.io/guides/)
|
||
- [helm](https://helm.sh/docs/)
|
||
- [cert-manager](https://cert-manager.io/docs/)y
|
||
|
||
## 🚀 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/).
|
||
|
||
### Repository structure
|
||
|
||
```yaml
|
||
├── base # kustomize global objects folder
|
||
│ ├── kustomization.yaml # kustomize global application config
|
||
│ └── ... # kustomize global cluster objects
|
||
├── apps # kustomize global applications folder
|
||
│ ├── gitea # kustomize global application folder
|
||
│ │ ├── kustomization.yaml # kustomize global application definition
|
||
│ │ ├── charts # helm global chart config folder
|
||
│ │ └── ... # kustomize global application objects
|
||
│ └── ... # kustomize global applications objects
|
||
├── overlays # kustomize environment overrides
|
||
│ ├── dev # kustomize environment specific
|
||
│ │ ├── kustomization.yaml # kustomize environment definition
|
||
│ │ └── cert-manager # kustomize applications folder
|
||
│ │ ├── kustomization.yaml # kustomize application config
|
||
│ │ └── ... # kustomize application objects
|
||
│ └── ... # kustomize environment folder
|
||
├── .envrc # direnv support file
|
||
└── flake.nix # nix flake for local runtime dependency
|
||
```
|
||
|
||
### 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` 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/).
|
||
|
||
#### Deploy the SWKit <!-- omit in toc -->
|
||
|
||
```sh
|
||
git clone https://gitlab.fabcity.hamburg/software/interfacer-swkit.git
|
||
cd interfacer-swkit
|
||
kubectl kustomize --enable-helm | kubectl apply -f -
|
||
```
|
||
|
||
## ⚙️ 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!
|