octahe

0.0.4

Evolve your application by devolving the stack.
peznauts/octahe.swift

What's New

Octahe 0.0.4

2020-08-02T20:05:18Z

Octahe is free from the tyranny of libraries

packaged

Octahe no longer requires system packages to build. This was accomplished through leveraging better dependencies, and choosing to use apple supported resources instead of community ones. This means the redistributable binaries, and the provided DMG package, are able to install Octahe without secondary development libraries on macOS client machines.

Sub-sub-note

Linux still requires libraries be installed to build, only MacOS has been liberated at this time.

Octahe

License Twitter Octahe build

(O)ctahe

Octahe allows you to simplify operations, create concise applications, and focus on what you do best.

What is Octahe?

Octahe is a deployment tool which uses the Containerfile as DSL for deploying software via SSH, Local or Serial connections.

Why should you consider using Octahe?

The Containerfile DSL is simple, only consisting of 16 different verbs. This means solutions run through Octahe are inherently easy to understand and test.

With Octahe, deployers and operators can test solutions in Containers and easily push to Baremetal, Virtual machines, or even containerized targets; all without having to change configurations formats.

Octahe has the ability to natively proxy through multiple targets using sockets. This capability allows deployers to flatten their approach to deployments, all without needing to compromise infrastructure or craft obscure deployment schemes.

Multi-key, multi-bastion, multi-user, multi-server, multi-target deployments all made simple.

Octahe uses simple multi-processing which leverages native swift queues of Operations. This built-in abstraction provides Octahe the ability to ensure consistent deployments across multiple hosts, using complex dependencies, all without troubling the user. From 1 machine to 1000, Octahe will get a solution deployed quickly and consistently, without compromise.

The ability to develop in containers, the power to push high performance solutions down to metal.

Evolve your application by devolving the stack.

Whether you're deploying software to the cloud, building high-performance computing environments, or IOT applications, Octahe has it covered. The Zero footprint design employed by Octahe will get you up and running in as little as one step.

Test in containers, Deploy TO production.

While containers are fantastic tools, they can be limiting, they can create application complexities, and they do create bottlenecks. Octahe aims to enable teams to deploy applications into stateful Targets, using the simplicity of Containerfile(s), without any of the machinery that comes alone with containers.

Configuration

The Octahe follows the Dockerfile reference with one new verb, TO. This new verb can be expressed on the CLI or within a provided container file.

Target options

When deploying TO a target Octahe provides options by supporting options that span SSH, localhost, and Serial.

Installation

Building Octahe is simple, however, if you already have swift-lang installed on your system, you can simply skip this part and download one of the prebuild binaries from the releases.

Building Octahe

Octahe dependencies on macOS

In order to build Octahe on macOS you will need OSX 10.15 or better. You will also need XCode installed and updated to the latest stable release.

Octahe dependencies on CentOS 8

Install EPEL.

dnf -y install epel-release openssl-devel

Install swift-lang.

dnf -y install swift-lang

Building the Octahe binary

With swift 5.2+ installed, simply clone this repository, change directory to the checkout, and run the following command.

swift build \
      --configuration release \
      --jobs 4 \
      -Xswiftc \
      -g

Once complete, the application will be built, and available in the release build location, .build/release/octahe. To make Octahe available system wide, copy it into a ${PATH} directory, useually something like /usr/local/bin.

Deploying Octahe in Containers

Octahe can also be deployed using container native tooling, such as podman or docker.

podman build -t octahe.HEAD -f .buildcontainer/Containerfile

Once the container image has been created, you can build applications around Octahe or run commands through the default container image runtime.

podman run -it localhost/octahe.HEAD octahe

Octahe deploying Octahe

Because Octahe can read Containerfiles and deploy applications to targets, Octahe can be used to deploy itself using the provided in tree Containerfile. Assuming Octahe is installed on the local machine the following command can be used to deploy the application to remote hosts.

octahe -k ~/.ssh/id_rsa -t ${USER}@${SERVER}:22 -k ~/.ssh/id_rsa Containerfile

Running functional tests

A Containerfile has been provided which exercises functional tests for Octahe.

# Deploy
octahe -k ~/.ssh/id_rsa -t ${USER}@${SERVER}:22 .testcontainer/Targetfile.local

# Undeploy
octahe undeploy -k ~/.ssh/id_rsa -t ${USER}@${SERVER}:22 .testcontainer/Targetfile.local

Usage

The CLI interactions are familiar and simple.

octahe -k ~/.ssh/id_rsa ~/Targetfile

The console output is simple, and easy to follow.

Beginning deployment execution
✔ Step 0/3 : COPY index.html /opt/index.html
✔ Step 1/3 : EXPOSE 7000
✔ Step 2/3 : WORKDIR /opt
✔ Step 3/3 : ENTRYPOINT python3 -m http.server 7000

Here's the application being deployed to 5 remote Targets in realtime.

octahe-run

Real World Demo

Checkout the demo repo, highlighting how Octahe can be used in a more real world situation.


More documentation and examples can be found here.

Description

  • Swift Tools 5.2.0

Dependencies

Last updated: Sat Aug 15 2020 14:22:33 GMT-0500 (GMT-05:00)