cheatsheet.txt 10.6 KB
Newer Older
Johannes Kiesel's avatar
Cleanup  
Johannes Kiesel committed
1 2
WEBIS CHEATSHEET
================
3

4 5 6
archiveuser               Archive one or all user account(s) on a standard Webis machine.
    all                       Utility Tool to archive all user accounts on a standard webis machine...
    singleuser                Utility Tool to archive a single user account on a standard webis machine.
7

8 9 10 11 12 13 14 15 16 17
betamng                   Low level scripts for managing Betaweb.
    activate-vnc-all          Activate vnc on all nodes of the hostlist...
    bios-cpu-test-all         Starts bios cpu test on all nodes of the hostlist...
    change-lcd-msg-all        Change lcd message of every node of betaweb to betaweb???...
    check-dimms               Check for warnings concerning RAM modules in idrac for all betaweb machines...
    clear-idrac-log           Clear event log of idrac.
    do-all                    Run a command sequential on all betamng nodes...
    enable-pxe-bios-boot-all  Enable pxe bios boot on all hosts: experimental! hope and prey...
    get-bios-boot-settings-all Get boot settings from all nodes...
    get-idrac-log             Printout event log of idrac.
Alban Bruder's avatar
Alban Bruder committed
18
    pssh                      Run a command parallel on all betamng nodes...
19 20 21 22 23 24
    read-all-macs             Printout system dump of all hosts for extracting mac addresses...
    set-critical-temp-shutdown Set settings for shutdown on critical temperature...
    ssh                       Open ssh session to one of the betamng nodes (racadm can be used)...
    start-all                 Start every node of betamng (parallel)...
    status-all                Get power status of every node of betamng...
    stop-all                  Shutdown every node of betamng...
Alban Bruder's avatar
Alban Bruder committed
25
    upload-tls-cert           Upload TLS certificate chain and private key to iDrac.
26
    vnc                       Open vnc session to one of the betamng nodes...
27

28 29 30
betaweb                   High level scripts for betaweb, e.g., Hadoop management.
    check-ram                 
    htop                      Show system load of all betaweb nodes using clusterssh and htop.
Alban Bruder's avatar
Alban Bruder committed
31 32
    idrac-dimms               Get status of dimms from idrac.
    idrac-disks               Get status of physical hard drives from idrac.
33 34 35 36 37 38
    restart-hadoop-resourcemanager Restart hadoop ressource manager on betaweb020 and restarts nodemanager
    rolling-restart           Restart betaweb nodes one after another.
    rolling-state             Apply Salt state on nodes one after another.
    ssh                       SSH into all betaweb nodes using clusterssh.
    status                    Get status of betaweb via salt...

39 40 41 42 43 44 45 46 47
ceph                      Helper scripts for working with the Webis CephFS.
    fs                        CephFS mounting
        snapshot                  Create a snapshot in PATH.
        snapshot-list             List snapshots that include PATH.
        snapshot-restore          Restore PATH from snapshot.
        mount                     Mount CephFS in read-only mode to the default directory.
        mount-rw                  Mount CephFS in read-write mode to the default directory.
        umount                    Mount CephFS in read-write mode to the default directory.

Johannes Kiesel's avatar
Johannes Kiesel committed
48 49 50
    osd                       Ceph OSD tools.
        analyze-bench             Analyze `ceph tell 'osd.*' bench` output.

Alban Bruder's avatar
Alban Bruder committed
51

52
core                      Core utilities for installing and updating the Webis command.
53 54 55 56 57 58 59
    install                   Install Webis command to PATH.
    remove                    Remove Webis command from PATH.
    update                    Update Webis command from Git.
    update-deps               Update Webis command dependencies.
    update-cheatsheet         Update local copy of code-webis-cmd/cheatsheet.txt.
    check-style               Check coding style of project.

60
cvs                       Helper scripts for working with the Webis CVS server.
61 62 63 64
    onboard                   Create a new user on the webis virtual machine (webis VM).
    status                    Checks what changed in this CVS directory without doing anything.
    update                    Update this CVS directory, deleting directories that were deleted on the server.

Alban Bruder's avatar
Alban Bruder committed
65 66 67
deltaweb                  High level scripts for deltaweb.
    idrac-events              Collect iDRAC event logs

Johannes Kiesel's avatar
Johannes Kiesel committed
68 69 70 71 72
exams                     Commands for generating exam variants and importing into Moodle.
    compile-variants          Compile variants of a LaTeX frame file using variables define in a list.
    generate-variants         Generate a variant-list-file, where each student in the...
    insert-moodle             Update a Moodle backup file with individual students' exam variants.

73
git                       Helper scripts for working with the Webis Git server and GitLab instance.
74
    clone-deps                Clone dependencies for current project from GitLab.
