platform_utils Cookbook
=======================

This cookbook provides platform utility recipes.

## Contents

- [Requirements](#requirements)
  - [Platforms](#platforms)
  - [Packages](#packages)
  - [Cookbooks](#cookbooks)
- [Attributes](#attributes)
- [Usage](#usage)
  - [Recipes](#recipes)
    - [platform_utils::default](#platform_utilsdefault)
    - [platform_utils::platform_update](#platform_utilsplatform_update)
    - [platform_utils::subid](#platform_utilssubid)
    - [platform_utils::sudo](#platform_utilssudo)
- [License and Authors](#license-and-authors)

## Requirements

### Platforms
- CentOS, Red Hat Enterprise Linux
- Debian, Ubuntu

### Packages
- none.

### Cookbooks
- none.

## Attributes

|Key|Type|Description, example|Default|
|:--|:--|:--|:--|
|`['platform_utils']['platform_update']['auto_update']`|Boolean|whether update automatically or not.|`true`|
|`['platform_utils']['platform_update']['timer']`|Symbol|update execution timing.|`:delayed`|
|`['platform_utils']['platform_update']['apt-get']['command']`|String|apt-get upgrade/dist-upgrade command string.|`'apt-get upgrade -y'`|
|`['platform_utils']['platform_update']['yum']['command']`|String|yum update command string.|`'yum update -y'`|
|`['platform_utils']['platform_update']['subid']['users']`|Array|Subordinate user (=group) names.|`[]`|
|`['platform_utils']['platform_update']['sudo']['sudoers.d']`|Hash|sudoers file configurations.|`{}` See `attributes/default.rb`|
|`['platform_utils']['platform_update']['sudo']['group']['members']`|Array|Members appended to the `sudo` group.|`[]`|

## Usage

### Recipes

#### platform_utils::default

This recipe does nothing.

#### platform_utils::platform_update

This recipe updates the platform.

#### platform_utils::subid

This recipe sets up the `/etc/subuid` and the `/etc/subgid`.

#### platform_utils::sudo

This recipe sets up sudo.

## License and Authors

- Author:: whitestar at osdn.jp

```text
Copyright 2016-2017, whitestar

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
