README.md

node-salt-api

A simple Node.js package to send functions to Salt Stack salt-api via CherryPy.
Use Salt modules from Node.js.

Requirements

You need to have salt-api and CherryPy installed and configured.
Please follow the installation instructions of Salt netapi rest_cherrypy.

Install

npm add salt-api axios eventsource

Please note that axios and eventsource are peerDependencies so depending on your use case, you may need to install these manually.

Usage

First, require salt-api

import { Salt } from "salt-api";

Configure

Configure the API via an object containing url, username, password.   If needed, you can also provide eauth. Defaults to "pam".

const salt = new Salt(YourConfigObjectHere, debug = false, axiosInstance = undefined);

Debug

Add second param true for debug logs.
const salt = new Salt(YourConfigObjectHere, true);

{
  tgt: 'not master',
  fun: 'saltutil.refresh_pillar',
  client: 'local',
  tgt_type: 'compound',
  duration: 1.934
}

Wait for authentication

Make sure salt-api is done with the authentication.

await salt.login();

or  

salt.login().then(() => {
	// Code
});

Run functions

salt.fun(target, function, funOptionsObjectHere)
target defaults to "*"
function defaults to "test.ping"
client defaults to "local"

Example of funOptions object
salt.fun("not master", "saltutil.refresh_pillar", { tgt_type: "compound" });

See more from Salt docs

• https://docs.saltproject.io/en/latest/ref/netapi/all/salt.netapi.rest_cherrypy.html
• https://docs.saltproject.io/en/latest/ref/clients/index.html#salt.client.LocalClient.cmd

Returns a Promise that resolves an object containing a return array with the data directly from the API.

Get minions

salt.minions(mid)

mid optional minion id

Returns a Promise that resolves an object containing a minon information in a return array with the data directly from the API.

Get jobs

salt.jobs(jid)

jid optional job id

Returns a Promise that resolves an object containing the job information in a return array with the data directly from the API.

Events

salt.eventSource()

Opens connection to An HTTP stream of the Salt Master Event Bus and returns EventSource.

const events = await salt.eventSource()
events.onopen = () => {
	console.log("Connected to Salt Master Event Bus")
}

events.onmessage = async (data) => {
	console.log("Got event from Salt Master Events Bus", data)
	// Do something with the data
}

events.onerror = async (err) => {
	if (err?.status === 401 || err?.status === 403) {
		console.log("Not authorized")
	};
}

Example

import { Salt } from "salt-api";
const salt = new Salt({
	url: "http://localhost:8000",
	username: "salt",
	password: "secret"
});

salt.login().then(() => {

	// Same as running `salt "*" test.ping` in the command line
	salt.fun("*", "test.ping").then(data => {

		// Do something with the data
		console.log(data);
		// { return: [ { b827eb3aaaf7: true, b827ebcc82fe: true } ] }

	}).catch(e => console.error(e));

});

LICENSE: MIT