Difference between revisions of "HZW Documentation"
(→Guides) |
|||
(10 intermediate revisions by 2 users not shown) | |||
Line 7: | Line 7: | ||
− | + | =Organizational Documentation= | |
− | + | ==Chat== | |
Our primary tool for communication and coordination is [https://matrix.org/ matrix]. | Our primary tool for communication and coordination is [https://matrix.org/ matrix]. | ||
Line 27: | Line 27: | ||
<br /></blockquote> | <br /></blockquote> | ||
− | + | ==Video Conferences== | |
For means of faster communication and collaborative working we use our [https://wiki.kabelsalat.it/index.php?title=HZW_Services#Video_Conferencing video conferencing solutions], if needed. | For means of faster communication and collaborative working we use our [https://wiki.kabelsalat.it/index.php?title=HZW_Services#Video_Conferencing video conferencing solutions], if needed. | ||
Line 34: | Line 34: | ||
<br /> | <br /> | ||
− | + | ==Coordinate projects== | |
We use kanboard to plan, coordinate and track almost all of our activities. | We use kanboard to plan, coordinate and track almost all of our activities. | ||
Line 48: | Line 48: | ||
− | + | =Technical Documentation= | |
− | + | ==Our Root Server== | |
We are unsing a Root Server hosted at Strato. | We are unsing a Root Server hosted at Strato. | ||
Line 57: | Line 57: | ||
<br /> | <br /> | ||
− | == | + | ==Monitoring== |
− | + | We are using Grafana as a Monitoring solution. | |
− | ===Netbox | + | See the [[HZW Monitoring|HZW Mointoring article]] (german) for details.<br /> |
− | We are using [https://netbox.kabelsalat.it Netbox] to document all physical and Logical Resources like Servers, IPs, Networks, Services, VLANs etc. | + | |
− | + | ==Virtual Machines== | |
+ | All virtual Machines providing services (e.g. not for testing purposes) should run a linux operating system and have had the [[HZW Ansible|basic ansible playbook]] run on them. | ||
+ | |||
+ | We currently support the following OS'es: | ||
+ | |||
+ | - debian | ||
+ | |||
+ | - opensuse | ||
+ | |||
+ | ==Containers== | ||
+ | In an attempt to more efficiently utalize the ressources of our server, we are going to deploy services using [[wikipedia:Docker_(software)|docker]]. | ||
+ | |||
+ | All docker hosted services need to be launched using docker-compose. | ||
+ | |||
+ | How-to static IPs in containers: [[How to container with static IP]] | ||
+ | |||
+ | ==Netbox== | ||
+ | [[File:Netbox.png|thumb|Netbox]]We are using [https://netbox.kabelsalat.it Netbox] to document all physical and Logical Resources like Servers, IPs, Networks, Services, VLANs etc. | ||
[[HZW Netbox|What is Netbox?]] | [[HZW Netbox|What is Netbox?]] | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | <br /> | ||
+ | |||
+ | ==LDAP== | ||
+ | [[File:Phpldapadmin.png|thumb|phpLDAPadmin]] | ||
+ | Some of our services are LDAP integrated, the nextcloud at nc.kabelsalat.it for example. | ||
+ | |||
+ | Our LDAP Server is based on FreeIPA and configurable via VPN at [http://192.168.122.116 http://192.168.122.116/phpopenldap] | ||
+ | |||
+ | The admin credentials are in the shared keepass. | ||
+ | |||
+ | Official Documentation of the tool: [http://phpldapadmin.sourceforge.net/wiki/index.php/Main_Page phpldapadmin documentation] | ||
+ | |||
+ | |||
+ | The use is quite self explanatory, at least for the common tasks like adding users or managing group memberships. | ||
+ | |||
+ | |||
+ | You can also use the openldaptools and .ldif files to modify the ldap database. | ||
+ | |||
+ | See: [[Openldap#Werkzeuge]] | ||
+ | |||
+ | Or you can use the Linux Software [https://directory.apache.org/ Apache Directory]. | ||
+ | |||
+ | If you do, please document how to use it here. | ||
+ | |||
+ | |||
<br /> | <br /> | ||
+ | |||
+ | ==Shared Keepass== | ||
+ | Ask one of the admins to share the keepass file with you. | ||
+ | |||
+ | In Keepass access the file via: File > Open > URL | ||
+ | |||
+ | The URL Schema is: <nowiki>https://begleitschafe.berlin/remote.php/dav/files/</nowiki><USERNAME>/hzw/hzw.kdbx | ||
+ | |||
+ | |||
==Guides== | ==Guides== | ||
Guide to documenting with Mediawiki | Guide to documenting with Mediawiki | ||
Line 74: | Line 130: | ||
[[How to document in Netbox|Guide to documenting with Netbox]] | [[How to document in Netbox|Guide to documenting with Netbox]] | ||
− | Also you might want to check | + | Also you might want to check [[:Category:HowTo|Category:HowTo]] for interesting how2's |
Latest revision as of 13:49, 31 January 2024
The documentation of all things HZW has the following philosophy:
- General information, processes, methods and how-to's get documented in this Wiki
- Physical and Logical Resources like Servers, IPs, Networks, Services, VLANs etc. get documented in Netbox
- Projects and changes get tracked using Kanboard
Contents
Organizational Documentation
Chat
Our primary tool for communication and coordination is matrix.
To join our matrix server matrix.kabelsalat.it you need a matrix client like riot.
On this Matrix server, there is the "hzw admins" channel.
Plase report there and ask if it's ok If you make changes that have an impact.
Example:
"Hey guys, did $Something at the Database server. Can I reboot it to test it's reboot persistency?"
Answer: "No! $Important-thingy does $important-thing and cannot be disrupted right now! Wait one more hour please!"
Video Conferences
For means of faster communication and collaborative working we use our video conferencing solutions, if needed.
There are no regular hzw meetings. We get together when the need arises.
Coordinate projects
We use kanboard to plan, coordinate and track almost all of our activities.
Please open a ticket in our Kanban Board "team_hzw" if you want to:
- report a bug
- request a change
- think I would be cool to have $thing (even if you don't want to spend time implementing it or don't know how to do it)
Technical Documentation
Our Root Server
We are unsing a Root Server hosted at Strato.
See HZW Root Server for details.
Monitoring
We are using Grafana as a Monitoring solution.
See the HZW Mointoring article (german) for details.
Virtual Machines
All virtual Machines providing services (e.g. not for testing purposes) should run a linux operating system and have had the basic ansible playbook run on them.
We currently support the following OS'es:
- debian
- opensuse
Containers
In an attempt to more efficiently utalize the ressources of our server, we are going to deploy services using docker.
All docker hosted services need to be launched using docker-compose.
How-to static IPs in containers: How to container with static IP
Netbox
We are using Netbox to document all physical and Logical Resources like Servers, IPs, Networks, Services, VLANs etc.
LDAP
Some of our services are LDAP integrated, the nextcloud at nc.kabelsalat.it for example.
Our LDAP Server is based on FreeIPA and configurable via VPN at http://192.168.122.116/phpopenldap
The admin credentials are in the shared keepass.
Official Documentation of the tool: phpldapadmin documentation
The use is quite self explanatory, at least for the common tasks like adding users or managing group memberships.
You can also use the openldaptools and .ldif files to modify the ldap database.
See: Openldap#Werkzeuge
Or you can use the Linux Software Apache Directory.
If you do, please document how to use it here.
Ask one of the admins to share the keepass file with you.
In Keepass access the file via: File > Open > URL
The URL Schema is: https://begleitschafe.berlin/remote.php/dav/files/<USERNAME>/hzw/hzw.kdbx
Guides
Guide to documenting with Mediawiki
Guide to documenting with Kanboard
Guide to documenting with Netbox
Also you might want to check Category:HowTo for interesting how2's