freeleaps-ops/README.md

32 lines
1.2 KiB
Markdown
Raw Normal View History

# Freeleaps Ops
> All GitOps relates manifests or scripts.
## Introduce
This repo has stored all manifests files of Freeleaps productions, infrastructures and cluster.
The project layout is follow this pattern:
![layout](assets/layout.png)
## How to use ?
**Please do not edit files under this repo if you do not know what you doing.**
This repo files are managed by CI/CD services (Jenkins, Argo CD etc,.).
## About `cluster` folder
**P.S. THIS FOLDER IS ONLY USED FOR CLUSTER ADMINISTRATOR, YOU MUST KNOW WHAT YOU DOING BEFORE YOU MODIFY IT.**
> If you want to working with cluster folder, you must set-up local maintaining environment first.
> You need make sure you have `Python 3` environment in local and `Ansible` already installed.
> And you need to make sure run `git submodule update --init --recursive` to clone `kubespray` repo before you start to work.
`cluster` folder stores the infrastructure components, applications manifests and [`kubespray`](https://kubespray.io/) configuration files for entire cluster.
`cluster/manifests/<namespace>/<component>` stores the manifests of components or applications.
`cluster/ansible/` see [cluster/ansible/README.md](./cluster/ansible/README.md)