Skip to content

Commit

Permalink
adding ansible role for user-management
Browse files Browse the repository at this point in the history
  • Loading branch information
qburst-arjunm committed Feb 16, 2024
1 parent fc5841f commit a8189ca
Show file tree
Hide file tree
Showing 12 changed files with 287 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ To facilitate easy navigation and access to the resources within this repository

1. [**Scripts**](/scripts/README.md): Within this folder, you will find a collection of various scripts that have been developed to automate tasks and streamline processes. These scripts have proven to be valuable tools, enhancing productivity in various workflows.
2. [**GitHub Actions**](/github-actions/README.md): This folder contains a selection of GitHub Actions that have been designed to optimize workflows. These actions offer a reusable and configurable approach for achieving efficiency and consistency in your development practices.
3. [**Terraform**](/terraform/README.md): In this folder, you will discover a comprehensive set of Terraform modules created to address common use cases. These modules helps you to rapidly provision and manage infrastructure resources with ease, leveraging the power and flexibility of Terraform.
3. [**Terraform**](/terraform/README.md): In this folder, you will discover a comprehensive set of Terraform modules created to address common use cases. These modules helps you to rapidly provision and manage infrastructure resources with ease, leveraging the power and flexibility of Terraform.
4. [**Ansible**](/ansible/README.md): In this folder, you will discover a comprehensive set of ansible roles to create/manage users. This role helps you to easily manage users in different platforms like AWS, Linux, Jenkins, MySQL and Postgres.
79 changes: 79 additions & 0 deletions ansible/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Ansible Role for User Management
=========

Ansible playbook to create user accounts in AWS, Jenkins, Linux, MySQL and PostgreSQL.

# Requirements
------------

The role can be executed on any machine having Linux OS with the below packages.
- Ansible
- Python
- pymysql
- mysql-client
- postgresql-client
- awscli

# Role Variables
--------------

Available variables are listed below (user-management/vars/main.yml):

users
- aws
- linux
- jenkins
- mysql
- postgres

# Role tasks
-------------

Available tasks are listed below (user-management/tasks/)

tasks
- aws-add-user.yml
- jenkins-add-user.yml
- linux-add-user.yml
- mysql-add-user.yml
- postgres-add-user.yml

# Dependencies
------------

1. Configure AWS access key and secret key for running aws user creation.
2. Modify Jenkins authorization security by enabling necessary permission for the admin user.
3. Grant access to the IP from where you are running this playbook in the MySQL server.
4. Allow necessary access in all the servers.


# Example Playbook
----------------

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

---
- name: Ansible roles to create/manage users
hosts: servers
gather_facts: true
become: yes
roles:
- role: user-management

The same is provided in the main.yml residing outside the role. You can use the following command to run all the tasks.

### ansible-playbook main.yml

You can use --skip-tags to exclude any particular role

### Ex: ansible-playbook main.yml --skip-tags linux

# License
-------

BSD

# Author Information
------------------

QBurst DevOps Team
7 changes: 7 additions & 0 deletions ansible/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
- name: Ansible roles to create/manage users
hosts: localhost
gather_facts: true
become: yes
roles:
- role: user-management
1 change: 1 addition & 0 deletions ansible/user-management/defaults/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
### NA
38 changes: 38 additions & 0 deletions ansible/user-management/tasks/aws-add-user.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
- name: Ensuring AWS IAM User does not exist
amazon.aws.iam_user_info:
name: "{{ users.aws.username }}"
register: user_info_result

- name: Creating AWS IAM User
amazon.aws.iam_user:
name: "{{ users.aws.username }}"
state: present
password: "{{ users.aws.password }}"
password_reset_required: false
when: user_info_result.iam_users | length == 0

- name: Attaching AWS IAM Policy to IAM User
amazon.aws.iam_user:
name: "{{ users.aws.username }}"
managed_policies: "{{ users.aws.policy }}"
state: present

- name: Check if access key exists for the IAM user
community.aws.iam_access_key_info:
user_name: "{{ users.aws.username }}"
register: iam_access_key_info_result

- name: Creating AWS Access key for IAM user
community.aws.iam_access_key:
user_name: "{{ users.aws.username }}"
state: present
register: iam_access_key_result
when: iam_access_key_info_result.access_keys | length == 0

- name: Storing Credentials in home folder
copy:
content: "{{ iam_access_key_result.access_key.access_key_id }}:{{ iam_access_key_result.secret_access_key }}"
dest: "./aws_credentials.txt"
mode: "0600"
when: iam_access_key_info_result.access_keys | length == 0
27 changes: 27 additions & 0 deletions ansible/user-management/tasks/jenkins-add-user.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
- name: Adding new user to Jenkins
jenkins_script:
url: "{{ users.jenkins.jenkins_host }}"
user: "{{ users.jenkins.admin_username }}"
password: "{{ users.jenkins.admin_password }}"
script: |
import jenkins.model.*
import hudson.security.*
def instance = Jenkins.getInstance()
def existingUser = instance.securityRealm.allUsers.find {it.id == "{{ users.jenkins.new_username }}"}
println "Value of existingUser: $existingUser"
if (existingUser == null) {
def hudsonRealm = new HudsonPrivateSecurityRealm(false)
hudsonRealm.createAccount("{{ users.jenkins.new_username }}","{{ users.jenkins.new_password }}")
instance.setSecurityRealm(hudsonRealm)
instance.save()
}
else {
println("user already exists")
}
register: result

