package nitric.proto.deployments.v1

Get desktop application:
View/edit binary Protocol Buffers messages

The Nitric Deloyment Service contract

• rpc Up (DeploymentUpRequest, stream DeploymentUpEvent)

  deployments.proto:23

  Begins a new deployment Server will stream updates back to the connected client on the status of the deployment

  message DeploymentUpRequest

  deployments.proto:30

  • optional Spec spec = 1

    The spec to deploy

  • optional google.protobuf.Struct attributes = 2

    A map of attributes related to the deploy request this allows for adding project identifiers etc.

  • bool interactive = 3

    A hint to the provider of the kind of output that the client can accept This will allow provider developers to provider richer output back to clients.

  message DeploymentUpEvent

  deployments.proto:43

  • oneof content

    • string message = 1

    • ResourceUpdate update = 2

    • UpResult result = 3

• rpc Down (DeploymentDownRequest, stream DeploymentDownEvent)

  deployments.proto:27

  Tears down an existing deployment Server will stream updates back to the connected client on the status of the teardown

  message DeploymentDownRequest

  deployments.proto:107

  • optional google.protobuf.Struct attributes = 1

    A map of attributes related to the deploy request this allows for adding project identifiers etc.

  • bool interactive = 2

    A hint to the provider of the kind of output that the client can accept This will allow provider developers to provider richer output back to clients.

  message DeploymentDownEvent

  deployments.proto:117

  • oneof content

    • string message = 1

    • DownResult result = 2

    • ResourceUpdate update = 3

Used in: Resource

• oneof document

  • string openapi = 1

    An OpenAPI document for deployment This document will contain extensions that hint of services that should be targeted as part of the deployment

Used in: Resource

• oneof source

  Source of the service

  • ImageSource image = 1

    Image URI for this batch service

• string type = 10

  A simple type property describes the requested type of batch that this should be for this project, a provider can implement how this request is satisfied in any way

• map<string, string> env = 11

  Environment variables for this Batch

• repeated Job jobs = 12

  Jobs that are defined in this Batch

Used in: Resource

• repeated BucketListener listeners = 1

Used in: Bucket

• optional storage.v1.RegistrationRequest config = 1

• oneof target

  • string service = 2

    The name of an service to target

Terminal message indicating deployment success

Used in: DeploymentDownEvent

(message has no fields)

An http proxy resource

Used in: Resource

• optional HttpTarget target = 1

Used in: Http

• oneof target

  • string service = 1

    The name of an service to target

An image source to be used for service deployment

Used in: Batch, Service

• string uri = 1

  URI of the docker image To support remote images this may also need to provide auth information

Used in: Batch

• string name = 1

  The name of the job to create

• optional batch.v1.JobResourceRequirements requirements = 2

  The default resource requirements of the job

Used in: Resource

(message has no fields)

This is already defined in the resource contracts, unfortunately there are parts we don't want to duplicate, such as API config

Used in: Resource

• repeated Resource principals = 1

• repeated resources.v1.Action actions = 2

• repeated Resource resources = 3

Used in: Resource

(message has no fields)

Used in: Policy, Spec

• optional resources.v1.ResourceIdentifier id = 1

• oneof config

  • Service service = 10

  • Bucket bucket = 11

  • Topic topic = 12

  • Api api = 13

  • Policy policy = 14

  • Schedule schedule = 15

  • KeyValueStore key_value_store = 16

  • Secret secret = 17

  • Websocket websocket = 18

  • Http http = 19

  • Queue queue = 20

  • SqlDatabase sql_database = 21

  • Batch batch = 22

  • Website website = 23

Used in: ResourceUpdate

• CREATE = 0

  A new resource is being created

• UPDATE = 1

  An existing resource is being updated

• REPLACE = 2

  An existing resource is being replaced

• SAME = 3

  No-op on the resource (it already exists and requires no changes)

• DELETE = 4

  An existing resource is being deleted

Used in: ResourceUpdate

• PENDING = 0

  The action hasn't started, usually due to a dependency

• IN_PROGRESS = 1

  The action in currently in-flight, e.g. waiting for cloud provider to provision a resource

• SUCCESS = 2

  The action has been applied successfully

• FAILED = 3

  The action has failed to be (completely) applied

Used in: DeploymentDownEvent, DeploymentUpEvent

• optional resources.v1.ResourceIdentifier id = 1

  The resource being updated, if this is nil the update applies to the stack

• ResourceDeploymentAction action = 3

  The type of update being applied

• ResourceDeploymentStatus status = 4

  The current status of the action being applied

• string sub_resource = 5

  (optional) A globally unique identifier (scoped to the id above), used when Nitric Resources map 1:many in a cloud provider. e.g. the container image repository for a service deployment. This can also be set when id is nil above and it will imply a non-nitric resource that is necessary to deploy for a stack to operate e.g. an Azure StorageAccount

• string message = 6

  Additional information about the update

Used in: Resource

• optional ScheduleTarget target = 1

• oneof cadence

  • ScheduleEvery every = 10

  • ScheduleCron cron = 11

Used in: Schedule

• string expression = 1

  standard unix cron expression

Used in: Schedule

• string rate = 1

  rate string e.g. '5 minutes'. Value frequencies are 'minutes', 'hours', 'days'.

Used in: Schedule

• oneof target

  • string service = 1

    The name of an service to target

    Additional targets could potentially include - HTTP/API Endpoints

Used in: Resource

(message has no fields)

A unit of compute (i.e. function/container)

Used in: Resource

• oneof source

  Source of the service

  • ImageSource image = 1

    Container image as a service

    Alternative sources could include - zipped code sources - git/scm repository URIs

• int32 workers = 10

  Expected worker count for this service

• int32 timeout = 11

  Configurable timeout for request handling

• int32 memory = 12

  Configurable memory size for this instance

• string type = 13

  A simple type property describes the requested type of service that this should be for this project, a provider can implement how this request is satisfied in any way

• map<string, string> env = 14

  Environment variables for this service

Used in: DeploymentUpRequest

• repeated Resource resources = 1

  list of resources to deploy

Used in: Resource

• oneof migrations

  • string image_uri = 1

    The URI of a docker image to use to execute the migrations for this database

Used in: Topic, TopicSubscription

• oneof target

  • string service = 1

    The name of an service to target

    Additional targets could potentially include - HTTP/API Endpoints - Queues

Used in: Resource

• repeated SubscriptionTarget subscriptions = 1

• optional SubscriptionTarget target = 1

Terminal message indicating deployment success

Used in: DeploymentUpEvent

• bool success = 1

  Indicate the success status

• oneof content

  • string text = 2

    Simple text output as result

Used in: Resource

• string index_document = 1

  The index document for the website

• string error_document = 2

  The error document for the website

• string base_path = 3

  The base path for the website

• oneof asset_source

  The source of the website assets

  • string local_directory = 4

    The production website output directory

Declare a new websocket

Used in: Resource

• optional WebsocketTarget connect_target = 1

  Target for handling new client connections

• optional WebsocketTarget disconnect_target = 2

  Target for handling client disconnections

• optional WebsocketTarget message_target = 3

  Target for handling all other message types

Used in: Websocket

• oneof target

  • string service = 1

    The name of an service to target

    Additional targets could potentially include - HTTP/API Endpoints