azure-chaos
a tool for introducing chaos into the Azure PaaS using configurable extensions :gear: :cloud:
azchaos
is a lightweight tool for running extensions that implements a given API with
the expectation that they introduce chaos into Azure.
To install, use npm i -g azure-chaos
. Then use azchaos
to invoke.
λ azchaos --help
azchaos [command] [args]
Commands:
azchaos.js list [search] lists registered extensions
azchaos.js register <name> <uri> [desc] register a chaos extension
azchaos.js resgen <subId> [resGroup] [resName] create a properly formatted resource identifier
azchaos.js start <extension> [key] starts some chaos
azchaos.js stop <extension> [key] stops some chaos
azchaos.js token interactively authentiate the user, and print
an accessToken to stdout
azchaos.js unregister <name> unregister a chaos extension
Options:
--version Show version number [boolean]
-h, --help Show help [boolean]
Learn more @ https://github.com/bengreenier/azure-chaos
To learn more about authoring extensions, take a look at these resources:
register
Creates and/or updates a ~/.chaos-extensions.json
file. This file represents
all the extensions the tool is aware of and able to run. Use register to add new extensions:
azchaos register myextension https://myextension.com "a description of my extension"
list
Lists all the registered extensions by printing them to stdout
. Optionally filters by search
term.
azchaos list [search]
unregister
Updates a ~/.chaos-extensions.json
file. This file represents
all the extensions the tool is aware of and able to run. Use unregister to remove extensions:
azchaos unregister myextension
start
Start is a registered chaos extension, effectively enabling a chaotic event. This command requires
that a --resources
argument is given, accepting an array of comma-separated resource identifier strings.
Optionally, the --accessToken
argument may be provided, accepting an Azure access token in the form of Bearer <token>
.
If --accessToken
is not provided, the caller will be prompted to login interactively.
azchaos start myextension --resources "subId/resGroupName/resName","subId/resGroupName/resName2"
stop
Stop is a registered chaos extension, effectively disabling a chaotic event. This command requires
that a --resources
argument is given, accepting an array of comma-separated resource identifier strings.
Optionally, the --accessToken
argument may be provided, accepting an Azure access token in the form of Bearer <token>
.
If --accessToken
is not provided, the caller will be prompted to login interactively.
azchaos stop myextension --resources "subId/resGroupName/resName","subId/resGroupName/resName2"
resgen
Generates a resource identifier string given an Azure subscription id, optionally an Azure resource group name,
and (still optionally) an Azure resource name. The resulting tri-part string (in the form of subId/resGroupName/resName
)
will be output to stdout
.
azchaos resGen mySubId myResGroupName myResName
token
Interactively authenticates the user, and prints the valid accessToken
to stdout
. This accessToken
can be used as the --accessToken <value>
in the start and stop commands.
azchaos token
License
MIT