Skip to content

Commit

Permalink
Fixed remaining markdowner.py warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
  • Loading branch information
olehermanse committed Jan 15, 2024
1 parent 1468ca6 commit 395714d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 39 deletions.
39 changes: 12 additions & 27 deletions reference/promise-types/services.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,9 @@ body service_method winmethod

**Notes:**

Services promises for Windows are only available in CFEngine Enterprise. Note
that the name of a service in Windows may be different from its ```Display
name```. CFEngine Enterprise policies use the name, not the display name,
due to the need for uniqueness.
Services promises for Windows are only available in CFEngine Enterprise.
Note that the name of a service in Windows may be different from its **Display name**.
CFEngine Enterprise policies use the name, not the display name, due to the need for uniqueness.

![WinService](promise-types-services-winservice-properties_name.png)

Expand Down Expand Up @@ -155,29 +154,15 @@ standard library.

**Allowed input range:** (arbitrary string)|(menu_option) depending on `service_type`

* When `service_type` is `windows` allowed values are limited to `start`,
`stop`, `enable`, or `disable`.

* **start|enable** :: Will start the service if it is not running. ```Startup
Type``` will be set to ```Manual``` if it is not ```Automatic``` or
```Automatic (Delayed Start)```. For a service to be configured to start
automatically on boot a `service_method` must be declared and
`service_autostart_policy` must be set to ```boot_time```.

* **stop** :: Will stop the service if it is running. ```Startup Type``` will
not be modified unless a `service_method` is declared and
`service_autostart_policy` is set.

* **disable** :: Will stop the service if it is running, and ```Startup Type```
will be set to ```Disabled```.


* When `service_type` is ```generic``` any string is allowed and
`service_bundle` is responsible for interpreting and implementing the desired
state based on the `service_policy` value.

Historically `service_type` ```generic``` has supported ```start```,
```stop```, ```enable```, ```disable```, ```restart``` and ```reload```.
* When `service_type` is `windows` allowed values are limited to `start`, `stop`, `enable`, or `disable`.
* **start|enable** :: Will start the service if it is not running.
**Startup Type** will be set to **Manual** if it is not **Automatic** or **Automatic (Delayed Start)**.
For a service to be configured to start automatically on boot a `service_method` must be declared and `service_autostart_policy` must be set to `boot_time`.
* **stop** :: Will stop the service if it is running. **Startup Type** will not be modified unless a `service_method` is declared and `service_autostart_policy` is set.
* **disable** :: Will stop the service if it is running, and **Startup Type**
will be set to **Disabled**.
* When `service_type` is `generic` any string is allowed and `service_bundle` is responsible for interpreting and implementing the desired state based on the `service_policy` value.
Historically `service_type` `generic` has supported `start`, `stop`, `enable`, `disable`, `restart` and `reload`.


**Example:**
Expand Down
23 changes: 12 additions & 11 deletions resources/faq/what-did-cfengine-change.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,20 @@ bundle edit_line lines_present(lines)
# @brief Ensure `lines` are present in the file. Lines that do not exist are appended to the file
# @param List or string that should be present in the file
#
# **Example:**
# Example:
#
# ```cf3
# bundle agent example
# {
# vars:
# "nameservers" slist => { "8.8.8.8", "8.8.4.4" };
# bundle agent example
# {
# vars:
# "nameservers"
# slist => { "8.8.8.8", "8.8.4.4" };
#
# files:
# "/etc/resolv.conf" edit_line => lines_present( @(nameservers) );
# "/etc/ssh/sshd_config" edit_line => lines_present( "PermitRootLogin no" );
# }
# ```
# files:
# "/etc/resolv.conf"
# edit_line => lines_present( @(nameservers) );
# "/etc/ssh/sshd_config"
# edit_line => lines_present( "PermitRootLogin no" );
# }
{
insert_lines:
Expand Down
2 changes: 1 addition & 1 deletion web-ui/federated-reporting.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -703,7 +703,7 @@ we use the number "1".
Determine the cfdb-specific `hub_id`.

```command
/var/cfengine/bin/psql cfdb -c "select * from __hubs"
/var/cfengine/bin/psql cfdb -c "select * from __hubs"
```

Typical output would be like the following.
Expand Down

0 comments on commit 395714d

Please sign in to comment.