Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vanillastack/vanillastack

Public VanillaStack repository
https://github.com/vanillastack/vanillastack

Last synced: 13 days ago
JSON representation

Public VanillaStack repository

Awesome Lists containing this project

README 

        
= VanillaStack



image:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg[link="https://github.com/semantic-release/semantic-release",title="Semantic release"]

image:https://open.rocket.chat/images/join-chat.svg[link="https://rocketchat.vanillastack.io",title="VanillaStack Rocket.Chat instance"]



There are multiple Vendor-Stacks out there, that promise to deliver an installation without hazzles, full integration and total flexibility - only to vendor lock you to the tools, frameworks and interfaces of a product.



VanillaStack wants to be and is different: VanillaStack offers the integration of plain upstream projects. VanillaStack will use directly the core components of Kubernetes, Ceph, Rook, Harbor and many more.



This ensures, at any time, to work around or without VanillaStack, because, Vanilla doesn't want to own the stack. Vanilla wants to help but imposes no limits on your tooling.



== The VanillaStack project



VanillaStack understands Kubernetes as the operating system of your datacenter and helps you to setup a seamless installation of core cloud services.

It offers a cloudstack installation of the following OpenSource projects:



* Kubernetes

* Rook Ceph

* Prometheus

* Postgres Operator

* ... and more



The VanillaStack project is licensed under link:LICENSE[Apache 2.0 License].



== VanillaStack Project Scope & Core Design Goals



Kubernetes First::

VanillaStack understands Kubernetes as its operating system.

All additional components are rolled out within containers.

Always and everwhere.



IaaS. CaaS. PaaS. All included. All working::

VanillaStack is based on the best Container-as-a-Service-platform: Kubernetes.

All from an easy to use installer, all working out-of-the-box.



The best management and operations tools::

With VanillaStack, the most commonly used management and operations tools, are just a click away.

Enjoy operations.



Commercial and Open-Source ecosystem::

VanillaStack is not a Kubernetes distribution. VanillaStack is an open-source ecosystem.

The core of VanillaStack are a web-based installer and a web-based AppStore.

Open for everyone, be it open-source or commercial offering.

But always quality assured and curated.



Only Open-Source. Only Community-Projects::

VanillaStack is made of open-source projects only.

We use the vanilla community projects.

No vendor lock, no proprietary code, no hidden magic.

Only open-source and only community.



== Vanilla Community Values



Inclusive::

Our ambitions are global. The Vanilla community is, too. The perspectives and skills necessary to achieve our goals are wide and varied; we believe in creating a community and a project that is inclusive, accessible, and welcoming to everyone.

Open::

We are dedicated to remaining open and transparent. We believe in keeping Vanilla Community code freely and fully available to be viewed, modified, and used without vendor lock-in or other in-built limitations.

Inspired::

Vanilla is all about the challenge. Our goals are not small: we want to build the best and simple to use Cloud stack, one that can work with any hardware and interoperate with all workloads. Vanilla is built on hard work, ingenuity, and an engineering mindset. We embrace hard problems and find inspired solutions.

Evolving::

Vanilla is continuously growing and adapting. As a community project, there is no limit to its development. We continuously make room for improvement and welcome the opportunities offered by the ever-evolving nature of community projects.



We are excited about your interest in Vanilla and hope you will join us. We take our community very seriously, and we are committed to creating a community built on respectful interactions and inclusivity



////

== How to Get Started



* The installer is only a side module that can run anywhere on your network (even locally on your desktop).

* The installer must be able to login via SSH into the nodes that VanillaStack will be installed on.

* The User for the login must be able to do sudo

* The installer will create an unique SSH Keypair everytime it runs. This Key must be manually installed on your nodes by *YOU* footnote:[This ensures that none of *your* private keys get leaked while possibly transferring them. This way, a key ist created and destroyed after installation and you are free to remove the key anytime you wish from your nodes]



* Variant a) Use a machine with an ready made installation ISO image:

** Download the ISO and Boot it: `https://downloads.vanillastack.io/iso/live-image/vanillastack-installer-amd64.hybrid.iso`



