From 2ea371f9875734aae2c79eb5adaaae64931e8ef9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A1n=20Robotka?= <robotka.adrian@gmail.com>
Date: Fri, 26 Mar 2021 13:09:14 +0100
Subject: [PATCH] update readme
---
README.md | 42 ++++++++++---------
.../.gitignore | 0
.../README.md | 0
.../delete_merged_branches.py | 0
.../functions.py | 0
.../list_projects.py | 0
.../requirements.txt | 0
.../setup_projects.py | 0
8 files changed, 23 insertions(+), 19 deletions(-)
rename {gitlab-api-opressor => gitlab-api-scripts}/.gitignore (100%)
rename {gitlab-api-opressor => gitlab-api-scripts}/README.md (100%)
rename {gitlab-api-opressor => gitlab-api-scripts}/delete_merged_branches.py (100%)
rename {gitlab-api-opressor => gitlab-api-scripts}/functions.py (100%)
rename {gitlab-api-opressor => gitlab-api-scripts}/list_projects.py (100%)
rename {gitlab-api-opressor => gitlab-api-scripts}/requirements.txt (100%)
rename {gitlab-api-opressor => gitlab-api-scripts}/setup_projects.py (100%)
diff --git a/README.md b/README.md
index a30c21b..d9a83c2 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,29 @@
-# Authority of the Ansible subgroup
+# Authority of the Ansible group
-# Content of the repo
+## Content of the repo
-- CI config for the whole subgroup
-- GitLab API scripts to setup repos in the subgroup
-- Template files for the playbooks
+- `ci/` - CI config for the whole subgroup
+ - Group-level specified CI config instead of repo sepcific configs
+- `gitlab-api-scripts/` - GitLab API scripts to setup repos in the subgroup
+- `playbook-template/` - Template files for the playbooks
+ - Used for local bootstrapping
-# Usage example of the CI
+## What is Ansible, and what is it good for?
-Example `.gitlab-ci.yml` files. Check tags under `https://git.sch.bme.hu/kszk/sysadmin/ansible/ansci/-/tags`
+TODO write 2 paragraph about what is it good for
-```yaml
-include:
- - project: kszk/sysadmin/ansible/ansci
- ref: 0.1.0
- file: /pipeline/playbook.yaml
-```
+## Ansible quick-start
+
+TODO link or wirete a good tutorial
+
+## Tools we have
+
+We have tools to automate a bunch of things in KSZK:
+
+- [Git.sch ansible group](https://git.sch.bme.hu/kszk/sysadmin/ansible)
+ - roles, playbooks, pipelines
+- VMware resource groups
+ - to get resources to test and deploy
+ - more info in [~sysadmin-vmware](https://mattermost.kszk.bme.hu/kszk/channels/sysadmin-vmware)
+- [AWX](https://ansible.kszk.bme.hu/): to run playbooks automatically on servers
-```yaml
-include:
- - project: kszk/sysadmin/ansible/ansci
- ref: 0.1.0
- file: /pipeline/role.yaml
-```
diff --git a/gitlab-api-opressor/.gitignore b/gitlab-api-scripts/.gitignore
similarity index 100%
rename from gitlab-api-opressor/.gitignore
rename to gitlab-api-scripts/.gitignore
diff --git a/gitlab-api-opressor/README.md b/gitlab-api-scripts/README.md
similarity index 100%
rename from gitlab-api-opressor/README.md
rename to gitlab-api-scripts/README.md
diff --git a/gitlab-api-opressor/delete_merged_branches.py b/gitlab-api-scripts/delete_merged_branches.py
similarity index 100%
rename from gitlab-api-opressor/delete_merged_branches.py
rename to gitlab-api-scripts/delete_merged_branches.py
diff --git a/gitlab-api-opressor/functions.py b/gitlab-api-scripts/functions.py
similarity index 100%
rename from gitlab-api-opressor/functions.py
rename to gitlab-api-scripts/functions.py
diff --git a/gitlab-api-opressor/list_projects.py b/gitlab-api-scripts/list_projects.py
similarity index 100%
rename from gitlab-api-opressor/list_projects.py
rename to gitlab-api-scripts/list_projects.py
diff --git a/gitlab-api-opressor/requirements.txt b/gitlab-api-scripts/requirements.txt
similarity index 100%
rename from gitlab-api-opressor/requirements.txt
rename to gitlab-api-scripts/requirements.txt
diff --git a/gitlab-api-opressor/setup_projects.py b/gitlab-api-scripts/setup_projects.py
similarity index 100%
rename from gitlab-api-opressor/setup_projects.py
rename to gitlab-api-scripts/setup_projects.py
--
GitLab