Documentation

Documentation

This is the soon-to-be documentation site for how to engage with your own VM at WHY. But first we need to write the documentation.

Who writes documentation anyway, and who reads it. We are YOLO so docs are overrated.

Stay tuned. Here is a nice syntax highlighted piece of sh Go code to get some vibes going.

Requesting vm’s

This page gives an introduction on how to request vm’s and what the possibilities are.

tl;dr

/msg yolocation[m] new /msg yolocation[m] help

Where to find us

You can find me on the following channels on the OFTC irc server:

I’m also on discord (soon).

Simply start a chat with me yolocation[m] to request vm’s! See Quickstart for more information on getting started.

Structure

To give commands to me simply send me a direct message and start with a command like help. When no direct message channel is available you can send a direct message from any place on the OFTC irc server by prefixing the command with /msg yolocation[m]. The whole message then becomes /msg yolocation[m] help. Reactions from the bot should open an direct message channel depending on the used client.

Giving commands in channels with more than 2 users (public channels) requires the !vm prefix. Commands than become !vm help.

Commands

There are several basic commands implemented to control the lifecycle of your requested vm’s.

  • new (requests a new vm)
  • destroy (request to destroy a vm by name or all, not available on irc)
  • list (lists deployed vm’s)
  • templates (lists all requestable templates)
  • help (prints the help)

For example to request a new ubuntu 2204 server the message becomes new ubuntu 2204.

The commands are created to require as little info as possible and sane defaults will be chosen.

If no server type is specified the result will be a rocky linux 9. The following other operating system versions are available:

The username of the user that requested the virtual machine is used as the user logon name.

All servers are accesible via ssh, the windows servers also still support RDP. Default ports are used for all services.

When a VM has been provisioned the requester receives a vm name, ip-adress to connect to the vm, username and password.

Options

A few options are implemented when requesting a new VM like the ammount of vCPU’s, Memory and diskspace.

To request a new alma 10 server with more vCPU and Memory than the default the message becomes:

new alma 10 --vcpu=8 --memory=16

Or with asdditional storage:

new alma 10 --disksize=50

All additional options are distinguished with the -- prefix, and can be mixed and matched.

Absolute limits per VM are:

  • vCPU: 8
  • Memory: 16 GiB
  • Diskspace: 250 GiB

To get more detailed output about the choices being made, the optional command --verbose can be added.

Anything else

If you need anything else please visit us at the yolocation village, reach out to the team on #yolocation or /msg GraPghaST panic mode on OFTC irc server.

Quick Start