Merge pull request #2557 from holta/admin_console_install-and-enabled

Document that admin_console_install and _enabled now work

roles/0-init/tasks/validate_vars.yml

@@ -63,7 +63,7 @@
       #- wondershaper       # Unmaintained
       - sshd
       - openvpn
-      - admin_console       # Coming soon
+      - admin_console
       #- nginx              # MANDATORY
       #- apache             # Dependency installed on demand by other apps/svcs
       #- mysql              # MANDATORY

vars/default_vars.yml

@@ -68,15 +68,25 @@ iiab_admin_pwd_hash: $6$xsce51$D.IrrEeLBYIuJkGDmi27pZUGOwPFp98qpl3hxMwWV4hXigFGm
 # Time Zone (php needs timezone to be set)
 local_tz: "{{ ansible_date_time.tz }}"
 
-# Read https://github.com/iiab/iiab/wiki/IIAB-Networking
-# Also readable offline @ http://box/info/IIAB-Networking.html
+# IIAB Admin Console is sometimes not needed, e.g. on Raspberry Pi Zero W
+admin_console_install: True
+admin_console_enabled: True
+#
+# Set to "False" if you want to revert to the older Dynamic Menuing system
+# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
+js_menu_install: True
+
+
+# IIAB Networking README: https://github.com/iiab/iiab/tree/master/roles/network
+# IIAB Networking Doc: https://github.com/iiab/iiab/wiki/IIAB-Networking
+# Read it offline too: http://box/info > "IIAB Networking"
 
 # NETWORK PARAMETERS FOLLOW ACROSS THE NEXT 100 LINES, as enabled by Ansible's
-# NETWORK role (/opt/iiab/iiab/roles/network/*) in 4-SERVER-OPTIONS below.
-# SEE ALSO: /opt/iiab/iiab/roles/network/defaults/main.yml
+# NETWORK role (/opt/iiab/iiab/roles/network).  SEE ALSO:
+# https://github.com/iiab/iiab/blob/master/roles/network/defaults/main.yml
 
-# The following variable may be useful in debugging
-disregard_network: False  # use cache or error out if cache does not exist
+# The following variable may be useful in debugging:
+disregard_network: False    # Use cache, or error out if cache does not exist.
 
 iiab_hostname: box
 iiab_domain: lan
@@ -168,10 +178,6 @@ bluetooth_install: True
 bluetooth_enabled: False
 bluetooth_term_enabled: False
 
-# Set to "False" if you want to revert to the older Dynamic Menuing system
-# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
-js_menu_install: True    # SEE BELOW: admin_console_install & _enabled.
-
 # UNMAINTAINED as of October 2017: https://github.com/iiab/iiab/pull/382
 wondershaper_install: False
 wondershaper_enabled: False
@@ -195,14 +201,6 @@ wan_nameserver:    # wan_nameserver: 192.168.1.254 or 8.8.8.8 or 1.1.1.1
 wan_try_dhcp_before_static_ip: True   # Facilitate field updates w/ cablemodems
 # Details @ roles/network/templates/network/dhcpcd.conf.j2 for /etc/dhcpcd.conf
 
-# Parameters for Aggregate Roles
-# Each Role should have the following variables which are either True or False:
-#   <role-name>_install
-#   <role-name>_enabled
-
-# Past convention had been to install everything in all aggregate roles (stages)
-# And to enable everything in 1-PREP, 2-COMMON, and 3-BASE-SERVER
-
 
 # 1-PREP
 
@@ -239,10 +237,6 @@ pi_swap_file_size: 1024
 
 # 3-BASE-SERVER
 
-# 2020-05-22: Neither in use at the moment. See also js_menu_install (above).
-admin_console_install: True
-admin_console_enabled: True
-
 # 2020-09-24: MySQL / MariaDB is MANDATORY but still evolving - please see:
 # https://github.com/iiab/iiab/blob/master/roles/mysql/tasks/install.yml
 # https://github.com/iiab/iiab/blob/master/roles/3-base-server/tasks/main.yml

vars/local_vars_big.yml

