Main Page: Difference between revisions

From techdocs
Jump to navigation Jump to search
No edit summary
 
(85 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Topics ==
{|width=50%
 
|<span style="color: red;">After migrating pages to Confluence, move each page to the "Pre-confluence" namespace '''without''' leaving a redirect behind. This ensures that it's obvious the page is gone and displays a "paper trail" if anyone tries to access the page.</span>
* [[AWS EFS home directories]]
|-
* [[Policies]] - also refer to DNS for usega epolicy for the different DNS domains
|<span style="color: red;">Pages can be migrated by copying-and-pasting the wikitext ("View source" if you're not logged in) into a file, running:
* [[UNSW reserved network block for CSE AWS hosting]]
* [[Linux namespaces and cgroups]]
* [[Automounter]]
* [[Home directories - file system types - NFS, AFS, CephFS]]
* [[systemd-logind user session management and clean up]]
* [[Clean-up scripts on userlogin hosts]]
* [[QEMU/KVM]]
* [[Local storage]]
* [[cfengine - stripped down compared to how it is distributed, m4]]
* [[conform]] - [[nodeinfo]]
* [[DHCP]]
* [[Lab computer auto install]]
* [[hostlist.csv]]
* [[host classes]]
* [[update_hosts]] - [[host generator]]s
* [[cfengine hub]]
* [[run-cf-agent]]
* [[check_and_install_promises]]
* [[/var/lib/cfengine3/masterfiles]] -> [[promises.cf]]
* [[/usr/local/warehouse]]
* [[/usr/local/administration]]
* [[Debian package management - installation, purging, auto update, CSG-managed lists, teaching-managed lists]]
* [[/usr/local/extrafiles]]
* [[/usr/local/extrapackages - installations triggered by list changes]]
* [[Monitoring - nagios, graphing, auto-configuration by update_hosts]]
* [[Email]]
* [[Old UDB]]
* [[New UDB]]
* [[bandleader]]
* [[maillard]]
* [[PostFix]]
* [[Printing]]
* [[Kerberos]]
* [[LDAP]]
* [[CSE network diagram]]
* [[AWS]]
* [[VPN to AWS]]
* [[podman]]
* [[AWS security groups and merge_ip_addresses_into_blocks]]
* [[pandoc]]
* [[MediaWiki documentation site management - MySQL DB, /home/mediawiki/images, /home/mwimages/]]
* [[Pages yet to be created]]


== Page categories ==
pandoc -f mediawiki -t docx -o /tmp/dummy.docx ''&lt;wikitextfile&gt;''


* [[:Category:Pages needing work|Pages needing work]]
And then importing <code>/tmp/dummy.docx</code> into a blank Confluence page.</span>
|}
<br />


== Introduction ==
{|style="float: right;"|
 
|[[Guide to TechDocs for administrators and content creators|Guide to TechDocs for<br />administrators and content creators]]
[[File:Csenwd_sample_image.png|thumb|Sample image]]
 
{{conform intro}}
 
The [[New World]] grew out a HoS-supported project to move as much [[CSE]] infrastructure as possible out of CSE's [[K17]] data centre and into "the cloud", specifically Amazon's AWS. Early on, a decision was made that <code>[[conform]]</code> would be left behind and that all new servers and hosts set up in AWS would be managed some other way. This other way ended up being -- after a review of configuration management tools -- a split between <code>[[cfengine]]</code> and Debian's <code>[[apt]]</code> family of package manager utilities (<code>apt</code>, <code>dpkg</code>, <code>apt-get</code>, <code>apt-file</code>, etc.) In this split, <code>apt</code> handles all Debian package management (mainly installs and updates) and <code>cfengine</code> handles the rest, mostly configuration files.
 
[[File:Csenwd_sample_image2.png|thumb|Sample image #2]]
 
Debian was chosen because CSE's existing teaching platform was heavily based on Debian and the principle of least surprise was applied.
 
A bit more specifically, each New World host's filesystem is handled thusly:
 
{|
!Path
!Handled by
|-
|<code>/etc</code>
|Jointly managed by <code>apt</code> which mostly provides default versions of configuration files, and <code>cfengine</code> which installs CSE-specific versions of configuration files
|-
|style="white-space: nowrap;"|<code>/usr/local/[[extrafiles]]</code><br /><code>/usr/local/[[extrapackages]]</code><br /><code>/usr/local/[[debpkgs_lists]]</code><br /><code>/usr/local/[[vmimages]]</code>
|<code>cfengine</code>
|-
|-
|<code>/proc</code><br /><code>/sys</code><br /><code>/dev</code>
|Style info:
|The kernel
Hosts classes are normal font and when referenced<br />in prose are contained in double quotes
|-
|-
|<code>/tmp</code><br /><code>/var</code>
|[[MediaWiki:Common.css]]
|Whatever processes are running on the host
|-
|-
|<code>/export</code>
|[https://taggi.cse.unsw.edu.au/FAQ/ Taggi]
|The kernel's <code>nfsd</code> (i.e., NFS server)
|-
|-
|<code>/import</code><br /><code>/home</code>
|[https://www.cse.unsw.edu.au/~virtualexam/ Virtual exam environment]
|The [[automounter]]
|-
|-
|Everything else
|[[File:CSE_network_diagram_-_September_2023.pdf]]
|<code>apt</code>
|}
|}


== The light-touch approach ==
== Overview ==
 
* [[Ceph testing and development cluster]]
* [[New World versus Old World]]
* [[conform gives way to cfengine]]
* [[Configuration management and operation with cfengine]]
* [[What does the CSE UDB (User DataBase) do?]]


There's a philosophy behind the way New World is set up. This is the "light touch approach" and goes like this:
== Uncategorized as yet ==


Leave Debian-installed configurations and defaults alone unless there is an actual operational or functional '''need''' to be addressed.
* [[Storage and compute cluster]]
** [[Ceph operation, maintenance and repair]]
* [[New World gitlab server]]
* [[/unsw]]
* [[Connecting to Wifi]]
* [[vncsend]] and [[vncrecv]], VLAB and lab screen session sharing - for tutors and for working in pairs
* [[User virtual machines on VLAB servers]]
* [[RoboLab VLAB server]]
* [[Proposed home directory architecture, configuration and management]]
* [[Academic allocations]]


Thus:
== To do ==
 
# Merge notes re [[debpkgsv2]] into some relevant page
# Review [[Special:LonelyPages|orphaned pages]]
# Review [[Special:WantedPages|wanted pages]]
# Do something with this page: [[MediaWiki]]
# [[AWS IPsec links]]
# Consider adding expiry and owner info to [[hostlist.csv]]
# [[ZZEN9217 H6 O.S. Fundamentals for Security: VM platform notes]]
# Do something with [[Lifecycle management of accounts (draft notes)]]
# Do something with [[Extra]]
 
== Subject categories ==


{|
{|
|Changes for cosmetic reasons
!Management and operation of systems
|No
!Maintenance procedures
!Individual systems, applications and services
!Teaching tech
|-
|-
|Changes for management or administrative convenience
|
|No
* [[Home and shared directories]]
|-
* [[Virtualisation and cloud]]
|Etcetera
* [[Policies and principles]]
|No
* [[Networking]]
* [[Host and server installation and setup]]
* [[User session and account management]]
* [[User database, authentication and authorisation]]
* [[Configuration management and operation with cfengine]]
* [[Software package management and Debian]]
* [[Email]]
* [[Printing]]
* [[Monitoring framework]]
* [[Virtual exam environment]]
* [[New World file system layout]]
* [[New World Backup System]]
|
* [[Resize the root/boot volume of an AWS host]]
|
* [[podman]]
* [[pandoc]]
* [[SNMP query examples]]
* [[priv scripts and sudo]]
|
* [[give]]
* [[SMS]]
* [[WebCMS3]]
* [[classrun]]
* [[Virtual exam environment]]
* [[CASTLE]]
* [[talloc]]
* [[gitlab.cse.unsw.edu]]
* [[run_student_code]]
* [[running software from other Debian releases]]
* [[dcc]]
* [[autotest]]
* [[Controlling Resources & Privileges with Linux namespaces, cgroups & limits]]
* <s>TODO: Examine the SyntaxHighlight extension<br />from the point of view of demands on<br />the host (suggested by AndrewT, see also https://phabricator.wikimedia.org/T250763)</s><br /><syntaxhighlight lang="bash">
#!/bin/bash
set -x
echo "The MediaWiki SyntaxHighlight extension is enabled"
exit 0
</syntaxhighlight><syntaxhighlight lang="c">
#include <stdio.h>
int main () {
printf ("Hello, world!\n");
return (0);
}
</syntaxhighlight>
|}
|}


== Debian package management (<code>apt</code>) ==
== Page categories ==


== Configuration management (<code>cfengine</code>) ==
* [[:Category:Pages needing work|Pages needing work]]
 
The [[cfengine hub]].
 
== Devolving teaching-related software and configuration to CSE's teaching staff ==
 
=== The split between CSG's and teaching's bailiwicks ===
 
== Differences between <code>conform</code> and <code>cfengine</code> ==
 
----
 
== MediaWiki installation leftovers ==
 
<strong>MediaWiki has been installed.</strong>
 
Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
 
== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]


[[Category:Pages needing work]]
[[Category:Pages needing work]]

Latest revision as of 12:20, 1 Mayıs 2024

After migrating pages to Confluence, move each page to the "Pre-confluence" namespace without leaving a redirect behind. This ensures that it's obvious the page is gone and displays a "paper trail" if anyone tries to access the page.
Pages can be migrated by copying-and-pasting the wikitext ("View source" if you're not logged in) into a file, running: 
pandoc -f mediawiki -t docx -o /tmp/dummy.docx <wikitextfile>

And then importing /tmp/dummy.docx into a blank Confluence page.


Guide to TechDocs for
administrators and content creators
Style info:

Hosts classes are normal font and when referenced
in prose are contained in double quotes

MediaWiki:Common.css
Taggi
Virtual exam environment
File:CSE network diagram - September 2023.pdf

Overview

Uncategorized as yet

To do

  1. Merge notes re debpkgsv2 into some relevant page
  2. Review orphaned pages
  3. Review wanted pages
  4. Do something with this page: MediaWiki
  5. AWS IPsec links
  6. Consider adding expiry and owner info to hostlist.csv
  7. ZZEN9217 H6 O.S. Fundamentals for Security: VM platform notes
  8. Do something with Lifecycle management of accounts (draft notes)
  9. Do something with Extra

Subject categories

Management and operation of systems Maintenance procedures Individual systems, applications and services Teaching tech

Page categories

Retrieved from ‘https://techdocs.cseunsw.tech/mediawiki/index.php?title=Main_Page&oldid=1304’