From 401b707f86bce33303a3e89d8652c4a99ecda07e Mon Sep 17 00:00:00 2001 From: Halima-saker Date: Wed, 15 Nov 2023 10:39:18 +0100 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 83c13a6..f068be4 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,35 @@ The setup also includes Data Replication with DRBD and distributed storage with - A domain name pointing to the IP address of the reverse proxy. - SSH access to all target servers with sudo privileges. - A basic understanding of GitLab and its architecture. -The inventory file is configured with the target server details. +- The inventory file is configured with the target server details. ## Configuration -- Inventory File: Modify the `inventory.ini` file with your target server details. +- Inventory File: Modify the inventory file with the target server details. - In the `roles` repository, there are sub-repositories for GitLab, Keycloak, and nginix-proxy. Edit Variables, yml files, and config files located in each sub-repository to match your environment. -- -## Supported services +## Notes -Using this playbook, you can get the following list of services configured on your server. Basically, this playbook aims to get you up-and-running with all the necessities around GitLab, without you having to do anything else. +Basically, this playbook aims to get you up-and-running with all the necessities around GitLab, without you having to do anything else. +- Ensure that your servers meet the hardware and software requirements for GitLab, Keycloak, DRBD, and Ceph. +- This playbook assumes a fresh installation. Ensure there is no conflicting software on the target servers. + +## Post-Deployment Steps + +1. **Access GitLab:** + - URL: http://gitlab_instance_ip + - Initial login credentials: admin / your_chosen_password + +2. **Access Keycloak:** + - URL: http://keycloak_instance_ip:8080 + - Initial login credentials: admin / admin + +3. **DRBD and Ceph:** + - Verify the status and health of DRBD and Ceph after the deployment. + +## **Maintenance** +Regularly update the inventory files, yml files, and variables for any changes in the environment. +Check for updates to GitLab, Keycloak, DRBD, and Ceph. Update variables accordingly. ## Infrastructure Overview @@ -35,7 +53,7 @@ Our GitLab DataHub installation utilizes the following components: ## Changes - This playbook evolves over time, sometimes with backward-incompatible changes. When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up with what's new. +