* Variant b) Use an already running Docker instance:

** pull and run the Docker-Container if you have a local docker running already:



$ docker run --name vanilla --rm harbor.vanillastack.io/vanillastack/installer



** Point your browser to the installer at `http://localhost:8080`



== Requirements



VanillaStack Installer:



* a working local Docker installation __or...__

* __...or__ a empty machine (can be virtual) for running ISO image

* SSH-access to the machines that vanillastack should be installed on

*



////



VanillaStack requirements::



* Internet network access

  ** `https://harbor.vanillastack.io`

* Debian 11 or RHEL 8 (tested with RHEL 8.6)



== Installation Guide



A detailed Installation Instruction can be found at link:https://docs.vanillastack.io[Vanillastack User Guide]



== Update Vanillastack



An Update from Vanillastack Version 1.8.2 to 2.0.0 is not possible. The Vanillastack needs a new installation.



== Ressources



* Main Hub around the Project is the link:https://vanillastack.io/[Website]

* Check out our link:https://www.youtube.com/playlist?list=PLJcz3tF8m0MS7DbVXzutPpJW-Vc_-9d_N[Youtube Channel]

* Bugs, Suggestions, Feature Requests are reported in the related Repository.



////

* Discussions are happening on our link:https://discourse.vanillastack.io/[Discourse] Channels

* live discussions are possible at: link:https://rocketchat.vanillastack.io[Rocket.Chat]

////



== Contribution



Please read and apply the following rules to contribute to this project:



* One git repository for all automation code (THIS REPOSITORY ONLY!)

* How to contribute to this repository?

  ** Keep it modular - write Ansible roles! each feature should be one role

  ** documentation for

  ** Work with branches

    *** master branch = production branch, used for all production setups

    *** feature branch = personal branches to work on a new feature (based on master branch)

  ** Make it understandable for other persons

    *** Comment your code

    *** Each role needs a description

      *** What is the role doing?

      *** What is required for usage?

    ** Make usefull commits

      *** Use semantic tags to control releases. for more informatins see linnk:https://github.com/semantic-release/semantic-release/blob/master/README.md#how-does-it-work

      *** Use Tags: ADD / NEW / FIX / CHG in front of your commits

      *** Use Comment tag for deeper information at bigger changes

  ** No hardcoding

    *** use variables

    *** variables must be defined outsite of the role (vars, group_vars, host_vars, etc)

  ** New features needs to merged into the master branch by using pull-requests

    *** the code needs to be review and approved by 2 team members

    *** the approvement needs to be documented!

    *** all new features merges needs the documentation part in the merge request!

  ** NEVER commit keys, credentials, usernames, passwords, etc to the git repository!!!

    *** all keys and credentials must be stored in AWX

  ** using shell scripts / bash commands is the last option

    *** only if there is no Ansible module available

    *** single commands can be used by command/shell module

    *** multiline commands needs to be stored in an script

    *** script/bash usage must be documented in detail (why you are using this?)

    *** the Ansible role must be able to handle bash command errors

* Bug handling

  ** For each Bug open an Issue at the gitlab project page

  ** Bugs will be tracked by the project board

* Feature requests

  ** Feature requests can be requestes by creating an Issue

  ** Feature requests will be tracked by the project board

* Playbooks don't execute any tasks, they are used to call roles.

  ** Every Role is used for one part and should include multiple tasks

  ** tasks should not be to complex, f.e. you do not provision a bastion host and install kubernetes on top in one task



=== Cloning the Repository



This project uses git submodules to ensure you get everything needed, please use the following command(s):

[source,console]

----

# For git >= 2.13

git clone --recurse-submodules GIT_REPOSITORY_URL

# For older git versions

git clone GIT_REPOSITORY_URL

cd REPO_NAME

git submodule update --init --recursive

----



=== Workflow

* Create a feature / personal branch based on the master branch

* Change your stuff

* Create a merge request to "testing" branch

* Two Developers / Maintainers needs to review and ACK the changes by +1

* One of the Maintainers merge the branch to "testing"

* Pipeline is starting. If successful the testing branch will be merged to master automatically.