With the CLI

The oak-cli#

CLI Setup#

Any machine where you have installed at least one Oakestra component already has the CLI installed. If you want to install the CLI on an external machine and manage your Oakestra deployment from there, follow these commands:

curl -sfL oakestra.io/oak.sh | bash

irm oakestra.io/oak.ps1 | iex

Execute oak -h and you will be welcomed into the Oakestra CLI world 🌎

Finally, you can configure the IP of your Oakestra Root Orchestrator:

oak config set root_orchestrator_address <IP OF YOUR ROOT ORCHESTRATOR>

For further information about the CLI configuration, see the CLI Configuration Manuals.

Deploying Your First Application Using the CLI#

Deploying your first app with the CLI is simple. The Oak CLI already provides three default application descriptors that you can use right away.

Step 1: Create your default application.

oak app create

The CLI will ask you which example you want to deploy:

• [1] blank_app_without_services.json
• [2] default_app_with_services.json
• [3] edge_gaming.json

oak service deploy --all

oak service deploy --all

Basic CLI Usage#

The root command for the CLI is oak

Working with deployment descriptors#

Oakestra apps and services are described in deployment descriptor files called SLA.
The oak-cli comes with a set of pre-defined default SLAs inside the folder ~/oak_cli/SLAs.
All available SLAs can be inspected via the oak application sla command.

Your personal SLA files describing your applications can be stored in any folder in your machine.

Managing Applications#

Now that you are familiar with the SLAs we can start creating applications based on them.

• Run oak application show (oak a s) to see the currently registered applications.
  
• The oak application create (oak a c) command asks you what SLA from the predefined ones should be used as the blueprint for the new application and creates that app for you.
  
• The oak application create [file] (oak a c [file]) allows you to specify a custom SLA file to be used for the creation of an application and its services. E.g. oak a c mysla.json, assuming we have a local SLA called mysla.json
• Delete one or all currently running apps via oak application delete (oak a d).

Deploying Services#

The services of our applications are not yet deployed.
To deploy instances of these services we need to know the service IDs.
The IDs are visible when running oak service show (oak s s).
Click on your desired Service ID value in the Service ID column and copy it via Ctrl+C.
To deploy a new instance run oak service deploy <SERVICE_ID|SERVICE_NAME>.

You can undeploy all instances of a service or only specific ones by providing the appropriate command option:
oak service undeploy <service-id|name> [instance-number].

Inspecting Services#

Using oak service inspect <SERVICE_ID|SERVICE_NAME> [instance number] you can either check the status of all the instances of a service or a specific instance if you provide the instance number. From here you can inspect the details of an instance, such as the worker where it is deployed, the detailed status explanation or failures reasons.

Using oak service logs <SERVICE_ID|SERVICE_NAME> <instance number> you can check the logs of a running instance.

Scaling up and down multiple instances#

The oak service scale up <SERVICE_ID|SERVICE_NAME> <number> allows you to scale up or down a certain <number> of isntances of a service give its ID or Name.

Further Details#

This page only highlights a small subset of available oak-cli capabilities.