You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.rst
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,14 +49,18 @@ Available states
49
49
^^^^^^^^^^^^^
50
50
Installs and configures the syslog_ng package.
51
51
52
-
``syslog_ng.packages``
52
+
``syslog_ng.package``
53
53
^^^^^^^^^^^^^^^^^^^^^^
54
54
Installs the syslog_ng package and optional packages which may provide additional functionalities.
55
55
56
56
``syslog_ng.config``
57
57
^^^^^^^^^^^^^^^^^^^^
58
58
This state manages the file ``syslog_ng.conf`` under ``/etc/syslog-ng`` (template found in "syslog_ng/files"). The configuration is populated by values in "syslog_ng/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.
59
59
60
+
``syslog_ng.service``
61
+
^^^^^^^^^^^^^^^^^^^^
62
+
Manages the startup and running state of the syslog_ng service.
63
+
60
64
Testing
61
65
-------
62
66
@@ -72,32 +76,32 @@ Requirements
72
76
73
77
$ gem install bundler
74
78
$ bundle install
75
-
$ bundle execkitchen test [platform]
79
+
$ bin/kitchen test [platform]
76
80
77
81
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
78
82
e.g. ``debian-9-2019-2-py3``.
79
83
80
-
``kitchen converge``
81
-
^^^^^^^^^^^^^^^^^^^^
84
+
``bin/kitchen converge``
85
+
^^^^^^^^^^^^^^^^^^^^^^^^
82
86
83
-
Creates the docker instance and runs the ``template`` main state, ready for testing.
87
+
Creates the docker instance and runs the ``syslog_ng`` main state, ready for testing.
84
88
85
-
``kitchen verify``
86
-
^^^^^^^^^^^^^^^^^^
89
+
``bin/kitchen verify``
90
+
^^^^^^^^^^^^^^^^^^^^^^
87
91
88
92
Runs the ``inspec`` tests on the actual instance.
89
93
90
-
``kitchen destroy``
91
-
^^^^^^^^^^^^^^^^^^^
94
+
``bin/kitchen destroy``
95
+
^^^^^^^^^^^^^^^^^^^^^^^
92
96
93
97
Removes the docker instance.
94
98
95
-
``kitchen test``
96
-
^^^^^^^^^^^^^^^^
99
+
``bin/kitchen test``
100
+
^^^^^^^^^^^^^^^^^^^^
97
101
98
102
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
99
103
100
-
``kitchen login``
101
-
^^^^^^^^^^^^^^^^^
104
+
``bin/kitchen login``
105
+
^^^^^^^^^^^^^^^^^^^^^
102
106
103
107
Gives you SSH access to the instance for manual testing.
0 commit comments