Foreman Open Source Project

Foreman is an open source project that helps system administrators manage servers throughout their lifecycle, from provisioning and configuration to orchestration and monitoring. Using Puppet, Chef, Salt, Ansible and Foreman’s smart proxy architecture, you can easily automate repetitive tasks, quickly deploy applications, and proactively manage change, both on-premise with VMs and bare-metal or in the cloud.

• For more on these wonderful badgers badges, refer to badgerbadgerbadger.

---

Table of Contents (Optional)

• Installation
• Features
• Contributing
• Team
• FAQ
• Support

---

Installation

• Supported platforms

CentOS, Scientific Linux or Oracle Linux 7, x86_64 Debian 9 (Stretch), i386/amd64/armhf/aarch64 Red Hat Enterprise Linux 7, x86_64 Ubuntu 16.04 (Xenial), i386/amd64/armhf/aarch64

• Considering Centos 7 For Installation Of Foreman on localhost machine

• Using a recent version of Puppet is recommended, which is available from the Puppet Labs repository. To use Puppet 5.x with Puppet Agent and Puppet Server:

 $ sudo yum -y install https://yum.puppetlabs.com/puppet5/puppet5-release-el-7.noarch.rpm

• Enable the EPEL (Extra Packages for Enterprise Linux) and the Foreman repos:

$ sudo yum -y install http://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

$ sudo yum -y install https://yum.theforeman.org/releases/1.17/el7/x86_64/foreman-release.rpm

• Downloading the installer

$ sudo yum -y install foreman-installer

• Running the installer

 $  sudo foreman-installer

• After it completes, the installer will print some details about where to find Foreman and the Smart Proxy and Puppet master if they were installed along Foreman. Output should be similar to this:

  • Foreman is running at https://theforeman.example.com Initial credentials are admin / 3ekw5xtyXCoXxS29
  • Foreman Proxy is running at https://theforeman.example.com:8443
  • Puppetmaster is running at port 8140 The full log is at /var/log/foreman-installer/foreman-installer.log

Clone

• Clone this repo to your local machine using https://github.com/VARADSP/Foreman_Code

Setup Foreman On Virtual Machine Using Vagrant

Installing Vagrant First from https://www.vagrantup.com/downloads.html Download and install vagrant from the url Just run vagrant up which will configure VM from Vagrantfile This will setup a virtual machine with foreman installed

$ vagrant up

• For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

---

Features

• Discover, provision and upgrade your entire bare-metal infrastructure
• Create and manage instances across private and public clouds
• Group your hosts and manage them in bulk, regardless of location
• Review historical changes for auditing or troubleshooting
• Extend as needed via a robust plugin architecture
• Automatically build images (on each platform) per system definition to optimize deployment

Usage

Foreman provides comprehensive, interaction facilities including a web frontend, CLI and RESTful API which enables you to build higher level business logic on top of a solid foundation.

Documentation

Refer to this url to know how to use the code ! Documentation is created by using sphinx documentation tool.

https://cdn.rawgit.com/VARADSP/Foreman_Code/8a70c14b/doc/_build/html/index.html

Refer to foreman documentation to know more https://www.theforeman.org/documentation.html

Tests

• Used Centos 7 to install and configure foreman on bare metal
• I utilized this nifty Markdown Cheatsheet for this sample README.

---

Contributing

To get started... Fork the repo start contributing by writing ansible playbooks for populating entities in foreman such adding user,architecture,hosts using hammer cli and ansible plugin

Step 1

• Option 1

  • 🍴 Fork this repo!

• Option 2

  • 👯 Clone this repo to your local machine using https://github.com/VARADSP/Foreman_Code

Step 2

• Install and configure foreman ---- HACK AWAY! 🔨🔨🔨

Step 3

• Use Ansible Roles to populate various entities in the foreman, Run

$ ansible-playbook -i inventory runsetup.yml 

Using inventory file where foreman servers are mentioned,Use the roles in runsetup.yml as per the need.To use particular roles comment or uncomment them in the runsetup.yml.

• 🔃 Create a new pull request using https://github.com/VARADSP/Foreman_Code/compare/.

---

Team

Contributors/People

| Varad Parlikar |https://github.com/VARADSP| (https://github.com/VARADSP)
|

---

FAQ

• How do I do specifically so and so?
  • No problem! Just do this.

---

Support

Reach out to me at one of the following places!

• Blog Website at debuggingbug.wordpress.com
• Twitter at @varadsp
• Facebook at Varad Parlikar

---