https://github.com/pusher/faros

Faros is a CRD based GitOps controller
https://github.com/pusher/faros

cloud-infrastructure hacktoberfest

Last synced: 3 months ago
JSON representation

Faros is a CRD based GitOps controller

• Host: GitHub
• URL: https://github.com/pusher/faros
• Owner: pusher
• License: apache-2.0
• Archived: true
• Created: 2018-08-08T13:31:35.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-09-27T23:46:42.000Z (over 3 years ago)
• Last Synced: 2024-08-02T06:12:44.572Z (6 months ago)
• Topics: cloud-infrastructure, hacktoberfest
• Language: Go
• Homepage:
• Size: 17.7 MB
• Stars: 100
• Watchers: 6
• Forks: 15
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-gitops - Faros - CRD based GitOps controller (Tools)

README

        


# Faros

> Faros - Greek for Lighthouse

> NOTE: this repository is currently **UNMAINTAINED** and is looking for new owner(s).

> See [#190](/../../issues/190) for more information.

Faros is a GitOps controller that takes a Git repository reference from a

Custom Resource Definition (CRD) and applies resources within the repository to

a Kubernetes cluster.

Faros aims to make it easier for teams to ensure that the desired state of their

applications is synchronised between a Kubernetes cluster and Git.

Typically, a team running workloads on Kubernetes will use

infrastructure-as-code concepts and keep a copy of their deployment

configuration under source control just as they do with their product code.

The process of taking this desired state from Git and applying it to the

Kubernetes cluster is the problem Faros aims to solve.

By providing Faros with a reference to a Git repository (URL and Git Reference

(eg master)), credentials to access the repository and an optional path within

the repository, Faros will load all Kubernetes resource definitions from the

repository and synchronise these with the Kubernetes cluster.

Faros then watches the child resources (resources created from the repository)

and, if they are ever modified, reverts the change back to the state of the Git

repository.

This allows users to make changes to their deployment configuration exclusively

in Git, which in turn enables them to audit and peer review those changes as

well as providing a canonical history of what was deployed and when.

Note: This is a proof of concept in the early alpha stage.

We are providing no guarantees and recommend that you test and thoroughly

understand the project before deploying to production.

## Documentation

For more information about how to build, install and run Faros, see our [documentation](https://pusher.github.io/faros)

## Communication

- Found a bug? Please open an issue.

- Have a feature request. Please open an issue.

- If you want to contribute, please submit a pull request

## Contributing

Please see our [Contributing](CONTRIBUTING.md) guidelines.

## License

This project is licensed under Apache 2.0 and a copy of the license is available [here](LICENSE).