75
    clone-groups              Clone GROUPS from the Webis Gitlab at once to the current working directory.
76 77 78 79 80
    cvs                       CVS-to-Git migration tools.
        cvs2git                   Import all CVS modules into new Git repositories and push them to GitLab.
        cvstree2git               Try to clone all projects in the current CVS tree from Git.
        s2git                     Import a CVS module into a new Git repository and push.

Michael Völske's avatar
Michael Völske committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
    deactivate-unused-accounts Deactivate Gitlab accounts that haven't had any activity for a long time.
    fix-names                 Fix names of BUW AD users.
    gitlab                    Gitlab commandline interface that comes with python-gitlab.
    init                      Initialize GitLab API client.
    last-commit               Get the last commit date of one or more repositories.
    list-groups               List all gitlab groups.
    onboard                   Set up the correct Gitlab group permissions for a new student, Hiwi or external researcher.
    update-project            Clone or update the given Git project from GitLab.
    web-admin                 Display a web-admin view for Gitlab (need to have a token with admin access).

k8s                       Kubernetes tools.
    connect-test-cluster      Connect kubectl to the testing cluster.
    get-namespace-permissions Gets for each namespace the users/groups that are allowed to use it
    login                     Set up OpenID authentication for kubernetes access.
    setup-user-namespaces     Set up k8s access per gitlab groups.
    spark                     Run Spark tasks on Kubernetes.
        shell                     Start Spark Shell.
        pyshell                   Start PySpark Shell.
        submit                    Submit Spark application.
        sql                       Run Spark SQL.


latex                     LaTeX utilities.
    reformat-bib              Reformat BibTeX files.

pki                       Webis TLS PKI Tools.
    cert                      Manage VPN client, server, and ICA certificates.
        issue                     Issue a new certificate.
        revoke                    Revoke a certificate.


util                      General helper tools and utilities.
    adduser                   Creates a user on a remote system.
    authorized-ssh-keys       Collect all SSH keys in use across salt minions' user accounts.
    backup-btrfs-vol          Take a snapshot of a btrfs subvolume and back up its contents to another location.
    find-accounts             Find accounts on salt minions.
    letsencrypt               Letsencrypt DNS challenge helper.
        retrieve-cert             Retrieve (wildcard) cert for a webis.de subdomain using the dns-01 challenge.

    list-buw-dns              List all assigned Webis host names / IP addresses at BUW.
    login                     Get user name for a university login.
    mturk-manager-frontend    Start the MTurk manager frontend on your machine.
    parallel-idrac            Execute idrac command in parallel across multiple hosts.
    patch-jar                 Add files from one jar to another.
    read-from-clipboard       Print the clipboard to standard output.
    reset-workstation         Reset workstation and reinstall Ubuntu.
    reset-ws                  Commands to reset a workstation.
        info                      Print info
        local                     Reset a workstation local
        remote                    Reset a workstation remotly

    salt-restart              Restart a salt minion on a targeted machine.
    sshproxy                  Set up an SSH proxy tunnel for accessing digital library content or university-restricted URLs.
        help                      Display installation and setup instructions.
        install                   Install the packages required by sshproxy (works only on Ubuntu and Debian-based systems).
        run                       Run the proxy.

    tasks                     Execute lists of tasks in parallel.
        help                      Print usage instructions.
        reload                    Reload the tasks_file.
        stop                      Let running processes fail and exit.
        work                      Start *one* worker process in the background (use multiple times for multi-threading).

    webis-web-permissions     Find files with missing group write permission on gonzo.
    write-to-clipboard        Fill the clipboard from standard input.

webis20                   Storage Management Scripts, need direct access to RAID Controller and MegaCLI installed.
    lsi                       MegaCLI script to configure and monitor LSI raid cards.

yk                        YubiKey 2FA utilities.
    setup                     YubiKey setup helpers.
        card-status               Check smartcard status and print stored information.
        set-pin                   Change smartcard PIN.
        edit-card-info            Edit stored cardholder info.
        gen-master                Create a new PGP master key.
        add-subkeys               Create PGP subkeys and add them to the master key.
        key-to-card               Transfer PGP key to smartcard.
        fetch-pubkey              Fetch and trust public key from URL stored on the card.
        print-secret-key          Print secret key associated with the smartcard.
        print-pubkey              Print public key associated with the smartcard.
        send-pubkey               Send public key to key server.

    ssh                       SSH 2FA utilities for OpenPGP-compatible smartcards.
        print-pubkey              Print SSH-compatible public key of connected smartcard.
        connect-agent             Connect the SSH agent to the GPG agent socket.


168 169

---
Johannes Kiesel's avatar
Cleanup  
Johannes Kiesel committed
170
Generated using *webis core update-cheatsheet*. If you find this file to be outdated, rerun this command and push the updated file to the Git server.