- name: Printing result
debug:
var: result
21 changes: 21 additions & 0 deletions ansible/user-management/tasks/linux-add-user.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
- name: Checking if the user already exists in Linux
command: getent passwd {{ users.linux.username }}
register: user_check
ignore_errors: true
when: "ansible_os_family == 'RedHat' or ansible_os_family == 'Debian'"

- debug:
var: user_check

- name: Creating new user in Linux
user:
name: "{{ users.linux.username }}"
state: present
groups: "{{ users.linux.groups }}"
password: "{{ users.linux.password }}"
shell: "{{ shell | default('/bin/bash') }}"
comment: "{{ comment | default('') }}"
update_password: always
when: "ansible_os_family == 'RedHat' or ansible_os_family == 'Debian' and user_check.rc != 0"

15 changes: 15 additions & 0 deletions ansible/user-management/tasks/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
- include: linux-add-user.yml
tags: linux

- include: jenkins-add-user.yml
tags: jenkins

- include: aws-add-user.yml
tags: aws

- include: mysql-add-user.yml
tags: mysql

- include: postgres-add-user.yml
tags: postgres
42 changes: 42 additions & 0 deletions ansible/user-management/tasks/mysql-add-user.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
- name: Installing MySQL Python library
pip:
name:
- mysql-client
- pymysql
executable: pip3
when: ansible_distribution == 'Ubuntu' or ansible_distribution == 'CentOS'
ignore_errors: yes

- name: Checking if MySQL user already exists
mysql_query:
login_host: "{{ users.mysql.mysql_host }}" # Replace with the correct host name
login_user: root # Assuming default MySQL superuser
login_password: "{{ users.mysql.mysql_root_password }}" # Specify the password for the MySQL superuser
login_db: mysql # Replace with the correct database name
query: "SELECT User FROM mysql.user WHERE User='{{ users.mysql.mysql_new_user }}';"
register: mysql_user_check

- debug:
var: mysql_user_check

- name: Checking if user exists
debug:
msg: "User already exists"
when: mysql_user_check.rowcount[0] > 0

- name: Creating MySQL User
mysql_user:
name: "{{ users.mysql.mysql_new_user }}" # specify the new user
password: "{{ users.mysql.mysql_new_password }}" # specify the new user password
priv: "*.*:ALL" # Example privilege; adjust as needed
state: present
login_user: root # Assuming default MySQL superuser
login_password: "{{ users.mysql.mysql_root_password }}" # Specify the password for the MySQL superuser
login_host: "{{ users.mysql.mysql_host }}" # Replace with the correct host name
when: mysql_user_check.rowcount[0] == 0
register: user_creation_result

- name: Printing Creation Result
debug:
var: user_creation_result
25 changes: 25 additions & 0 deletions ansible/user-management/tasks/postgres-add-user.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
- name: Querying PostgreSQL for user existence
community.general.postgresql_query:
db: "{{ users.postgres.postgres_db }}" # Replace with the correct database name
login_host: "{{ users.postgres.postgres_host }}" # Replace with the correct host name
login_user: "{{ users.postgres.postgres_root_user }}" # Assuming default PostgreSQL superuser
login_password: "{{ users.postgres.postgres_root_password }}" # Specify the password for the PostgreSQL superuser
query: "SELECT 1 FROM pg_roles WHERE rolname='{{ users.postgres.postgres_new_user }}'"
register: user_exists
ignore_errors: true

- name: Checking if the user already exist
debug:
msg: "User already exists"
when: user_exists.rowcount > 0

- name: Creating PostgreSQL user
community.postgresql.postgresql_user:
db: "{{ users.postgres.postgres_db }}" # Replace with the correct database name
login_host: "{{ users.postgres.postgres_host }}" # Replace with the correct host name
login_user: "{{ users.postgres.postgres_root_user }}" # Assuming default PostgreSQL superuser
login_password: "{{ users.postgres.postgres_root_password }}" # Specify the password for the PostgreSQL superuser
name: "{{ users.postgres.postgres_new_user }}" # specify the new user
password: "{{ users.postgres.postgres_new_password }}" # specify the new user password
priv: "ALL" # Example privilege; adjust as needed
when: user_exists.rowcount == 0
2 changes: 2 additions & 0 deletions ansible/user-management/tests/inventory
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
localhost

28 changes: 28 additions & 0 deletions ansible/user-management/vars/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
users:
linux:
username: linux
password: linux@12#
groups: sudo
jenkins:
new_username: jenkins
new_password: jenkins@12#
jenkins_host: http://localhost:8080
admin_username: admin
admin_password: admin@12#
aws:
username: aws_user
password: aws_user@12#
policy: AmazonS3FullAccess
mysql:
mysql_root_password: root@12#
mysql_new_user: mysql
mysql_new_password: mysql@12#
mysql_host: localhost
postgres:
postgres_root_password: root@12#
postgres_root_user: root
postgres_new_user: postgres_user
postgres_new_password: postgres_user@12#
postgres_host: localhost
postgres_db: root

0 comments on commit a8189ca

Please sign in to comment.