@@ -36,6 +36,19 @@ iiab_admin_pwd_hash: $6$xsce51$D.IrrEeLBYIuJkGDmi27pZUGOwPFp98qpl3hxMwWV4hXigFGm
 # Obtain a password hash - OLD WAY:
 #    python -c 'import crypt; print crypt.crypt("<plaintext>", "$6$<salt>")'
 
+# IIAB Admin Console is sometimes not needed, e.g. on Raspberry Pi Zero W
+admin_console_install: True
+admin_console_enabled: True
+#
+# Set to "False" if you want to revert to the older Dynamic Menuing system
+# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
+js_menu_install: True
+
+
+# IIAB Networking README: https://github.com/iiab/iiab/tree/master/roles/network
+# IIAB Networking Doc: https://github.com/iiab/iiab/wiki/IIAB-Networking
+# Read it offline too: http://box/info > "IIAB Networking"
+
 iiab_hostname: box
 iiab_domain: lan
 
@@ -119,10 +132,6 @@ bluetooth_install: True
 bluetooth_enabled: False
 bluetooth_term_enabled: False
 
-# Set to "False" if you want to revert to the older Dynamic Menuing system
-# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
-js_menu_install: True
-
 # UNMAINTAINED as of October 2017: https://github.com/iiab/iiab/pull/382
 # wondershaper_install: False
 # wondershaper_enabled: False

vars/local_vars_medium.yml

@@ -36,6 +36,19 @@ iiab_admin_pwd_hash: $6$xsce51$D.IrrEeLBYIuJkGDmi27pZUGOwPFp98qpl3hxMwWV4hXigFGm
 # Obtain a password hash - OLD WAY:
 #    python -c 'import crypt; print crypt.crypt("<plaintext>", "$6$<salt>")'
 
+# IIAB Admin Console is sometimes not needed, e.g. on Raspberry Pi Zero W
+admin_console_install: True
+admin_console_enabled: True
+#
+# Set to "False" if you want to revert to the older Dynamic Menuing system
+# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
+js_menu_install: True
+
+
+# IIAB Networking README: https://github.com/iiab/iiab/tree/master/roles/network
+# IIAB Networking Doc: https://github.com/iiab/iiab/wiki/IIAB-Networking
+# Read it offline too: http://box/info > "IIAB Networking"
+
 iiab_hostname: box
 iiab_domain: lan
 
@@ -119,10 +132,6 @@ bluetooth_install: True
 bluetooth_enabled: False
 bluetooth_term_enabled: False
 
-# Set to "False" if you want to revert to the older Dynamic Menuing system
-# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
-js_menu_install: True
-
 # UNMAINTAINED as of October 2017: https://github.com/iiab/iiab/pull/382
 # wondershaper_install: False
 # wondershaper_enabled: False

vars/local_vars_min.yml

@@ -36,6 +36,19 @@ iiab_admin_pwd_hash: $6$xsce51$D.IrrEeLBYIuJkGDmi27pZUGOwPFp98qpl3hxMwWV4hXigFGm
 # Obtain a password hash - OLD WAY:
 #    python -c 'import crypt; print crypt.crypt("<plaintext>", "$6$<salt>")'
 
+# IIAB Admin Console is sometimes not needed, e.g. on Raspberry Pi Zero W
+admin_console_install: True
+admin_console_enabled: True
+#
+# Set to "False" if you want to revert to the older Dynamic Menuing system
+# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
+js_menu_install: True
+
+
+# IIAB Networking README: https://github.com/iiab/iiab/tree/master/roles/network
+# IIAB Networking Doc: https://github.com/iiab/iiab/wiki/IIAB-Networking
+# Read it offline too: http://box/info > "IIAB Networking"
+
 iiab_hostname: box
 iiab_domain: lan
 
@@ -119,10 +132,6 @@ bluetooth_install: True
 bluetooth_enabled: False
 bluetooth_term_enabled: False
 
-# Set to "False" if you want to revert to the older Dynamic Menuing system
-# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
-js_menu_install: True
-
 # UNMAINTAINED as of October 2017: https://github.com/iiab/iiab/pull/382
 # wondershaper_install: False
 # wondershaper_enabled: False