systeemdocumentatie

[x-force]

Door een brakke HD heb ik een complete nieuwe server geregeld en ben nu alles opnieuw aan het installeren. Bij een aantal paketten zit ik nu met welke opties dit ge-./configure-ed is en dat soort dingen.... om vragen te voorkomen als " hoe heb ik dat de vorige keer ook al weer gedaan?? " wil ik goede documentatie maken.

Ik ben nu bezig in een word-doc, en beschrijf behoorlijk veel. Elke stap, elk commando maar hierdoor staan er dus best veel nutteloze dingen in.

mijn vraag is :

- Doen jullie hieraan?
- Wat documenteren jullie en hoe?
- Hoe op te slaan? DOC/PDF/plain tekst

Beschrijven jullie echt alles? Voor bijvoorbeeld 'de volgende' die nog niet veel kennis heeft? Of een kort overzicht met geinstalleerde paketten?

[Wilke]

De makkelijkste manier om dit te doen is door gewoon alles wat je intikt te loggen. Dan hoef je niet zo veel moeite te doen op het moment van intikken, terwijl als je het later terugzoekt je met grep waarschijnlijk snel terugvindt wat je toen ook nog maar weer had gedaan.

Welk formaat? Als je het maar makkelijk overal kunt lezen, het liefst met een willekeurige editor, zodat je het ook op een half-geinstalleerd systeem al kunt lezen. Voordeel van plaintext is ook dat je er in kunt greppen.

Daarom valt MS Word wat mij betreft dan ook direct af. PDF om dezelfde reden ook.

[x-force]

Maar de installatie doe je dus in 1 tekst file.... Maar hoe zit het dan met later programma's updaten of toevoegen/verwijderen van paketten? Zet je dit in het zelfde document er onder? of voor elke toepassing een ander bestand?

bijvoorbeeld:
- install => server installatie zelf
- web => alles met wat je web je maken heeft (apache/php/gd/enz)
- mail
- enz

en waar bewaar je deze documenten? op de server/systeem zelf? of remote?

[ Voor 12% gewijzigd door x-force op 22-12-2003 16:19 ]

[Kees]

Ik log zelf bijna alles wat ik met SSH op de servers doe, juist om dit soort vragen 'hoe deed ik da ad-hoc commando ook al weer' 'welke opties gaf ik precies mee aan dat programma'.

