State File Schema

Raw JSON schema

Open JSON schema file

Examples

Empty State

{
  "_type": "nixopsState",
  "resources": {},
  "deployments": {}
}

NixOps4 State Event/File Schema

Raw JSON schema

• 1. Property StateEvent
  • 1.1. Property index
  • 1.2. Property meta
    • 1.2.1. Property time
  • 1.3. Property patch
    • 1.3.1. patch items
      • 1.3.1.1. Property item 0
        • 1.3.1.1.1. Property path
        • 1.3.1.1.2. Property op
        • 1.3.1.1.3. Property value
      • 1.3.1.2. Property item 1
        • 1.3.1.2.1. Property path
        • 1.3.1.2.2. Property op
      • 1.3.1.3. Property item 2
        • 1.3.1.3.1. Property path
        • 1.3.1.3.2. Property op
        • 1.3.1.3.3. Property from
• 2. Property State
  • 2.1. Property _type
  • 2.2. Property resources
  • 2.3. Property deployments

Title: NixOps4 State Event/File Schema

Description: This schema describes the shape of state events and the cumulative state file. The state file is a JSON file that contains the current state of the NixOps4 deployment. The state events are a sequence of changes to the state file, and are used to track the history of the deployment.

1. Property StateEvent

1.1. Property index

Description: The index of the event. This should be a monotonically increasing number that is used to order the events. A lack of monotonicity indicates concurrent operations that may need manual reconciliation.

1.2. Property meta

1.2.1. Property time

Description: The time at which the event occurred.

1.3. Property patch

Title: JSON Patch

Description: An RFC 6902 JSON Patch document. See https://tools.ietf.org/html/rfc6902, https://json.schemastore.org/json-patch.json

1.3.1. patch items

1.3.1.1. Property item 0

####### 1.3.1.1.1. Property path

Description: A JSON Pointer path.

####### 1.3.1.1.2. Property op

Description: The operation to perform.

Must be one of:

• "add"
• "replace"
• "test"

####### 1.3.1.1.3. Property value

Description: The value to add, replace or test.

1.3.1.2. Property item 1

####### 1.3.1.2.1. Property path

Description: A JSON Pointer path.

####### 1.3.1.2.2. Property op

Description: The operation to perform.

Must be one of:

• "remove"

1.3.1.3. Property item 2

####### 1.3.1.3.1. Property path

Description: A JSON Pointer path.

####### 1.3.1.3.2. Property op

Description: The operation to perform.

Must be one of:

• "move"
• "copy"

####### 1.3.1.3.3. Property from

Description: A JSON Pointer path pointing to the location to move/copy from.

2. Property State

2.1. Property _type

Description: The type of the state. This is used to distinguish the format of the NixOps state. Currently only one type has been developed: nixopsState. Any code that reads the state should reject any other type.

Must be one of:

• "nixopsState"

2.2. Property resources

2.3. Property deployments

Description: A set of nested deployments, TBD

---