Commit 31979b55 authored by David Nowell's avatar David Nowell
Browse files

Update README.md

parent 6187221a
Role Name
=========
This is an Ansible Galaxy role to install UM's Gitlab server.
A brief description of the role goes here.
It has some hardcoded variables that could be removed to make this more generic.
Requirements
------------
The gitlab.rb file is a jinja2 template.
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
I run this as a role within the ec2-build-template repository.
Role Variables
--------------
From the ec2-build-template, you'll want this in your requirements.yml file:
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
- src: git+https://gitlab.aws.vdc.it.umich.edu/its-inf-vdc/umich-rhel7-pet.git
version: master
name: umich-rhel7-pet
Dependencies
------------
- src: git+https://gitlab.aws.vdc.it.umich.edu/its-inf-vdc/sample-application.git
version: master
name: sample-application
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
- src: git+https://gitlab.aws.vdc.it.umich.edu/its-inf-vdc/ec2-create.git
version: master
name: ec2-create
Example Playbook
----------------
- src: git+https://gitlab.aws.vdc.it.umich.edu/its-inf-vdc/gitlab-role.git
version: master
name: gitlab
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
License
-------
BSD
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
And you'll need a secret-vars.yml file in your roles/gitlab/vars directory.
Plus gitlab.umich.edu.[key,crt]
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment