Skip to content

Latest commit

 

History

History
134 lines (91 loc) · 4.05 KB

index.md

File metadata and controls

134 lines (91 loc) · 4.05 KB
layout title has_children
default
OpenAF docs
true

OpenAF

OpenAF (pronounced open-a-f) is a Java & Javascript based "swiss-army knife" scripting DevOps tool for different automation challenges with minimal requirements and footprint, extensible through packages (oPacks) and with easy code orchestration (oJob and oJob.io).

Topics

  • Quick start - getting you quickly writing and executing OpenAF scripts
  • Concepts - understand some of the basic concepts
  • How to - core functionality exemplified.
  • Guides - guides with example code from beginner to advanced topics.

Installing/Setup

Docker

docker run --pull always --rm -ti openaf/oaf
# ./oafc

Single file download

Download the specific file for your OS and architecture (see below for Windows):

OS Architecture Link
Linux x86_64 (Intel) openaf.io/oaf-linux-x86_64
Linux aarch64 (Arm) openaf.io/oaf-linux-aarch64
Alpine Linux x86_64 (Intel) openaf.io/oaf-alpine-x86_64
Alpine Linux aarch64 (Arm) openaf.io/oaf-alpine-aarch64
Mac x64_64 (Intel) openaf.io/oaf-mac-x86_64
Mac aarch64 (Apple Silicon) openaf.io/oaf-mac-aarch64

After downloading the file, execute:

chmod u+x oaf-*
./oaf-*
# Please use the created symlinks: oaf, ojob, opack, oafc, oafp, oaf-sb or ojob-sb
# ./oafc

This will provide it with execution permissons and, afterwards, simply execute it.

For a more permanent or portable install follow the next instructions.

Windows

C:\> mkdir oaf
C:\> cd oaf
C:\oaf> curl https://openaf.io/install.bat -o install.bat
C:\oaf> install.bat
C:\oaf> oafc

Linux

# With sudo
curl https://openaf.io/install.sh | sh
# oafc

# Without sudo
curl https://openaf.io/setup.sh | sh && cd oaf
# ./oafc

# With an existing java JRE/JDK >= 8
curl https://ojob.io/get.sh | sh && cd oaf
# ./oafc

If you don't have sudo, curl or wget but you do have bash you can just execute the following command or follow these instructions:

# With just bash
/bin/bash -c "exec 3<>/dev/tcp/ojob.io/80 && echo -e \"GET /get.sh HTTP/1.1\nHost: ojob.io\nUser-Agent: curl\nConnection: close\n\n\" >&3 && cat <&3" | sed '1,/connection: close/d' | tail -n +2 | sh -s

Mac OS

curl -o setup.sh https://openaf.io/setup.sh && sh setup.sh && rm setup.sh && mv oaf /Applications/OpenAF && sudo sh -c "echo "/Applications/OpenAF" > /etc/paths.d/OpenAF"
# oafc

Move to a different folder

If you used "install.sh": After moving to the new folder execute the reinstall.sh (or reinstall.bat in Windows) created after the first installation.

If you used "setup.sh": Simple move the folder.

Upgrade

After installing an update.sh (or update.bat in Windows) will be created. Simply execute it.

Uninstall

Linux

sudo ojob ojob.io/oaf/symlinks UNINSTALL=true && sudo rm -rf /opt/oaf

Mac OS

rm -rf /Applications/OpenAF && sudo rm /etc/paths/OpenAF && rm ~/.openaf*

Windows

Simply delete the created folder ([current folder]/oaf or c:\oaf)

There might be also ".openaf*" files created on your home folder (c:\users\[your user]\.openaf*)

Specific installs

Follow the link for specific architectures installations.

Nightly build

If you want to install the nightly build follow these instructions.

Older versions

To install older versions please follow these instructions. You can also check the GitHub releases list