Met putty kun je redelijk makkelijk loggen (Session -> logging, en dan een filenaam als server-&T-&D-&M-&Y.log (tijd, dag, maand en jaar).

Nadeel is dat dit aan de clientside moet gebeuren, serverside is er geen andere oplossing dan een screen starten en daar de inhoud van te loggen. (ctrl-a-H, of een cli optie, zie man)

Je kan ook een 'server in the middle' gebruiken, ik heb een tijd lang naar me server thuis ge'ssh'ed met een username per server, de shell van die user was dan een scriptje dat sshde naar die server + een 'tee' (man tee) naar een logfile.

Verder documenteer ik lang niet alles, veel is standaard, maar dingen als php-apche installs heb ik allemaal in een aantal textfiles staan, ook dingen als firewalls e.d.
Updates installen e.d. ga ik van uit dat een eventuele opvolger over die kennig beschikt, en anders snel terug kan vinden op het internet.
Documenten bewaar ik allemaal lokaal.

[Wilke]

Voordeel van in tekstfiles loggen is daarnaast, dat je later gewoon heel makkelijk commando's kunt copy/pasten vanuit de tekstfile.

Ideaal voor luie mensen - je moet tenslotte niet voor de tweede keer iets uitvinden wat je eerder ook al eens bedacht had

Voordeel van loggen terwijl je alles installeert (of 'by default' alles loggen wat je op de server intikt), is dat je tijdens de installatie niet steeds het document hoeft bij te houden (tijdrovend, vervelend), maar dat evt. ook achteraf kunt schrijven en dan alles wat je ooit intikte met een nette beschrijving er in kunt zetten.

Als je dan namelijk 2 uur hebt geexperimenteerd voor het werkte, hoef je niet continu dingen in de docs te zetten die je later weer weggooid (omdat het niet werkte), terwijl de kans groot is dat je net een belangrijk detail vergeet als je 'uit je hoofd' pas achteraf dat document schrijft.

[xzenor]

Kees schreef op 22 december 2003 @ 16:29:serverside is er geen andere oplossing dan een screen starten en daar de inhoud van te loggen.

ohnee?

[message][b]##man script##[/b][/message]


NAME
script -- make typescript of terminal session

SYNOPSIS
script [-a] [-k] [-q] [-t time] [file [command ...]]

DESCRIPTION
The script utility makes a typescript of everything printed on your ter-
minal. It is useful for students who need a hardcopy record of an inter-
active session as proof of an assignment, as the typescript file can be
printed out later with lpr(1).

If the argument file is given, script saves all dialogue in file. If no
file name is given, the typescript is saved in the file typescript.

If the argument command ... is given, script will run the specified com-
mand with an optional argument vector instead of an interactive shell.

Dit is niet heel de manpage uiteraard...
maar check man script maar voor het loggen van je sessies.


Anywayz, hoe of waar je documenteerd ligt helemaal aan wat je er mee wilt doen.
Gaat het regelmatig gebruikt worden, zet het dan desnoods op een webserver. Wordt het alleen als het ECHT nodig is gebruikt (opbouw van een server doe je meestal niet dagelijks tenzij het inrichten van die dingen je werk is) dan kan je de boel ook uitprinten en in de kast mikken.
Je kan het ook op een cdtje branden natuurlijk... digitaal zoekt natuurlijk wel iets makkelijker.. maar als je het goed uitwerkt en dan uitprint zou dat op zich net zo makkelijk moeten zijn.. 'k ben zelf nogal voor uitprinten omdat ik papier gewoon een stuk prettiger vind lezen dan een beeldscherm, maar dit gaat natuurlijk niet in alle gevallen op....
sowieso zou ik al die logfiles ergens opslaan, en niet weggooien als je documentatie af is. dan heb je altijd iets om op terug te vallen.. Je kan het ook gewoon bij je documentatie stoppen maar het ligt aan je opzet of dat wel of niet handig is..

[usr-local-dick]

Nadeel is dat dit aan de clientside moet gebeuren, serverside is er geen andere oplossing dan een screen starten en daar de inhoud van te loggen. (ctrl-a-H, of een cli optie, zie man)

echt wel

[rml][ debian linux] system wide shell history *alle* users[/rml]

[usr-local-dick]

Door een brakke HD heb ik een complete nieuwe server geregeld en ben nu alles opnieuw aan het installeren. Bij een aantal paketten zit ik nu met welke opties dit ge-./configure-ed is en dat soort dingen.... om vragen te voorkomen als " hoe heb ik dat de vorige keer ook al weer gedaan?? " wil ik goede documentatie maken.

Ik gebruik een zelfgebakken script wat de hele server exclusief userdata, maar dus wel inclusief alle software, kernel, configuraties etc, inpakt tot 1 ge-encrypte, gecomprimeerde file. Die file is dan ca. 100 Mb groot.
Zie dit topic.

Maar voor servers waar ik niet al te vaak inlog, maak ik een tekstfile met daarin de belangrijkste items (passworden, ipnummer van server, router etc).
Die file encrypt je met gpg.
Ik heb laatst een vim configuratie file gevonden waarmee je transparant ge-encrypte files kan editen, hoef je ook niet zo te klooien met pgp/gpg:
http://lists.netisland.ne...lug-2001-07/msg00433.html

[pinball]

Dit is zo'n beetje het eerste wat ik op een nieuw systeem instel:

code:

root@dimple:~# cat /etc/cron.daily/gethist
#!/bin/bash
#
# verzamel .bash history regels
# altijd handig om later dat ene commando terug te vinden

BHDIR=/root/docs/bashhistory
DAG=`date +%Y%m%d`

if [ ! -d $BHDIR ]; then
    mkdir $BHDIR
fi

for i in $(ls -1 /home/ ) ; do
    if [ -f /home/$i/.bash_history ]; then
        echo "***** $DAG *****"  >>$BHDIR/$i
        cat /home/$i/.bash_history >>$BHDIR/$i
        echo >/home/$i/.bash_history
    fi
done

# root niet vergeten:
echo "***** $DAG *****" >>$BHDIR/root
cat /root/.bash_history >>$BHDIR/root
echo >/root/.bash_history

Helemaal niet bestand tegen 'tampering', maar voor mijn doeleinden (kijken hoe ik x ook al weer deed) goed zat. Is meteen een handige history, bij install van een nieuwe machine kan ik hier spieken zodat ik minder vergeet.

[x-force]

okey dit gaat allemaal over commando's die je uitvoert na de installatie van je linux distro. Maar hoe zit het met geinstalleerde paketten? Ik installeer nu veel paketten door middel van dselect, dit werkt lekker simpel en snel. Houden jullie dan nog bij WAT je installeerd? En over de hardware, schrijf je op welke hardware je in een server stopt? Dan wel voor garantie dan wel voor je zelf. Met netwerkkaarten zit ik nu altijd te klooien met welke module ik ook al weer moet laden.... Dit soort dingen doe ik via menu's en worden dus niet in de command prompt ingetypt en dus ook niet gelogd......

[pinball]

ls -al /var/log/packages/
voor een lijstje geinstalleerde pakketten,
grep -v "^#" /etc/rc.d/rc.modules
voor een lijstje met modules die geladen worden,
lspci
voor een lijstje hardware.

maw: voor dingen die zo eenvoudig te achterhalen zijn ga ik geen lijstjes bijhouden. Met een cronjob af en toe naar een andere machine laten mailen en klaar.

[Verwijderd]

Ik ga nog net een stapje verder, print sommige files uit en stop het in reeele map. Dat is dus vooral de hardware omschrijving, en netwerk adressen. Maar ik schrijf ook bepaalde dingen waar je vaak op moet letten bij installatie zoals initrd in de kernel en vim ipv vi enz. en hoe ik vreemde problemen heb opgelost. In het begin is het nog beetje rommelig, maar je wordt er vanzelf beter in.

[xzenor]

x-force schreef op 22 december 2003 @ 20:38:
okey dit gaat allemaal over commando's die je uitvoert na de installatie van je linux distro. Maar hoe zit het met geinstalleerde paketten? Ik installeer nu veel paketten door middel van dselect, dit werkt lekker simpel en snel. Houden jullie dan nog bij WAT je installeerd?

eh, ik niet nee.. Tis juist wel handig om niet alles als een kip zonder kop weer te installeren.. je merkt vanzelf wat je wel en niet nodig had.. pakketten die je nooit hebt gebruikt zal je niet missen ook..

Daarnaast heb ik FreeBSD en een pkg_info geeft mij een perfecte uitdraai van ALLE packages die ik geinstalleerd heb in de loop der tijd, dus als ik echt een lijstje wil hebben dan pak ik dat wel...

x-force schreef op 22 december 2003 @ 20:38:En over de hardware, schrijf je op welke hardware je in een server stopt? Dan wel voor garantie dan wel voor je zelf. Met netwerkkaarten zit ik nu altijd te klooien met welke module ik ook al weer moet laden.... Dit soort dingen doe ik via menu's en worden dus niet in de command prompt ingetypt en dus ook niet gelogd......

ehm.. je weet toch zelf wel wat voor hardware er in zit? ik neem aan dat je weet wat je koopt.. en anders gooi je toch ff de uitdraai van dmesg naar de printer?
En de configuratiefiles van je systeem kan je ff backuppen/uitprinten...

Dan heb je volgens mij al een vrij behoorlijk overzicht om hersenloos je systeem opnieuw te installeren.....

[usr-local-dick]

En over de hardware, schrijf je op welke hardware je in een server stopt?

Nee dat is niet belangrijk. Als je disk crasht dan kun je nog steeds zien wat voor netwerkkaart erin zit - gewoon kijken in de kast
Btw het is niet echt belangrijk ook om te weten wat voor hardware erin zit. Als het maar werkt.
Bovendien zijn mijn servers praktisch hardware onafhankelijk. Dus een systeem restoren op compleet andere hardware zou geen probleem moeten zijn.
Binnen bepaalde grenzen natuurlijk (amd <-> i686 gaat niet booten etc)

[pierre-oord]

Ik sla, als beginneling, alle dingen die ik doe voor een deel op; met welke commando's in iets installeer (met ./configure blaat) en bewaar m'n zorgvuldig gemaakte config files snel op een andere PC. Daar zet ik met commentaar gewoon van alles bij.

edit:
als formaat: HTML; kun je het op inet zetten en kan iedereen ervan genieten

[ Voor 18% gewijzigd door pierre-oord op 23-12-2003 22:32 ]

[Verwijderd]

ik documenteer gewoon helemaal niks.

wel maak ik regelmatig backups, en ik heb nog andere pc's, waar ik af en toe eens een andere distro op installeer, zodat ik de meest elementaire dingen wel in mijn hoofd heb gedocumenteerd...

[xzenor]

Ja dat doe ik voor thuis ook over het algemeen.. (niet bij alles, sommige dingen print ik wel ff uit voor de zekerheid) maar binnen een bedrijf moet je wel een redelijke documentatie hebben van dingen. Als je eens heftig door je rug gaat ofzo (om maar ff wat te noemen) en 3 maanden thuis ligt dan moet wel iemand het enigszins van je over kunnen nemen.... Heb je niks gedocumenteerd dan krijg je dat echt wel op je brood als je eenmaal weer terug bent

[Verwijderd]

De linux kernel config (/boot/config-`uname -r`) is ook altijd handig om te archiveren.... (vooral met niet standaard hardware, zoals telefoon (!= modem), watchdog, dvb, etc.)

[ Voor 1% gewijzigd door Verwijderd op 24-12-2003 17:32 . Reden: syntax errrror ]

[silentsnake]

Tja ik hoef zelf niet echt documentatie te schrijven aangezien ik hier een FreeBSD boek van 900 pagina's heb liggen, en ik heb ook altijd nog het FreeBSD handbook dat op het net staat. Het enige dat ik zelf gedocumenteerd heb is sudo reboot Internet wil er nog wel eens uitknallen en als ik dan niet thuis ben kan ik me arme pa toch niet op FreeBSD loslaten, aangezien ie al moeite heeft met XP