Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rely on official documentation for how to perform operations with the… #966

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
218 changes: 0 additions & 218 deletions KATELLO.md

This file was deleted.

104 changes: 7 additions & 97 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,102 +1,18 @@
# Puppet modules for managing Foreman
# Overview

Installs Foreman as a standalone application or using apache passenger.

Installs Foreman Proxy

May install an example puppet master setup using passenger as well, including the tweaks required for foreman.
A [Kafo](https://github.com/theforeman/kafo)-based installer that relies on scenarios to provide configuration and default scenario values.
Available scenarios are:

* foreman
* katello
* foreman-proxy-content

# Installation

## Stable release

Releases of foreman-installer are made via RPM and deb packages and are
published via the normal Foreman repositories.
Releases of foreman-installer are made via RPM and deb packages and are published via the normal Foreman repositories.

See the manual and quickstart guide available at [theforeman.org](http://theforeman.org/).

## Using GIT

git clone --recursive git://github.com/theforeman/foreman-installer.git -b develop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fun fact: GitHub disabled their git:// access a long time ago.


# Requirements

if you are using RHEL, EPEL repo must be enabled <http://fedoraproject.org/wiki/EPEL>

if you are using Debian (or Ubuntu), see the additional notes in README.debian

The Puppet Labs repositories may optionally be enabled for newer versions of Puppet
than are available in base OS repos.

# Setup

Please review the "answers" or setup file: /etc/foreman-installer/scenarios.d/foreman-answers.yaml. This file allows
you to override any of the default parameters (as specified in <module>/manifests/params.pp)

Once you are fine with your answer file, install it with this command:

foreman-installer

or if you prefer interactive mode

foreman-installer -i


The answer file is a yaml format. For a module just using the defaults, simply put
"modulename: true" to include, or false to exclude. For a module which you wish to
override any defaults, it becomes a hash, with each overridden parameter as a key-value
pair.

A few sample files now follow:

All-in-one installation:

---
foreman: true
puppet:
server: true
foreman_proxy: true

Just Foreman on its own:

---
foreman: true
puppet: false
foreman_proxy: false

Foreman and Foreman-Proxy:

---
foreman: true
puppet: false
foreman_proxy: true

Puppetmaster with Git and Proxy:

---
foreman: false
puppet:
server: true
server_git_repo: true
foreman_proxy: true

Foreman & proxy with a different username:

---
foreman:
user: 'myforeman'
puppet: false
foreman_proxy:
user: 'myproxy'

Extras
------

If you just want to include the relavant bits to run on your puppet master you may

include foreman::params, foreman::config::enc, foreman::config::reports

# Contributing

* Fork the project
Expand All @@ -105,12 +21,6 @@ If you just want to include the relavant bits to run on your puppet master you m

See [CONTRIBUTING.md](/CONTRIBUTING.md) for more details.

# Katello

This repository also contains the tooling required to install Foreman Katello.

See [KATELLO.md](/KATELLO.md) for details and specifics of that setup.

# More info

See http://theforeman.org or at #theforeman irc channel on freenode
Expand Down