Skip to content

Latest commit

Β 

History

79 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

sysop64

License GitHub stars GitHub forks Release Downloads


πŸ“Œ Overview

SysOp64 is a collection of curated and opinionated single-task scripts for systems administration and operation.

It serves as a ready-to-run knowledge base to save the time and effort invested in determining the right execution sequence and command line parameters for operational tasks, regardless of their complexity or frequency.


πŸ“¦ Installation

SysOp64 can be installed using the Installer64 tool:

curl -sL https://raw.githubusercontent.com/automation64/installer64/main/src/bootstrap | sh
sudo /opt/inst64/install-sysop64

πŸš€ Usage

# List modules
q m
# List module tasks
q t <MODULE>
# Run module task
q r <MODULE> <TASK> [TASK_PARAMETERS]
# Show help
q h

πŸ—οΈ Architecture

Task Naming convention

Scripts

  • Template: MODULE-[OBJECT-]ACTION[-ATTRIBUTE]
  • Format: [a-z0-9-]+
  • Fields
    • MODULE: module name. For example: docker
    • OBJECT: optional. Object module. For example: image
    • ACTION: what the task will do. Use standard verbs defined below
    • ATTRIBUTE: optional. Scope of the action

Actions

  • change: modify existing component attributes or content

  • check: run component health-checking

  • cleanup: remove temporary content

  • debug: debug component

  • dump: show component content as-is

  • edit: edit content, using interactive text editor

  • generate: generate content based on template and optional parameters

  • guide: show technical documentation about the module or task

  • init: initialize component content

  • list: generate a simple list of components or attributes

  • login: login to service

  • migrate: migrate component or content

  • query: query component or content using query lang

  • monitor: show component runtime metrics

  • rename: rename component

  • repair: fix a broken component

  • reset: reset component or content to initial or empty value

  • restart: restart component

  • rollback: revert component to a previous state

  • run: run service

  • scan: scan component

  • search: search component content without query lang

  • setup: setup component

  • simulate: simulate service execution. The service will not run nor modify anything

  • show: show component details

  • status: show component status

  • sync: synchronize component or content against another component or content

  • test: test component

  • trace: trace component (detailed debug)

  • watch: continuously monitor component for changes in realtime

  • update: update component status or content

  • upgrade: upgrade component

  • add / delete: add or delete element to/from component

  • attach / detach: attach or detach component

  • backup / restore: backup or restore content

  • create / destroy: create or destroy (no undo) component

  • enable / disable: enable or disable component

  • expand / shrink: expand or shrink component size

  • get / put: get or put object from/to component

  • grant / revoke: grant or revoke component access permission

  • import / export: import or export component or content

  • login / logout: login to or logout from service

  • open / close: open or close an object

  • push / pull: push or pull content from stack

  • read / write: read or write content

  • send / receive: send or receive content over the network

  • set / unset: set new or unset component attribute value

  • start / stop: start or stop component

Global Variables

  • S64_<MODULE>_ABOUT_MODULE: module brief description
  • S64_<MODULE>_ABOUT_SUBMODULE_<NAME>: generic tag-value pair
  • S64_<MODULE>_CFG_<NAME>: command configuration setting
  • S64_<MODULE>_CMD_<NAME>: full path to command
  • S64_<MODULE>_FILE_<NAME>: file or directory name, without any path
  • S64_<MODULE>_PATH_<NAME>: full path to file or directory
  • S64_<MODULE>_SET_<NAME>: command line option
  • S64_<MODULE>_TAG_<NAME>: generic tag-value pair
  • S64_<MODULE>_VERSION: module version

πŸ›  Contributing

Contributions are welcome! Help us improve by submitting issues, feature requests, or pull requests.


⚠️ Disclaimer

This repository is provided "as is" without any warranties. The author is not responsible for any damages or issues arising from its use. Additionally, this project is not affiliated with or endorsed by any organization or entity. Use at your own risk.


πŸ“œ License

SysOp64 is licensed under the Apache-2.0 License.


πŸ‘€ Author


🌟 If you find this project useful, consider giving it a star! ⭐

About

πŸš€ SysOp64 is a collection of Unix/Linux Systems Operations scripts

Topics

Resources

Code of conduct

Stars

10 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages