gogrlx/docs.grlx.dev
1
0
Fork 0
mirror of https://github.com/gogrlx/docs.grlx.dev.git synced 2026-04-02 03:08:53 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs(service): added initial docs for service

Browse Source
This commit is contained in:
Ethan Holz
2023-10-25 16:46:59 -05:00
parent 3c188144cf
commit 90cccf20dc
1 changed files with 97 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
src/content/docs/ingredients/service.md Normal file
View File

@@ -0,0 +1,97 @@
---
title: grlx.ingredients.service
description: service
---
The `service` ingredient handles the management of system services. Currently, this only supports `systemd` services.
## **service.masked**
Checks if a service is masked and masks it if it is not
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | yes | the name of the `systemd` unit
| _userMode_ | bool | no | to use `systemd` in user mode, defaults to false
```yaml
service.masked:
- name: ssd-backup
- userMode: true
```
## **service.unmasked**
Checks if a service is unmasked and unmasks it if it is not
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | yes | the name of the `systemd` unit
| _userMode_ | bool | no | to use `systemd` in user mode, defaults to false
```yaml
service.unmasked:
- name: ssd-backup
- userMode: true
```
## **service.running**
Checks if a service is running and starts it if it is not
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | yes | the name of the `systemd` unit
| _userMode_ | bool | no | to use `systemd` in user mode, defaults to false
```yaml
service.running:
- name: docker.service
- userMode: false
```
## **service.stopped**
Checks if a service is stopped and stops it if it is not
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | yes | the name of the `systemd` unit
| _userMode_ | bool | no | to use `systemd` in user mode, defaults to false
```yaml
service.stopped:
- name: docker.service
- userMode: false
```
## **service.enabled**
Checks if a service is enabled and enables it if it is not
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | yes | the name of the `systemd` unit
| _userMode_ | bool | no | to use `systemd` in user mode, defaults to false
```yaml
service.enabled:
- name: cronie.service
- userMode: false
```
## **service.disabled**
Checks if a service is disabled and disables it if it is not
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | yes | the name of the `systemd` unit
| _userMode_ | bool | no | to use `systemd` in user mode, defaults to false
```yaml
service.disabled:
- name: cronie.service
- userMode: false
```
## **service.restarted**
Restarts a service
#### Parameters
| parameter | type | required | description |
|-----------|------|----------|-------------|
| _name_ | string | yes | the name of the `systemd` unit
| _userMode_ | bool | no | to use `systemd` in user mode, defaults to false
```yaml
service.restarted:
- name: cronie.service
- userMode: false
```