Sign Up/Install

Use our free Cloud sandbox, or install the Open Source Docker Image

To get up and running on your unSkript journey quickly, we've created two options:

  1. A local install using the the open source Docker image.

  2. A free sandboxed version of our Cloud product.

unSkript is an open source project. We love PRs, stars and more - checkout our GitHub.

Docker:

The fastest way to get the open source version of unSkript running is via our Docker container.

With Docker, you can get up and running in two steps (and just one if you already have Docker up and running!)

  1. Clone out GitHub Repository (In this case we are installing in $HOME.)

    cd $HOME
    git clone https://github.com/unskript/Awesome-CloudOps-Automation 
    cd Awesome-CloudOps-Automation
  2. In the terminal, run the following command (if you installed the GitHub in a different location - change line 2 appropriately):

    docker run -it -p 8888:8888 \
     -v $HOME/Awesome-CloudOps-Automation/custom:/data \
     -v $HOME/.unskript:/unskript \
     -e ACA_AWESOME_MODE=1 \
     --user root \
     docker.io/unskript/awesome-runbooks:latest

Your installation will be available to use at:

http://127.0.0.1:8888/awesome

Note: the -e ACA_AWESOME_MODE=1 allows for syncing data between docker and your local machine, and the two -v commands indicate where the data (RunBooks and Actions) and unskript (credentials) will be stored.

Omitting these three lines will result in a "read-only" version of unSkript.

Kubernetes:

Here are the steps to launch the unSkript Docker image in k8s:

  • Deploy using the following command (the Yaml file is in our GitHub repository)

kubectl apply -f unskript-oss-k8s-deployment.yaml
  • To access the jupyter server, you will have to enable port-forwarding using

kubectl port-forward <pod corresponding to this deployment> -n <k8s namespace> 8888:8888&

You can read more about how to configure unSkript on the GitHub README page.

Last updated