Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 3.18 KB

README.md

File metadata and controls

113 lines (77 loc) · 3.18 KB
Raw

GitHub go.mod Go version LICENSE Releases GitHub Repo stars

English / 中文


Logo

Magi

A GitOps PaaS based on FluxCD and Kustomize.

Introduction

Screen Shot

Magi is a K8s GitOps PaaS. Your projects, applications, environments, variables can be managed, configured and published through UI, and all changes will be recorded in git ,then synchronized to the K8s cluster by FluxCD. Magi uses Kustomize to manage K8s yaml files, providing rich extensions without introducing too many concepts, reducing additional learning costs, and easily deploying your project with tools such as kubectl even with yaml files in git repository.

Feature：

  • GitOps，all yaml files will store in git repository，all change will be versioned by git.
  • Multi cluster， multi environment ,multi variable support.
  • Support config management.
  • Internationalization support.

Demo

Magi Demo

  • Username: demo
  • Password: Magi@1

Getting Started

Prefix: You need to have a K8s cluster, an environment with docker & docker-compose installed.

  1. Install FluxCD onto your K8s cluster. You can follow FluxCD docs to do this.

    Install flux

    Note:

    • only support GitHub now.
    • only support FluxCD monorepo mode.
    • only support Kustomize, so [Helm Controller] is not necessary.
    • path must be clusters/ , foo must be cluster code when you add cluster in Magi.

    Your command may like:

    flux bootstrap github \
  --owner=you \
  --repository=magi-flux \
  --path=clusters/cluster-01 \
  --private=true \
  --personal=true \
  --components=source-controller,kustomize-controller

  2. Clone Project

    git clone https://github.com/magi/magi.git

  3. Go to docker compose file

    cd magi/hack/deploy/docker-compose

  4. Change Magi config with file config/magi-config, git repo need to set the repository configured by FluxCD above

  5. Run Magi

    docker-compose -p magi up -d

    When all container started, you can open Magi in browser by default port 8086.

    Default user & password are admin, admin

Roadmap

  • Add permission control for resources
  • Add LDAP support
  • Add FluxCD status view
  • Support GitLab

License

Magi is licensed under the Apache License Version 2.0 , please refer to the license for details.