Showing with 21 additions and 74 deletions.
  1. +5 −10 CHANGELOG.md
  2. +15 −63 README.md
  3. +1 −1 metadata.json
15 changes: 5 additions & 10 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Changelog
## Release 0.1.1
This is the initial release of the service task.

All notable changes to this project will be documented in this file.

## Release 0.1.0

**Features**

**Bugfixes**

**Known Issues**
**Features
- Provides the following actions start, stop, restart, enable, disable, status.
- Provider can optionally be specified.
78 changes: 15 additions & 63 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,89 +1,41 @@

# service_task
# service

#### Table of Contents

1. [Description](#description)
2. [Setup - The basics of getting started with service task](#setup)
* [Setup requirements](#setup-requirements)
2. [Requirements](#requirements)
3. [Usage - Configuration options and additional functionality](#usage)
4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
5. [Getting help - Some Helpful commands](#getting-help)

## Description

This module provides the service task. This allows you to execute various actions against a service. For example stopping httpd. It requires Puppet 5 or bolt installed
This module provides the service task. This task allows you to manage and inspect the state of services, including starting, stopping, enabling, and disabling services.

## Setup
## Requirements

### Setup Requirements

This module requires either Puppet enterprise or Bolt to function.
This module requires Puppet Enterprise 2017.3 or later to be installed on the machine from which you are running task commands (the controller node). Machines receiving task requests must be Puppet agents.

## Usage

There are a number of ways to execute the service task. The examples below check the status of the httpd service.

VIA PE-console see link_here
To run a service task, use the task command, specifying the action and the name of the service.

Via BOLT more information here LINK
```bolt
bolt task service status httpd
```
1. On the command line, run `puppet task service <ACTION> <SERVICE_NAME>`.

Via the PE CLI, more information here LINK
For example, to check the status of the Apache httpd service, run `puppet task service status httpd`

```pe
puppet task service status httpd
```
You can also run tasks in the PE console. See PE task documentation for complete information.

## Reference

To get the availible actions and parameters run

```pe
puppet task show service
```

```bolt
puppet task show service
```

or go to https://forge.puppet.com/puppetlabs/service/tasks

For a complete list of optional service providers that are supported please go here https://docs.puppet.com/puppet/latest/types/service.html

## Development

Here is a quick how to get up and running
```
git clone git@github.com:puppetlabs/service.git
```
```
bundle install --path .bundle/gems/
```
```
BEAKER_destroy=no PUPPET_INSTALL_TYPE=pe BEAKER_PE_DIR=http://enterprise.delivery.puppetlabs.net/2017.3/ci-ready BEAKER_PE_VER=2017.3.0-rc8-41-g4981bd3 BEAKER_set=centos7-pooler bundle exec rspec spec/acceptance
```
To view the available actions and parameters, on the command line, run `puppet task show service` or see the service module page on the [Forge](https://forge.puppet.com/puppetlabs/service/tasks).

This will spit out a vmpooler machine name you can ssh to
For a complete list of services that are supported see the Puppet [services](https://docs.puppet.com/puppet/latest/types/service.html) documentation.

```
ssh -i ~/.ssh/id_rsa-acceptance root@<VMPOOLER HOSTNAME FROM ABOVE>
```
## Getting Help

show the status of the openssl service (use the actual name of your node)
```
puppet task run service --nodes cgx1boldbmbi3vn.delivery.puppetlabs.net action=status service=httpd
```
To display help for the service task, run `puppet task show service`

display help for service
```
puppet task show service
```
To show help for the task CLI, run `puppet task run --help`

show help for the task cli
```
puppet task run --help
```
2 changes: 1 addition & 1 deletion metadata.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "puppetlabs-service",
"version": "0.1.0",
"version": "0.1.1",
"author": "puppet",
"summary": "Tasks that manipulate a service",
"license": "Apache-2.0",
Expand Down