Readme Update

This commit is contained in:
Tyler Hale 2022-08-22 15:34:30 -06:00
parent ff0443f627
commit 70c33fa15f
Signed by: Tyler
GPG key ID: C7CC4B910D88EF96

View file

@ -1,6 +1,6 @@
# Ansible-Linux_Base
Configures a Linux machine to the corporate base image from default install media
Configures a Linux machine to the corporate base image from default install media with a minimal install
## Requirements
@ -14,19 +14,23 @@ If the "base_core_hostname" variable is defined, it is recommended to set the an
### Core Variables
| Variable | Required | Default | Choices | Comments |
| -------------------------------------------- | -------- | ------------ | ----------- | ---------------------------------------------------------------------- |
| base_core_management_user | No | ansible_user | | Defines the account that ansible will use for management in the future |
| base_core_install_updates | Yes | True | True, False | Install all available updates for the distro at runtime |
| base_core_hostname | No | "" | | Defines the computer hostname |
| base_core_motd_banner | No | "" | | Banner to be added to MOTD if desired |
| base_core_ssh_permit_root_login | Yes | False | True, False | Permits the use of root logins for ssh |
| base_core_ssh_permit_password_authentication | Yes | False | True, False | Permits the use of passwords for ssh |
| base_core_cert_common_name | No | nodename | | Common name for created self-signed cert |
| base_core_root_ca_basename | No | "" | | Basename of the cert for local system reference |
| base_core_root_ca_convert | Yes | False | True, False | Converts the defined certificate from DER to PEM type |
| base_core_root_ca_url | No | "" | | URL of a Root CA to install |
| base_core_web_management | Yes | False | True, False | Enables installation of the Cockpit web management package(s) |
| Variable | Required | Default | Choices | Comments |
| -------------------------------------------- | -------- | ------------- | ----------- | -------------------------------------------------------------------------- |
| base_core_cert_common_name | No | nodename | | Common name for created self-signed cert |
| base_core_hostname | No | "" | | Defines the computer hostname |
| base_core_install_updates | Yes | True | True, False | Install all available updates for the distro at runtime |
| base_core_management_user | No | ansible_user | | Defines the account that ansible will use for management in the future |
| base_core_management_user_disable_password | No | False | True, False | When enabled the password for the management user account will be disabled |
| base_core_motd_banner | No | "" | | Banner to be added to MOTD if desired |
| base_core_motd_enabled | Yes | True | True, False | Allows the MOTD to be configured |
| base_core_root_ca_basename | No | "" | | Basename of the cert for local system reference |
| base_core_root_ca_convert | Yes | False | True, False | Converts the defined certificate from DER to PEM type |
| base_core_root_ca_url | No | "" | | URL of a Root CA to install |
| base_core_ssh_permit_password_authentication | Yes | False | True, False | Permits the use of passwords for ssh |
| base_core_ssh_permit_root_login | Yes | False | True, False | Permits the use of root logins for ssh |
| base_core_timezone | No | America/Boise | | Defines the timezone to apply to the client |
| base_core_web_management | Yes | False | True, False | Enables installation of the Cockpit web management package(s) |
## Example
@ -49,10 +53,9 @@ prod:
ansible_host: 192.168.0.11
vars:
ansible_user: ansible
ansible_ssh_common_args: '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no'
base_core_ssh_permit_password_authentication: true
ansible_user: ansible
"#########################################################################################\n ___ _ _____ __ \n / |_ _____ ____ ____ _(_)___ ____ _ / ___/__ _______/ /____ ____ ___ _____\n / /| | | / / _ \\/ __ \\/ __ `/ / __ \\/ __ `/ \\__ \\/ / / / ___/ __/ _ \\/ __ `__ \\/ ___/\n / ___ | |/ / __/ / / / /_/ / / / / / /_/ / ___/ / /_/ (__ ) /_/ __/ / / / / (__ ) \n/_/ |_|___/\\___/_/ /_/\\__, /_/_/ /_/\\__, / /____/\\__, /____/\\__/\\___/_/ /_/ /_/____/ \n /____/ /____/ /____/ \n \n#########################################################################################"
```
### Tags