├── .gitignore ├── .travis.yml ├── CHANGES.rst ├── COPYRIGHT ├── LICENSE ├── README.md ├── defaults └── main.yml ├── docs ├── changelog.rst ├── copyright.rst ├── getting-started.rst ├── includes │ └── all.rst ├── index.rst ├── introduction.rst └── playbooks │ └── console.yml ├── handlers └── main.yml ├── meta ├── ansigenome.yml └── main.yml ├── tasks ├── filesystem_mount.yml ├── main.yml ├── proc_hidepid.yml └── sysnews.yml └── templates ├── etc ├── ansible │ └── facts.d │ │ └── proc.fact.j2 ├── issue.j2 ├── motd.j2 ├── profile.d │ └── sysnews.sh.j2 └── systemd │ └── system │ └── systemd-logind.service.d │ └── hidepid.conf.j2 └── var └── lib └── sysnews ├── news.j2 └── noexpire.j2 /.gitignore: -------------------------------------------------------------------------------- 1 | ## For quick testing. 2 | ## Generated by https://github.com/ypid/ypid-ansible-common/blob/master/bin/sphinx-debops-role-build 3 | docs/Makefile 4 | docs/_build/ 5 | docs/conf.py 6 | docs/defaults.rst 7 | docs/includes/global.rst 8 | docs/_templates/page.html 9 | docs/_templates/.gitkeep 10 | docs/_static/custom.css 11 | docs/_static/.gitkeep 12 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | sudo: True 4 | language: 'python' 5 | python: '2.7' 6 | 7 | virtualenv: 8 | system_site_packages: true 9 | 10 | before_install: True 11 | install: True 12 | 13 | script: 14 | - 'git clone --depth 1 https://github.com/nickjj/rolespec' 15 | - 'cd rolespec ; bin/rolespec -r https://github.com/debops/test-suite' 16 | 17 | notifications: 18 | webhooks: 19 | - 'https://galaxy.ansible.com/api/v1/notifications/' 20 | -------------------------------------------------------------------------------- /CHANGES.rst: -------------------------------------------------------------------------------- 1 | Changelog 2 | ========= 3 | 4 | .. include:: includes/all.rst 5 | 6 | **debops.console** 7 | 8 | This project adheres to `Semantic Versioning `__ 9 | and `human-readable changelog `__. 10 | 11 | The current role maintainer_ is drybjed_. 12 | 13 | 14 | `debops.console master`_ - unreleased 15 | ------------------------------------- 16 | 17 | .. _debops.console master: https://github.com/debops/ansible-console/compare/v0.1.3...master 18 | 19 | Added 20 | ~~~~~ 21 | 22 | - Support to remove host entries using ``console_hosts`` without specifying a 23 | ``value``. [ypid_] 24 | 25 | 26 | Changed 27 | ~~~~~~~ 28 | 29 | - Configure the ``FSCKFIX`` parameter only on OS distribution releases that 30 | support it. [drybjed_] 31 | 32 | Removed 33 | ~~~~~~~ 34 | 35 | - Remove support for ``root`` system account management. This functionality has 36 | been moved to a separate debops.root_account_ Ansible role. [drybjed_] 37 | 38 | Fixed 39 | ~~~~~ 40 | 41 | - Fix Ansible 2.2 deprecation warnings which requires Ansible 2.2 or higher. 42 | Support for older Ansible versions is dropped. [brzhk] 43 | 44 | 45 | `debops.console v0.1.3`_ - 2016-11-07 46 | ------------------------------------- 47 | 48 | .. _debops.console v0.1.3: https://github.com/debops/ansible-console/compare/v0.1.2...v0.1.3 49 | 50 | Changed 51 | ~~~~~~~ 52 | 53 | - Moved sysctl parts from ``debops.console`` to a separate debops.sysctl_ 54 | role. [ypid_] 55 | 56 | - Update documentation and Changelog. [drybjed_] 57 | 58 | Fixed 59 | ~~~~~ 60 | 61 | - Fix the issue of the :command:`sysnews` task failing on Ansible v2.2 with 62 | empty news variable. [drybjed_] 63 | 64 | 65 | `debops.console v0.1.2`_ - 2016-05-26 66 | ------------------------------------- 67 | 68 | .. _debops.console v0.1.2: https://github.com/debops/ansible-console/compare/v0.1.1...v0.1.2 69 | 70 | Changed 71 | ~~~~~~~ 72 | 73 | - Change how the preferred text editor is selected. Instead of specifying 74 | a preferred editor, role contains a list of preferred editors and checks it 75 | against a list of installed editors. The first found editor is selected as 76 | the preferred one. [drybjed_] 77 | 78 | Removed 79 | ~~~~~~~ 80 | 81 | - Remove list of additional APT packages to install. This functionality has 82 | been moved to the debops.apt_install_ Ansible role. [drybjed_] 83 | 84 | 85 | `debops.console v0.1.1`_ - 2016-02-18 86 | ------------------------------------- 87 | 88 | .. _debops.console v0.1.1: https://github.com/debops/ansible-console/compare/v0.1.0...v0.1.1 89 | 90 | Changed 91 | ~~~~~~~ 92 | 93 | - Be more strict in parsing :file:`/proc/mounts` when looking for a :file:`/proc` entry 94 | with enabled ``hidepid=`` parameter. [drybjed_] 95 | 96 | Fixed 97 | ~~~~~ 98 | 99 | - Fix a bug with wrong ``ansible_local.proc.hidepid_group`` value when hidepid 100 | was not enabled in :file:`/proc`. [prahal] 101 | 102 | 103 | debops.console v0.1.0 - 2016-02-07 104 | ---------------------------------- 105 | 106 | Added 107 | ~~~~~ 108 | 109 | - Add Changelog. [drybjed_] 110 | 111 | - Add a way to manage entries in :file:`/etc/hosts`. [drybjed_] 112 | 113 | - Add a task that allows to copy custom files from Ansible Controller, list of 114 | files is configurable using Ansible inventory. [drybjed_] 115 | 116 | - Add support for setting default system-wide locale. [drybjed_] 117 | 118 | - Add option to configure system-wide ``editor`` alternative. [drybjed_] 119 | 120 | - Add kernel parameter configuration and shared memory configuration. 121 | 122 | Amount of shared memory limits starting with Linux kernel 3.16 is ridiculusly 123 | high by default. This configuration limits the shared memory size to 124 | reasonable amounts depending on available system RAM. More information: 125 | https://git.kernel.org/cgit/linux/kernel/git/mhocko/mm.git/commit/include/uapi/linux/shm.h?id=060028bac94bf60a65415d1d55a359c3a17d5c31 126 | [drybjed_] 127 | 128 | - Install additional packages by default: ``mtr-tiny``, ``tree``, ``at``. 129 | Install ``nfs-common`` if NFS mounts are configured. [drybjed_] 130 | 131 | - Create list of conditionally installed packages. [drybjed_] 132 | 133 | - Install ``libpam-systemd`` on hosts managed by ``systemd`` init. This 134 | provides better support for user sessions which will be moved to their own 135 | separate cgroups. Users are also able to create their own ``systemd`` 136 | services, timers, and other units. [drybjed_] 137 | 138 | - Add support for ``sysnews`` package, useful on multiuser systems. [drybjed_] 139 | 140 | - Add ``proc.fact`` fact script which contains information about ``hidepid`` 141 | options for other Ansible roles to use. [drybjed_] 142 | 143 | Changed 144 | ~~~~~~~ 145 | 146 | - Change default NFS filesystem type from ``nfs4`` to ``nfs``, system 147 | automatically picks the correct type. [drybjed_] 148 | 149 | - Tag various tasks for convenient use. [drybjed_] 150 | 151 | - Ensure mount directories exist when manually mounted. [ypid_] 152 | 153 | - Protect the Tab characters in ``lineinfile`` module. [drybjed_] 154 | 155 | - Fix deprecation warnings on Ansible 2.1.0. [drybjed_] 156 | 157 | - Make sure that ``systemd-logind`` service is included in the ``procadmins`` 158 | system group when :file:`/proc` ``hidepid`` option is enabled. [drybjed_] 159 | 160 | Removed 161 | ~~~~~~~ 162 | 163 | - Remove the ``at`` package from list of installed packages, it's now managed 164 | by separate debops.atd_ role. [drybjed_] 165 | -------------------------------------------------------------------------------- /COPYRIGHT: -------------------------------------------------------------------------------- 1 | debops.console - Manage misc console-related parameters 2 | 3 | Copyright (C) 2013-2016 Maciej Delmanowski 4 | Copyright (C) 2014-2017 DebOps https://debops.org/ 5 | 6 | This Ansible role is part of DebOps. 7 | 8 | DebOps is free software; you can redistribute it and/or modify 9 | it under the terms of the GNU General Public License version 3, as 10 | published by the Free Software Foundation. 11 | 12 | DebOps is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License 18 | along with DebOps. If not, see https://www.gnu.org/licenses/. 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## [![DebOps project](http://debops.org/images/debops-small.png)](http://debops.org) console 2 | 3 | [![Travis CI](http://img.shields.io/travis/debops/ansible-console.svg?style=flat)](http://travis-ci.org/debops/ansible-console) [![test-suite](http://img.shields.io/badge/test--suite-ansible--console-blue.svg?style=flat)](https://github.com/debops/test-suite/tree/master/ansible-console/) [![Ansible Galaxy](http://img.shields.io/badge/galaxy-debops.console-660198.svg?style=flat)](https://galaxy.ansible.com/list#/roles/1556) 4 | 5 | This role manages console-related things, like enabling serial console, 6 | setting up `/etc/motd` and `/etc/issue` files, configuring system-wide 7 | locale settings. You can also provide a list of packages to install. 8 | 9 | ### Installation 10 | 11 | This role requires at least Ansible `v1.7.0`. To install it, run: 12 | 13 | ansible-galaxy install debops.console 14 | 15 | ### Documentation 16 | 17 | More information about `debops.console` can be found in the 18 | [official debops.console documentation](http://docs.debops.org/en/latest/ansible/roles/debops.console.html). 19 | 20 | 21 | 22 | ### Are you using this as a standalone role without DebOps? 23 | 24 | You may need to include missing roles from the [DebOps common 25 | playbook](https://github.com/debops/debops-playbooks/blob/master/playbooks/common.yml) 26 | into your playbook. 27 | 28 | [Try DebOps now](https://github.com/debops/debops) for a complete solution to run your Debian-based infrastructure. 29 | 30 | 31 | 32 | 33 | 34 | ### Authors and license 35 | 36 | `console` role was written by: 37 | - Maciej Delmanowski | [e-mail](mailto:drybjed@gmail.com) | [Twitter](https://twitter.com/drybjed) | [GitHub](https://github.com/drybjed) 38 | 39 | License: [GPLv3](https://tldrlegal.com/license/gnu-general-public-license-v3-%28gpl-3%29) 40 | 41 | *** 42 | 43 | This role is part of the [DebOps](http://debops.org/) project. README generated by [ansigenome](https://github.com/nickjj/ansigenome/). 44 | -------------------------------------------------------------------------------- /defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # Custom string added to /etc/issue 4 | console_issue: '{{ ansible_domain.split(".")[0] | capitalize }}' 5 | 6 | # If ``True``, show the logged in users. Note that this count does only update 7 | # when the screen is manually refreshed. 8 | console__issue_show_logged_in_users: True 9 | 10 | # Enable or disable serial console (allows you to use 'lxc-console', 11 | # 'virsh console' and other similar commands) 12 | console_serial: False 13 | 14 | # Serial console port 15 | console_serial_port: 'ttyS0' 16 | 17 | # Serial console baud rate 18 | console_serial_baud: '115200' 19 | 20 | # Serial console TERM string used to define terminal capabilities 21 | console_serial_term: 'xterm' 22 | 23 | # String used to enable serial console in sysvinit /etc/inittab 24 | console_serial_inittab: 'S0:2345:respawn:/sbin/getty -L {{ console_serial_port }} {{ console_serial_baud }} {{ console_serial_term }}' 25 | 26 | # Contents of /etc/motd 27 | console_motd: | 28 | ------------------------------------------------- 29 | This system is managed by Ansible 30 | ------------------------------------------------- 31 | 32 | # List of required console packages 33 | console_base_packages: [ 'locales' ] 34 | 35 | # List of packages to install depending on a condition 36 | console_conditional_packages: 37 | 38 | # Install NFS support when remote filesystems are configured 39 | - [ '{{ "nfs-common" 40 | if (console_mounts_nfs|d() or 41 | console_group_mounts_nfs|d() or 42 | console_host_mounts_nfs|d()) 43 | else [] }}' ] 44 | 45 | # Install 'sysnews' when news support is enabled 46 | - [ '{{ "sysnews" 47 | if (console_sysnews|d() and console_sysnews|bool) 48 | else [] }}' ] 49 | 50 | # List of preferred text editors. The first one found will be configured as the 51 | # default for the ``editor`` command. 52 | console_preferred_editors: 53 | - '/usr/bin/vim.basic' 54 | - '/usr/bin/emacs24' 55 | - '/usr/bin/vim.tiny' 56 | - '/bin/nano' 57 | - '/bin/ed' 58 | 59 | # Enable or disable FSCKFIX option in /etc/default/rcS 60 | # This option controls the behaviour of fsck during boot time, if it's enabled, 61 | # fsck will automatically repair filesystems without stopping the boot 62 | # process. Choices: yes, no. 63 | console_fsckfix: 'yes' 64 | 65 | # List of OS distribution releases which use the FSCKFIX option in a configuration file. 66 | console_fsckfix_releases: [ 'wheezy', 'jessie', 'precise', 'trusty', 'xenial' ] 67 | 68 | # List of locales to enable on the host 69 | console_locales: [ 'en_US.UTF-8' ] 70 | 71 | # Specify default system-wide locale 72 | console_locales_default: '' 73 | 74 | 75 | # ---- /proc & hidepid= options ---- 76 | 77 | # Mounting /proc with hidepid= allows you to hide process information of other 78 | # users on unprivileged accounts. This functionality is only enabled on recent 79 | # Linux kernels, and only on hardware hosts or KVM virtual machines. For LXC 80 | # containers, have a look at the 'debops.lxc' role. For OpenVZ containers, 81 | # AFAIK there's no way to enable it. 82 | 83 | # Enable or disable hidepid= option in /proc. Disabling only stops Ansible 84 | # from adding hidepid= automatically, you need to remove the /proc entry from 85 | # /etc/fstab manually (and optionally remount command from /etc/rc.local) 86 | # because if Ansible tries to do this using the 'mount' module, it will try to 87 | # remove the /proc mount point as well. :-( 88 | console_proc_hidepid: True 89 | 90 | # What level of hidepid= to use (choices: 0, 1, 2) 91 | console_proc_hidepid_level: '2' 92 | 93 | # System group to set for /proc so that selected users can access it without 94 | # restrictions; this is meant for monitoring services, etc. 95 | console_proc_hidepid_group: 'procadmins' 96 | 97 | 98 | # ---- /etc/hosts ---- 99 | 100 | # Add or remove entries in /etc/hosts 101 | console_hosts: {} 102 | console_group_hosts: {} 103 | console_host_hosts: {} 104 | 105 | # Examples: 106 | # console_hosts: 107 | # '192.0.2.1': 'hostname.example.com' 108 | # '2001:db8::1': [ 'host.example.org', 'host' ] 109 | # 110 | # # These entries will be removed 111 | # '192.0.2.3': '' 112 | # '192.0.2.4': [] 113 | 114 | 115 | # ---- Copy custom files ---- 116 | 117 | # Copy arbitrary files from Ansible Controller to remote hosts. Ansible does 118 | # not check if source file exists. Most of the 'copy' module parameters can be 119 | # used as dict keys. 120 | console_custom_files: [] 121 | 122 | # Examples: 123 | # console_custom_files: 124 | # 125 | # # Copy single files 126 | # - src: '/etc/fstab' 127 | # dest: '/tmp/fstab' 128 | # 129 | # # Copy directories 130 | # - src: '/usr/local/' 131 | # dest: '/tmp/local' 132 | # owner: 'root' 133 | # group: 'root' 134 | 135 | 136 | # ---- Filesystem mount points ---- 137 | 138 | # You can use console_*_mounts lists to mout local or remote filesystems on 139 | # hosts. The syntax is the same as the 'mount' Ansible module. 'item.name' and 140 | # 'item.src' are required, additionally, 'item.fstype' is required for local 141 | # mount points. 142 | # For NFS mounts, you need to install 'nfs-common' package, for example by 143 | # adding it to 'console_packages' list. 144 | 145 | # Default mount options for local mount points 146 | console_default_mount_options: 'defaults' 147 | 148 | # Default mount options for NFS mount points 149 | console_default_mount_nfs_options: 'nosuid,hard,intr,proto=tcp,port=2049,_netdev' 150 | console_default_mount_nfs_type: 'nfs' 151 | 152 | # Examples: 153 | # console_mounts: 154 | # - name: '/other/data' 155 | # src: '/var/lib/data' 156 | # opts: 'bind' 157 | # 158 | # console_nfs_mounts: 159 | # - name: '/media/nfs' 160 | # src: 'data.example.org:/srv/nfs' 161 | 162 | # Local mount points 163 | console_mounts: [] 164 | console_group_mounts: [] 165 | console_host_mounts: [] 166 | 167 | # NFS mount points 168 | console_mounts_nfs: [] 169 | console_group_mounts_nfs: [] 170 | console_host_mounts_nfs: [] 171 | 172 | 173 | # ---- sysnews support ---- 174 | 175 | # Install ``sysnews`` package to present system-related news to users on log 176 | # in. 177 | console_sysnews: False 178 | 179 | # Add ``sysnews`` support in :file:`/etc/profile.d/` so it's executed conditionally 180 | # on user login. 181 | console_sysnews_global: True 182 | 183 | # Accounts with UID bigger than this variable's value will be shown the news on 184 | # interactive login. 185 | console_sysnews_min_uid: '500' 186 | 187 | # Dict variable with news entries. Each key is name of the news file, and 188 | # a value should be a YAML text block with the message stored in the file. 189 | # Example: 190 | # 191 | # console_sysnews_entries: 192 | # 'WELCOME': | 193 | # Welcome on the {{ ansible_fqdn }} server! 194 | # 195 | console_sysnews_entries: {} 196 | -------------------------------------------------------------------------------- /docs/changelog.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../CHANGES.rst 2 | -------------------------------------------------------------------------------- /docs/copyright.rst: -------------------------------------------------------------------------------- 1 | Copyright 2 | ========= 3 | 4 | .. literalinclude:: ../COPYRIGHT 5 | -------------------------------------------------------------------------------- /docs/getting-started.rst: -------------------------------------------------------------------------------- 1 | Getting started 2 | =============== 3 | 4 | .. contents:: 5 | :local: 6 | 7 | 8 | Example inventory 9 | ----------------- 10 | 11 | ``debops.console`` is included by default in the :file:`common.yml` DebOps 12 | playbook; you don't need to do anything to have it executed. 13 | 14 | 15 | Example playbook 16 | ---------------- 17 | 18 | If you are using this role without DebOps, here's an example Ansible playbook 19 | that uses the ``debops.console`` role: 20 | 21 | .. literalinclude:: playbooks/console.yml 22 | :language: yaml 23 | -------------------------------------------------------------------------------- /docs/includes/all.rst: -------------------------------------------------------------------------------- 1 | .. include:: includes/global.rst 2 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. _debops.console: 2 | 3 | Ansible role: debops.console 4 | ============================ 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | 9 | introduction 10 | getting-started 11 | defaults 12 | copyright 13 | changelog 14 | 15 | .. 16 | Local Variables: 17 | mode: rst 18 | ispell-local-dictionary: "american" 19 | End: 20 | -------------------------------------------------------------------------------- /docs/introduction.rst: -------------------------------------------------------------------------------- 1 | Introduction 2 | ============ 3 | 4 | The ``debops.console`` role manages miscellaneous preferences related to the 5 | Linux console and CLI environment. 6 | 7 | 8 | Installation 9 | ~~~~~~~~~~~~ 10 | 11 | This role requires at least Ansible ``v2.2.0``. To install it, run: 12 | 13 | .. code-block:: console 14 | 15 | ansible-galaxy install debops.console 16 | 17 | .. 18 | Local Variables: 19 | mode: rst 20 | ispell-local-dictionary: "american" 21 | End: 22 | -------------------------------------------------------------------------------- /docs/playbooks/console.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Manage console configuration 4 | hosts: [ 'debops_all_hosts', 'debops_service_console' ] 5 | become: True 6 | 7 | environment: '{{ inventory__environment | d({}) 8 | | combine(inventory__group_environment | d({})) 9 | | combine(inventory__host_environment | d({})) }}' 10 | 11 | roles: 12 | 13 | - role: debops.console 14 | tags: [ 'role::console' ] 15 | -------------------------------------------------------------------------------- /handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Reload sysvinit 4 | command: telinit q 5 | 6 | -------------------------------------------------------------------------------- /meta/ansigenome.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | ansigenome_info: 4 | galaxy_url: "https://galaxy.ansible.com/debops/console" 5 | github_url: "https://github.com/debops/ansible-console" 6 | git_branch: "master" 7 | 8 | travis: True 9 | 10 | license_url: 'https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)' 11 | 12 | authors: 13 | - name: 'Maciej Delmanowski' 14 | url: '' 15 | email: 'drybjed@gmail.com' 16 | twitter: 'drybjed' 17 | github: 'drybjed' 18 | 19 | synopsis: | 20 | This role manages console-related things, like enabling serial console, 21 | setting up `/etc/motd` and `/etc/issue` files, configuring system-wide 22 | locale settings. You can also provide a list of packages to install. 23 | -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | dependencies: 4 | 5 | - role: debops.secret 6 | 7 | galaxy_info: 8 | author: 'Maciej Delmanowski' 9 | description: 'Configure system console and terminal-related options' 10 | company: 'DebOps' 11 | license: 'GPL-3.0' 12 | min_ansible_version: '2.2.0' 13 | platforms: 14 | - name: Ubuntu 15 | versions: 16 | - precise 17 | - quantal 18 | - raring 19 | - saucy 20 | - trusty 21 | - name: Debian 22 | versions: 23 | - wheezy 24 | - jessie 25 | galaxy_tags: 26 | - system 27 | 28 | -------------------------------------------------------------------------------- /tasks/filesystem_mount.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Manage local mount points 4 | mount: 5 | name: '{{ item.name }}' 6 | src: '{{ item.src }}' 7 | fstype: '{{ item.fstype }}' 8 | opts: '{{ item.opts | default(console_default_mount_options) }}' 9 | state: '{{ item.state | default("mounted") }}' 10 | passno: '{{ item.passno | default(omit) }}' 11 | dump: '{{ item.dump | default(omit) }}' 12 | fstab: '{{ item.fstab | default(omit) }}' 13 | with_flattened: 14 | - '{{ console_mounts }}' 15 | - '{{ console_group_mounts }}' 16 | - '{{ console_host_mounts }}' 17 | when: ((item.name is defined and item.name) and 18 | (item.src is defined and item.src) and 19 | (item.fstype is defined and item.fstype)) 20 | 21 | - name: Manage NFS mount points 22 | mount: 23 | name: '{{ item.name }}' 24 | src: '{{ item.src }}' 25 | fstype: '{{ item.fstype | default(console_default_mount_nfs_type) }}' 26 | opts: '{{ item.opts | default(console_default_mount_nfs_options) }}' 27 | state: '{{ item.state | default("mounted") }}' 28 | passno: '{{ item.passno | default(omit) }}' 29 | dump: '{{ item.dump | default(omit) }}' 30 | fstab: '{{ item.fstab | default(omit) }}' 31 | with_flattened: 32 | - '{{ console_mounts_nfs }}' 33 | - '{{ console_group_mounts_nfs }}' 34 | - '{{ console_host_mounts_nfs }}' 35 | when: ((item.name is defined and item.name) and 36 | (item.src is defined and item.src)) 37 | 38 | - name: Ensure mount directories exist when manually mounted 39 | file: 40 | path: '{{ item.name }}' 41 | state: 'directory' 42 | when: (item.state is string and item.state == 'present') 43 | with_flattened: 44 | - '{{ console_mounts }}' 45 | - '{{ console_group_mounts }}' 46 | - '{{ console_host_mounts }}' 47 | - '{{ console_mounts_nfs }}' 48 | - '{{ console_group_mounts_nfs }}' 49 | - '{{ console_host_mounts_nfs }}' 50 | 51 | -------------------------------------------------------------------------------- /tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Install requested packages 4 | apt: 5 | name: '{{ item }}' 6 | state: 'present' 7 | install_recommends: False 8 | with_flattened: 9 | - '{{ console_base_packages }}' 10 | - '{{ console_conditional_packages }}' 11 | when: item is defined and item 12 | tags: [ 'meta::provision' ] 13 | 14 | - name: Check if /etc/inittab exists 15 | stat: 16 | path: '/etc/inittab' 17 | register: console_register_inittab 18 | 19 | - name: Disable serial console in /etc/inittab 20 | lineinfile: 21 | dest: '/etc/inittab' 22 | regexp: '^{{ console_serial_inittab }}' 23 | state: 'absent' 24 | when: ((console_serial is undefined or (console_serial is defined and not console_serial)) and 25 | ((console_register_inittab is defined and console_register_inittab) and 26 | console_register_inittab.stat.exists)) 27 | notify: [ 'Reload sysvinit' ] 28 | 29 | - name: Enable serial console in /etc/inittab 30 | lineinfile: 31 | dest: '/etc/inittab' 32 | regexp: '^{{ console_serial_inittab }}' 33 | state: 'present' 34 | line: '{{ console_serial_inittab }}' 35 | when: ((console_serial is defined and console_serial) and 36 | ((console_register_inittab is defined and console_register_inittab) and 37 | console_register_inittab.stat.exists)) 38 | notify: [ 'Reload sysvinit' ] 39 | 40 | - name: Divert original /etc/issue 41 | command: dpkg-divert --quiet --local --divert /etc/issue.dpkg-divert --rename /etc/issue 42 | args: 43 | creates: '/etc/issue.dpkg-divert' 44 | 45 | - name: Configure /etc/issue 46 | template: 47 | src: '{{ lookup("template_src", "etc/issue.j2") }}' 48 | dest: '/etc/issue' 49 | owner: 'root' 50 | group: 'root' 51 | mode: '0644' 52 | 53 | - name: Configure /etc/motd 54 | template: 55 | src: '{{ lookup("template_src", "etc/motd.j2") }}' 56 | dest: '/etc/motd' 57 | owner: 'root' 58 | group: 'root' 59 | mode: '0644' 60 | 61 | - name: Configure fsck behaviour on boot 62 | lineinfile: 63 | dest: '/etc/default/rcS' 64 | regexp: 'FSCKFIX=' 65 | state: 'present' 66 | line: 'FSCKFIX={{ console_fsckfix }}' 67 | when: ansible_distribution_release in console_fsckfix_releases 68 | 69 | - name: Ensure that specified locales exist 70 | locale_gen: 71 | name: '{{ item }}' 72 | state: 'present' 73 | with_items: '{{ console_locales }}' 74 | when: (console_locales is defined and console_locales) 75 | tags: [ 'role::console:locale' ] 76 | 77 | - name: Set default system locale 78 | debconf: 79 | name: 'locales' 80 | question: 'locales/default_environment_locale' 81 | vtype: 'string' 82 | value: '{{ console_locales_default }}' 83 | register: console_register_default_locale 84 | when: (console_locales|d() and console_locales_default|d()) 85 | tags: [ 'role::console:locale' ] 86 | 87 | - name: Update /etc/default/locale 88 | command: update-locale LANG={{ console_locales_default }} 89 | when: console_register_default_locale|d() and 90 | console_register_default_locale.changed 91 | tags: [ 'role::console:locale' ] 92 | 93 | - name: Get list of available text editors 94 | command: update-alternatives --list editor 95 | register: console_register_installed_editors 96 | changed_when: False 97 | check_mode: False 98 | tags: [ 'role::console:editor' ] 99 | 100 | - name: Configure system-wide editor 101 | alternatives: 102 | name: 'editor' 103 | path: '{{ (console_preferred_editors | intersect(console_register_installed_editors.stdout_lines)) | first }}' 104 | tags: [ 'role::console:editor' ] 105 | 106 | # Enable hidepid= only on specific hosts 107 | - include: proc_hidepid.yml 108 | when: (ansible_local|d() and ((ansible_local.root|d() and 'ignore-cap12s' in ansible_local.root.flags) or 109 | (ansible_local.cap12s|d() and (not ansible_local.cap12s.enabled | bool or 110 | (ansible_local.cap12s.enabled | bool and 'cap_sys_admin' in ansible_local.cap12s.list))))) 111 | 112 | - name: Make sure that Ansible fact directory exists 113 | file: 114 | path: '/etc/ansible/facts.d' 115 | state: 'directory' 116 | owner: 'root' 117 | group: 'root' 118 | mode: '0755' 119 | 120 | - name: Install proc hidepid fact script 121 | template: 122 | src: 'etc/ansible/facts.d/proc.fact.j2' 123 | dest: '/etc/ansible/facts.d/proc.fact' 124 | owner: 'root' 125 | group: 'root' 126 | mode: '0755' 127 | 128 | - name: Remove obsolet sysctl configuration file 129 | file: 130 | path: '/etc/sysctl.d/10-debops.console.conf' 131 | state: 'absent' 132 | 133 | - name: Manage entries in /etc/hosts 134 | lineinfile: 135 | dest: '/etc/hosts' 136 | regexp: '^{{ item.key | replace(".","\.") }}\s+' 137 | line: "{{ item.key }}\t{{ item.value if (item.value is string) else (item.value|d() | join(' ')) }}" 138 | state: '{{ "present" if item.value|d() else "absent" }}' 139 | with_dict: '{{ console_hosts|combine(console_group_hosts,console_host_hosts) }}' 140 | tags: [ 'role::console:hosts' ] 141 | 142 | - name: Copy custom files to remote hosts 143 | copy: 144 | src: '{{ item.src }}' 145 | dest: '{{ item.dest }}' 146 | owner: '{{ item.owner | d(omit) }}' 147 | group: '{{ item.group | d(omit) }}' 148 | mode: '{{ item.mode | d(omit) }}' 149 | directory_mode: '{{ item.directory_mode | d(omit) }}' 150 | follow: '{{ item.follow | d(omit) }}' 151 | force: '{{ item.force | d(omit) }}' 152 | with_items: '{{ console_custom_files }}' 153 | when: (item.src|d() and item.dest|d()) 154 | tags: [ 'role::console:custom_files' ] 155 | 156 | - include: filesystem_mount.yml 157 | tags: [ 'role::console:mount' ] 158 | when: ( 159 | ansible_local|d() and ( 160 | (ansible_local.root|d() and 'ignore-cap12s' in ansible_local.root.flags) or ( 161 | ansible_local.cap12s|d() and ( 162 | not ansible_local.cap12s.enabled|bool or 163 | (ansible_local.cap12s.enabled|bool and 'cap_sys_admin' in ansible_local.cap12s.list) 164 | ) 165 | ) 166 | ) 167 | ) 168 | 169 | - include: sysnews.yml 170 | when: console_sysnews is defined and console_sysnews 171 | -------------------------------------------------------------------------------- /tasks/proc_hidepid.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Make sure that system group with access to /proc exists 4 | group: 5 | name: '{{ console_proc_hidepid_group }}' 6 | system: True 7 | state: 'present' 8 | when: console_proc_hidepid is defined and console_proc_hidepid 9 | 10 | - name: Configure /proc with hidepid= in /etc/fstab 11 | mount: 12 | name: '/proc' 13 | src: 'proc' 14 | fstype: 'proc' 15 | opts: 'defaults,hidepid={{ console_proc_hidepid_level }},gid={{ console_proc_hidepid_group }}' 16 | state: 'mounted' 17 | when: console_proc_hidepid is defined and console_proc_hidepid 18 | 19 | # This is a workaround for Ubuntu bug: https://bugs.launchpad.net/ubuntu/+source/mountall/+bug/1039887 20 | - name: Remount /proc from rc.local when needed 21 | lineinfile: 22 | dest: '/etc/rc.local' 23 | regexp: '^mount -o remount,hidepid={{ console_proc_hidepid_level }},gid={{ console_proc_hidepid_group }} /proc' 24 | line: 'mount -o remount,hidepid={{ console_proc_hidepid_level }},gid={{ console_proc_hidepid_group }} /proc' 25 | insertbefore: 'exit 0' 26 | state: 'present' 27 | when: ((console_proc_hidepid is defined and console_proc_hidepid) and 28 | (ansible_distribution in [ 'Ubuntu' ] and ansible_distribution_release in [ 'trusty' ])) 29 | 30 | - name: Create the systemd-logind configuration directory 31 | file: 32 | path: '/etc/systemd/system/systemd-logind.service.d' 33 | state: 'directory' 34 | owner: 'root' 35 | group: 'root' 36 | mode: '0755' 37 | when: (console_proc_hidepid | bool and 38 | (ansible_local|d() and ansible_local.init|d() and 39 | ansible_local.init == "systemd")) 40 | 41 | - name: Ensure that logind is exempt from hidepid 42 | template: 43 | src: 'etc/systemd/system/systemd-logind.service.d/hidepid.conf.j2' 44 | dest: '/etc/systemd/system/systemd-logind.service.d/hidepid.conf' 45 | owner: 'root' 46 | group: 'root' 47 | mode: '0644' 48 | register: console_register_hidepid_logind 49 | when: (console_proc_hidepid | bool and 50 | (ansible_local|d() and ansible_local.init|d() and 51 | ansible_local.init == "systemd")) 52 | 53 | - name: Reload systemd daemons 54 | command: systemctl daemon-reload 55 | when: console_register_hidepid_logind.changed | bool 56 | 57 | -------------------------------------------------------------------------------- /tasks/sysnews.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Enable system news bulletin for all users 4 | template: 5 | src: 'etc/profile.d/sysnews.sh.j2' 6 | dest: '/etc/profile.d/sysnews.sh' 7 | owner: 'root' 8 | group: 'root' 9 | mode: '0644' 10 | when: console_sysnews_global|d() and 11 | console_sysnews_global|bool 12 | 13 | - name: Generate persistent news files 14 | template: 15 | src: 'var/lib/sysnews/news.j2' 16 | dest: '/var/lib/sysnews/{{ item.key }}' 17 | owner: 'root' 18 | group: 'root' 19 | mode: '0644' 20 | with_dict: '{{ console_sysnews_entries }}' 21 | when: console_sysnews_entries and item.key is defined and item.key 22 | 23 | - name: Update list of persistent files 24 | template: 25 | src: 'var/lib/sysnews/noexpire.j2' 26 | dest: '/var/lib/sysnews/.noexpire' 27 | owner: 'root' 28 | group: 'root' 29 | mode: '0644' 30 | when: console_sysnews_entries is defined and 31 | console_sysnews_entries 32 | 33 | -------------------------------------------------------------------------------- /templates/etc/ansible/facts.d/proc.fact.j2: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # {{ ansible_managed }} 4 | 5 | # Gather information about /proc related to hidepid 6 | 7 | set -o nounset -o pipefail -o errexit 8 | 9 | hidepid="false" 10 | hidepid_type="" 11 | hidepid_gid="" 12 | hidepid_group="" 13 | 14 | if grep -qs -E '^proc\s+.*hidepid=' /proc/mounts ; then 15 | 16 | hidepid="true" 17 | 18 | # Find the hidepid value 19 | hidepid_type="$(grep -E '^proc\s+.*hidepid=' /proc/mounts | awk '{print $4}' | awk -F',' '{for (i=1;i<=NF;i++) {if ($i ~ /hidepid=/) {print $i}}}' | cut -d= -f2)" 20 | 21 | # Find the hidepid gid 22 | hidepid_gid="$(grep -E '^proc\s+.*hidepid=' /proc/mounts | awk '{print $4}' | awk -F',' '{for (i=1;i<=NF;i++) {if ($i ~ /gid=/) {print $i}}}' | cut -d= -f2)" 23 | 24 | # Find the hidepid group 25 | if [ -n "${hidepid_gid}" ]; then 26 | hidepid_group="$(getent group ${hidepid_gid} | cut -d: -f1)" 27 | fi 28 | 29 | fi 30 | 31 | output="{\"hidepid\": \"${hidepid}\", \"hidepid_type\": \"${hidepid_type}\", \"hidepid_gid\": \"${hidepid_gid}\", \"hidepid_group\": \"${hidepid_group}\"}" 32 | 33 | echo ${output} 34 | 35 | -------------------------------------------------------------------------------- /templates/etc/issue.j2: -------------------------------------------------------------------------------- 1 | 2 |  /\\ \n.\O 3 |  / \\ {{ console_issue }} 4 |  DebOps 5 |  \\ / \l{% if (console__issue_show_logged_in_users|bool) %} / \U{% endif %} 6 |  \\/ \s \r 7 | 8 | -------------------------------------------------------------------------------- /templates/etc/motd.j2: -------------------------------------------------------------------------------- 1 | {{ console_motd }} 2 | -------------------------------------------------------------------------------- /templates/etc/profile.d/sysnews.sh.j2: -------------------------------------------------------------------------------- 1 | # {{ ansible_managed }} 2 | 3 | # Print system news when users log in 4 | 5 | # Show news only to potential normal users 6 | [ $EUID -ge {{ console_sysnews_min_uid }} ] || return 0 7 | 8 | # Check if sysnews is installed 9 | type news > /dev/null 2>&1 || return 0 10 | 11 | # Make sure that shell is bash or zsh 12 | [ -n "$BASH_VERSION" -o -n "$ZSH_VERSION" ] || return 0 13 | 14 | # Make sure that it's interactive session 15 | [[ $- == *i* ]] || return 0 16 | 17 | # Show system news to users 18 | tty -s && news -n 19 | 20 | -------------------------------------------------------------------------------- /templates/etc/systemd/system/systemd-logind.service.d/hidepid.conf.j2: -------------------------------------------------------------------------------- 1 | # {{ ansible_managed }} 2 | 3 | # Based on https://github.com/indiv0/ansible-role-console 4 | 5 | [Service] 6 | SupplementaryGroups={{ console_proc_hidepid_group }} 7 | 8 | -------------------------------------------------------------------------------- /templates/var/lib/sysnews/news.j2: -------------------------------------------------------------------------------- 1 | {% if item.value is defined and item.value %} 2 | {{ item.value }} 3 | {% endif %} 4 | -------------------------------------------------------------------------------- /templates/var/lib/sysnews/noexpire.j2: -------------------------------------------------------------------------------- 1 | {% for name in console_sysnews_entries.keys() %} 2 | {{ name }} 3 | {% endfor %} 4 | --------------------------------------------------------------------------------