Skip to content
Snippets Groups Projects
Commit a2ed9743 authored by fejao's avatar fejao
Browse files

Updated the README.md file

parent 0c1e74bb
No related branches found
No related tags found
1 merge request!1Adding files
Pipeline #37776 passed
Pipeline: c3infodesk-deployment

#37777

    # c3infodesk-deployment-role-dependencies
    # dependencies role
    This ansible-role for dealing with installing the dependencies for deploying the system used from **c3infodesk**.
    ## Mentions
    This role uses great part of it from [geerlingguy](https://github.com/geerlingguy) for installing **docker** at the target host.
    The original code used can be found at: [https://github.com/geerlingguy/ansible-role-docker](https://github.com/geerlingguy/ansible-role-docker)
    ## Requirements
    - To have [ansible](https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html) installed at your system.
    ## Configuration
    You need to set some configuration for this to work
    - ### ansible.cfg
    You have to edit the **ansible.cfg** file to your needs for accessing your target.
    - #### remote_user
    You need to set the **remote_user** configuration for accessing the target host.
    Example: [remote_user](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg#L227)
    - ### HOST_VARS
    In order to access your target host, you need to create/edit your **inventories/host_vars/<YOUR_HOST_NAME>.yml**
    - #### ansible_become_pass
    You need to set the **sudo** password from the user setted on **remote_user** for installing packages and etc. at the target.
    Example: [ansible_become_pass](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/host_vars/example_server.yml#L5)
    ## Getting started
    - ### HOSTS
    You need to provide a **group** in which your target belongs to with the same name setted for **inventories/host_vars/<YOUR_HOST_NAME>.yml**.
    To make it easy for you to get started with GitLab, here's a list of recommended next steps.
    There you can add/edit the target address/IP.
    Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
    Example: [hosts](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/hosts)
    ## Add your files
    ## Role Variables
    Here are the variables setted:
    - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
    - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
    - ### From: inventories/host_vars/<TARGET_NAME>
    Here are the variables that you should be changing for your own deployment.
    - **docker_users**: DEFAULT="[test-user]"
    - The users to be added to the docker group.
    - These users should should contain at least the same user setted on **ansible.cfg** at the **remote_user**
    - **ansible_become_pass**: DEFAULT="Please change this"
    - The password used from the user setted on **ansible.cfg** at the **remote_user**
    - ### From: inventories/group_vars/<TARGET_GROUP>
    This role needs no variable setted on **group_vars**
    - ### From: roles/clone-repositories/defaults/main.yml
    Here are the variables used for this role. Please don't change then here but instead in **inventories/host_vars/<TARGET_NAME>**
    ```
    cd existing_repo
    git remote add origin https://git.cccv.de/fejao/c3infodesk-deployment-role-dependencies.git
    git branch -M main
    git push -uf origin main
    ```
    - **docker_users**
    - **ansible_become_pass**
    - **os_dependencies_packages**
    - **docker_edition**
    - **docker_packages**
    - **docker_packages_state**
    - **docker_obsolete_packages**
    - **docker_obsolete_packages**
    - **docker_service_manage**
    - **docker_service_state**
    - **docker_service_enabled**
    - **docker_restart_handler_state**
    - **docker_install_compose_plugin**
    - **docker_compose_package**
    - **docker_compose_package_state**
    - **docker_install_compose**
    - **docker_compose_version**
    - **docker_compose_arch**
    - **docker_compose_url**
    - **docker_compose_path**
    - **docker_add_repo**
    - **docker_apt_release_channel**
    - **docker_apt_ansible_distribution**
    - **docker_apt_arch**
    - **docker_apt_repository**
    - **docker_apt_ignore_key_error**
    - **docker_apt_gpg_key**
    - **docker_apt_gpg_key_checksum**
    - **docker_apt_filename**
    - **docker_yum_repo_url**
    - **docker_yum_repo_enable_nightly**
    - **docker_yum_repo_enable_test**
    - **docker_yum_gpg_key**
    - **docker_daemon_options**
    ## Integrate with your tools
    - ### From: roles/dependencies/vars/main.yml
    - **docker_packages**
    - **docker_compose_package**
    - [ ] [Set up project integrations](https://git.cccv.de/fejao/c3infodesk-deployment-role-dependencies/-/settings/integrations)
    ## Collaborate with your team
    ## Dependencies
    This role have no dependency from any another role.
    - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
    - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
    - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
    - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
    - [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
    ## Test and Deploy
    ## Example Playbook
    Use the built-in continuous integration in GitLab.
    - ### Using the provided example
    For using the example playbook **[playbooks/examples/example_02_dependencies.yml](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/playbooks/examples/example_02_dependencies.yml)** file you only need to:
    - Change the user at the **[ansible.cfg](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg)** file at the field **[remote_user](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg#L227)** for acessing your target.
    - Update the file **[inventories/host_vars/example_server.yml](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/host_vars/example_server.yml)** and change the value for **[ansible_become_pass](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/host_vars/example_server.yml#L5)** from the **[remote_user](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg#L227)**
    - Update the **[inventories/hosts](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/hosts)** file and change the **[example_server](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/hosts#L2)** with the IP address from your target.
    And run the command:
    ```bash
    ansible-playbook -i inventories/hosts playbooks/examples/example_02_dependencies.yml
    ```
    - ### Setting your own example
    After setting your variables at **inventories/host_vars/<HOST_NAME>**, you can add this role to your playbook as a regular role.
    Here is an example using the **<HOST_NAME>** as **test_servers**
    ```yaml
    - hosts:
    - test_servers
    roles:
    - roles/dependencies
    ```
    And call the playbook as:
    ```bash
    ansible-playbook -i <INVENTORY> <PLAYBOOK_NAME>.yml
    ```
    ## Testing
    You can test this locally using **DIND (docker in docker)** at your own computer using [ansible molecule](https://ansible.readthedocs.io/projects/molecule/installation/)
    - ### Testing requirements
    You need docker installed at your system and the [ansible molecule](https://ansible.readthedocs.io/projects/molecule/installation/).
    You might have to set DIND at your system, for linux, you can create the file **/etc/docker/daemon.json**
    And add the content and restart docker.
    ```json
    {
    "exec-opts": ["native.cgroupdriver=systemd"],
    "features": {
    "buildkit": true
    },
    "experimental": true,
    "cgroup-parent": "docker.slice"
    }
    ```
    - ### Using molecule
    Just go to the root of the role **roles/dependencies** and run the command:
    ```bash
    molecule test
    ```
    - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
    - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
    - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
    - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
    - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
    ***
    # Editing this README
    When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
    ## Suggestions for a good README
    Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
    ## Name
    Choose a self-explaining name for your project.
    ## Description
    Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
    ## Badges
    On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
    ## Visuals
    Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
    ## Installation
    Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
    ## Usage
    Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
    ## Support
    Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
    ## Roadmap
    If you have ideas for releases in the future, it is a good idea to list them in the README.
    ## Contributing
    State if you are open to contributions and what your requirements are for accepting them.
    For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
    ## License
    You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
    MIT / BSD
    ## Authors and acknowledgment
    Show your appreciation to those who have contributed to the project.
    ## License
    For open source projects, say how it is licensed.
    ## Author Information
    ## Project status
    If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
    [https://chaos.social/@fejao](https://chaos.social/@fejao)
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment