spec.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "object",
  "properties": {
    "os": {
      "type": "object",
      "description": "Additional packages and commands to run prior to terraform execution",
      "properties": {
        "packages": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "list of apk packages to install at container execution time"
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of shell commands to run after packages are installed but before Terrafrom executes"
        }
      }
    },
    "workspace": {
      "type": "string",
      "default": "default",
      "description": "The name of the Terraform workspace to run"
    },
    "google": {
      "type": "object",
      "description": "A mapping of Google account configuration.",
      "properties": {
        "connection": {
          "type": "object",
          "x-relay-connectionType": "gcp",
          "description": "A Relay GCP connection to use",
          "properties": {
            "serviceAccountKey": {
              "type": "string"
            }
          },
          "required": [
            "serviceAccountKey"
          ]
        }
      },
      "required": [
        "connection"
      ]
    },
    "aws": {
      "type": "object",
      "description": "A mapping of AWS account configuration.",
      "properties": {
        "connection": {
          "type": "object",
          "x-relay-connectionType": "aws",
          "description": "A Relay AWS connection to use",
          "properties": {
            "accessKeyID": {
              "type": "string",
              "description": "Access Key ID"
            },
            "secretAccessKey": {
              "type": "string",
              "description": "Secret Access Key"
            }
          },
          "required": [
            "accessKeyID",
            "secretAccessKey"
          ]
        },
        "region": {
          "type": "string",
          "description": "The AWS region to use (for example, us-west-2)"
        }
      },
      "required": [
        "connection",
        "region"
      ]
    },
    "azure": {
      "type": "object",
      "description": "A mapping of Azure account configuration.",
      "properties": {
        "connection": {
          "type": "object",
          "x-relay-connectionType": "azure",
          "description": "A Relay Azure connection to use",
          "properties": {
            "subscriptionID": {
              "type": "string",
              "description": "Azure Subscription ID"
            },
            "clientID": {
              "type": "string",
              "description": "Azure Service Principal client ID"
            },
            "tenantID": {
              "type": "string",
              "description": "Azure Service Principal tenant ID"
            },
            "secret": {
              "type": "string",
              "description": "Azure Service Principal secret"
            }
          },
          "required": [
            "subscriptionID",
            "clientID",
            "tenantID",
            "secret"
          ]
        }
      },
      "required": [
        "connection"
      ]
    },
    "directory": {
      "type": "string",
      "description": "Subdirectory of the git repository containing the Terraform config root"
    },
    "backendConfig": {
      "type": "object",
      "description": "A map of backend configuration variables to be passed to terraform as -backend-config=key=value"
    },
    "git": {
      "type": "object",
      "description": "A git repository containing the terraform code to run",
      "properties": {
        "connection": {
          "type": "object",
          "x-relay-connectionType": "ssh",
          "description": "A Relay SSH connection to use",
          "properties": {
            "sshKey": {
              "type": "string",
              "description": "The SSH key to use when cloning the git repository."
            },
            "knownHosts": {
              "type": "string",
              "description": "SSH known hosts file."
            }
          }
        },
        "name": {
          "type": "string",
          "description": "A directory name for the git clone."
        },
        "branch": {
          "type": "string",
          "description": "The Git branch to clone.",
          "default": "master"
        },
        "repository": {
          "type": "string",
          "description": "The git repository URL."
        }
      },
      "required": [
        "name",
        "repository"
      ]
    }
  }
}