Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mtulio committed Jan 18, 2016
1 parent bdfa54d commit cc79886
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 19 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Ignore build packages
pkg/

# Eclipse metadata
.project*
77 changes: 61 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,100 @@

#### Table of Contents

1. [Overview](#overview)
2. [Profiles](#profiles)
1. [Overview](#1-overview)
2. [Profiles](#2-profiles)
* [Linux](#linux)
* [NMS - Network Management Systems](#nms)
3. [Limitations](#limitations)
4. [Development](#development)
* [NMS - Network Management Systems](#2-2-nms)
3. [Limitations](#3-limitations)
4. [Development](#4-development)
5. [Release Notes](#5-release-notes)

## Overview
## 1. Overview

Module to manage the puppet 'abstraction layer'. Here you can define profiles for your roles.
Module to manage the puppet 'abstraction layer'. Here you can define profiles for your roles. This class will work better with 'roles' class [business layer]. You can add one or more profile for each 'role'.

## Profiles
## 2. Profiles

* Linux
* NMS/Zabbix
* Webserver/Nginx [soon]
* Webserver/APACHE [soon]


### Linux
### 2.1 Linux

#### Description

Profile Linux configure Linux system using module 'mtulio-linux'

#### Dependencies

Module ['Linux'](https://forge.puppetlabs.com/mtulio/linux)

#### Files
#### Usage

### NMS
See [module description](https://forge.puppetlabs.com/mtulio/linux)

#### Usage

#### Zabbix Agent
* Basic security level
```
include ::profiles
class {'::profiles::linux':
security_level => 'basic',
}
```

* Define your own repository of configuration [module]
```
class {'::profiles' :
gb_repo_base => '0_REPOSITORY',
gb_pool => 'dmz',
}
class {'::profiles::linux' :
security_level => 'basic',
}
```

### 2.2 NMS

#### 2.2.1 Zabbix Agent

##### Description

Profile to configure zabbix Agent on a Linux server

##### Dependencies

Module ['Zabbix'](https://forge.puppetlabs.com/mtulio/zabbix)

##### Files

See [module description](https://forge.puppetlabs.com/mtulio/zabbix)

##### Usage

* Configure Zabbix Agent with the basic parameters defined on class '::profiles::nms::zabbix_agent'. (check out the class to customize the parameters of your organization)

```
include profiles
class { 'profiles::nms::zabbix_agent' : }
```

## Limitations
## 3. Limitations

OS compatibility:
* Red Hat family 7+

We're working to support more OS.

## Development
## 4. Development

See project page at https://github.com/mtulio/puppet-mod-profiles

## Release Notes
## 5. Release Notes

[1.0.0]
* Profile Linux
* Add Profile Linux [base and sshd configuration]
* Add Profile Zabbix

32 changes: 29 additions & 3 deletions metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,34 @@
"source": "https://github.com/mtulio/puppet-mod-profiles",
"project_page": "https://github.com/mtulio/puppet-mod-profiles",
"issues_url": "https://github.com/mtulio/puppet-mod-profiles/issues",
"tags": ["linux","profiles","abstraction","layer","ssh","zabbix"],
"requirements": [
{
"name": "puppet",
"version_requirement": ">= 3.0.0 < 5.0.0"
}
],
"operatingsystem_support": [
{
"operatingsystem": "RedHat",
"operatingsystemrelease": [
"6",
"7"
]
},
{
"operatingsystem": "CentOS",
"operatingsystemrelease": [
"6",
"7"
]
}
],
"description": "Module to manage the puppet 'implementation layer'.",
"dependencies": [
{"name":"puppetlabs-stdlib","version_requirement":">= 1.0.0"}
{"name":"puppetlabs-stdlib","version_requirement":">= 1.0.0"},
{"name":"mtulio-linux","version_requirement":">= 1.0.0"},
{"name":"mtulio-ssh","version_requirement":">= 1.0.0"},
{"name":"mtulio-zabbix","version_requirement":">= 1.0.0"}
]
}

}

0 comments on commit cc79886

Please sign in to comment.