Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command-Line Help for nixops4-resource-runner

This document contains the help content for the nixops4-resource-runner command-line program.

Command Overview:

nixops4-resource-runner

A utility to run resource providers without expressions, and without nixops4, primarily for testing

Usage: nixops4-resource-runner <COMMAND>

Subcommands:
  • create — Create a resource
  • update — Update a stateful resource
  • state-read — Read state from a state resource
  • state-event — Send a state event to a state resource

nixops4-resource-runner create

Create a resource

Usage: nixops4-resource-runner create [OPTIONS] --provider-exe <PROVIDER_EXE> --type <RESOURCE_TYPE>

Options:

  • --provider-exe <PROVIDER_EXE> — The executable that implements the resource operations

  • --type <RESOURCE_TYPE> — The type of resource to create: an identifier recognized by the resource provider

  • --inputs-json <INPUT_PROPERTIES_JSON> — The (whole) JSON input properties for the resource

    This is a JSON object with the values needed to create the resource. The structure of this object is defined by the resource provider behavior.

  • -j, --input-json <NAME> — An individual input property for the resource, in JSON format

  • -s, --input-str <NAME> — An individual input property for the resource, as a raw string.

    This is equivalent to --input-json NAME JSON if JSON is the JSON string formatting of STR.

  • --stateful — Whether state persistence will be provided to the resource

nixops4-resource-runner update

Update a stateful resource

Usage: nixops4-resource-runner update --provider-exe <PROVIDER_EXE> --type <RESOURCE_TYPE> --inputs-json <INPUT_PROPERTIES_JSON> --previous-inputs-json <PREVIOUS_INPUT_PROPERTIES_JSON> --previous-outputs-json <PREVIOUS_OUTPUT_PROPERTIES_JSON>

Options:

  • --provider-exe <PROVIDER_EXE> — The executable that implements the resource operations

  • --type <RESOURCE_TYPE> — The type of resource to update: an identifier recognized by the resource provider

  • --inputs-json <INPUT_PROPERTIES_JSON> — The new JSON input properties for the resource

    This is a JSON object with the values needed to update the resource. The structure of this object is defined by the resource provider behavior.

  • --previous-inputs-json <PREVIOUS_INPUT_PROPERTIES_JSON> — The previous JSON input properties for the resource, as recorded in the state

  • --previous-outputs-json <PREVIOUS_OUTPUT_PROPERTIES_JSON> — The previous JSON output properties for the resource, as recorded in the state

nixops4-resource-runner state-read

Read state from a state resource

Usage: nixops4-resource-runner state-read --provider-exe <PROVIDER_EXE> --type <RESOURCE_TYPE> --inputs-json <INPUT_PROPERTIES_JSON> --outputs-json <OUTPUT_PROPERTIES_JSON>

Options:
  • --provider-exe <PROVIDER_EXE> — The executable that implements the resource operations
  • --type <RESOURCE_TYPE> — The type of resource to read state from: an identifier recognized by the resource provider
  • --inputs-json <INPUT_PROPERTIES_JSON> — The JSON input properties for the resource
  • --outputs-json <OUTPUT_PROPERTIES_JSON> — The JSON output properties for the resource

nixops4-resource-runner state-event

Send a state event to a state resource

Usage: nixops4-resource-runner state-event --provider-exe <PROVIDER_EXE> --type <RESOURCE_TYPE> --inputs-json <INPUT_PROPERTIES_JSON> --outputs-json <OUTPUT_PROPERTIES_JSON> --event <EVENT> --nixops-version <NIXOPS_VERSION> --patch-json <PATCH_JSON>

Options:
  • --provider-exe <PROVIDER_EXE> — The executable that implements the resource operations
  • --type <RESOURCE_TYPE> — The type of resource to send the event to: an identifier recognized by the resource provider
  • --inputs-json <INPUT_PROPERTIES_JSON> — The JSON input properties for the resource
  • --outputs-json <OUTPUT_PROPERTIES_JSON> — The JSON output properties for the resource
  • --event <EVENT> — The operation that produced this change
  • --nixops-version <NIXOPS_VERSION> — The version of NixOps that produced this event
  • --patch-json <PATCH_JSON> — JSON Patch operations to apply to the state