Skip to content

Commit c7f5b2e

Browse files
committed
Add REFERENCE.md
1 parent 07f803e commit c7f5b2e

File tree

2 files changed

+71
-1
lines changed

2 files changed

+71
-1
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,5 +65,4 @@ You can now generate documentation and run tests
6565
```
6666
bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop
6767
bundle exec rake spec
68-
6968
```

REFERENCE.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Reference
2+
3+
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
4+
5+
## Table of Contents
6+
7+
### Resource types
8+
9+
* [`oratab`](#oratab): Define database instaces in /etc/oratab with instance name home directory and a flag which indicates if the instance should be started togeth
10+
11+
## Resource types
12+
13+
### <a name="oratab"></a>`oratab`
14+
15+
Define database instaces in /etc/oratab with instance name
16+
home directory and a flag which indicates if the instance should
17+
be started together with the database
18+
19+
#### Properties
20+
21+
The following properties are available in the `oratab` type.
22+
23+
##### `atboot`
24+
25+
Valid values: `yes`, `no`, `Y`, `N`
26+
27+
Aliases: `"Y"=>"yes", "N"=>"no"`
28+
29+
If the instance should start together with the database itself
30+
set this property to `yes` otherwise to `no`
31+
32+
##### `description`
33+
34+
An optional description that will be added as an inline comment
35+
in the target file
36+
37+
##### `ensure`
38+
39+
Valid values: `present`, `absent`
40+
41+
The basic property that the resource should be in.
42+
43+
Default value: `present`
44+
45+
##### `home`
46+
47+
The home directory of the instance. This must be an absolute
48+
path
49+
50+
##### `target`
51+
52+
The path of the target file to store the instance information in
53+
54+
#### Parameters
55+
56+
The following parameters are available in the `oratab` type.
57+
58+
* [`name`](#-oratab--name)
59+
* [`provider`](#-oratab--provider)
60+
61+
##### <a name="-oratab--name"></a>`name`
62+
63+
namevar
64+
65+
The instance's name
66+
67+
##### <a name="-oratab--provider"></a>`provider`
68+
69+
The specific backend to use for this `oratab` resource. You will seldom need to specify this --- Puppet will usually
70+
discover the appropriate provider for your platform.
71+

0 commit comments

Comments
 (0)