@flyteorg/flyteidl 1.13.9 → 1.14.0

package/README.md

@@ -1,6 +1,6 @@
 # Flyteidl
 
-This is one of the core repositories of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).
+This is one of the core components of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).
 
 
 [![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)
@@ -11,69 +11,4 @@ This is one of the core repositories of Flyte. It contains the Specification of
 
 ## Contributing to Flyteidl
 
-## Tooling for Flyteidl
-
-1. Run ``make download_tooling`` to install generator dependencies.
-
-```bash
-   make download_tooling
-```
-
-2. Ensure Docker is installed locally.
-3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
-
-```bash
-    make generate
-```
-
-4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
-
-```bash
-   make doc-requirements.txt
-```
-
-## Docs structure
-
-The index.rst files for protos are arranged in parallel under the ``docs`` folder.
-All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
-
-```
-docs
-├── admin
-│   ├── admin.rst
-│   └── index.rst
-├── core
-│   ├── core.rst
-│   └── index.rst
-├── datacatalog
-│   ├── datacatalog.rst
-│   └── index.rst
-├── event
-│   ├── event.rst
-│   └── index.rst
-├── plugins
-│   ├── index.rst
-│   └── plugins.rst
-├── service
-│   ├── index.rst
-│   └── service.rst
-```
-
-Each module in protos has a module in docs with the same name.
-For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
-
-
-## Generating Documentation
-
-* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
-```
-     core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
-     # Remove any currently generated file
-     ls -d protos/docs/core/* | grep -v index.rst | xargs rm
-     protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
-```
-
-* ``make generate`` generates the modified rst files.
-
-* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
-
+See the [contributing docs](protos/docs/contributing.md) for more information.

package/gen/pb-js/flyteidl.d.ts

@@ -10034,6 +10034,9 @@ export namespace flyteidl {
 
             /** Resource customInfo */
             customInfo?: (google.protobuf.IStruct|null);
+
+            /** Resource agentError */
+            agentError?: (flyteidl.admin.IAgentError|null);
         }
 
         /** Represents a Resource. */
@@ -10063,6 +10066,9 @@ export namespace flyteidl {
             /** Resource customInfo. */
             public customInfo?: (google.protobuf.IStruct|null);
 
+            /** Resource agentError. */
+            public agentError?: (flyteidl.admin.IAgentError|null);
+
             /**
              * Creates a new Resource instance using the specified properties.
              * @param [properties] Properties to set
@@ -10917,6 +10923,79 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
+        /** Properties of an AgentError. */
+        interface IAgentError {
+
+            /** AgentError code */
+            code?: (string|null);
+
+            /** AgentError kind */
+            kind?: (flyteidl.admin.AgentError.Kind|null);
+
+            /** AgentError origin */
+            origin?: (flyteidl.core.ExecutionError.ErrorKind|null);
+        }
+
+        /** Represents an AgentError. */
+        class AgentError implements IAgentError {
+
+            /**
+             * Constructs a new AgentError.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: flyteidl.admin.IAgentError);
+
+            /** AgentError code. */
+            public code: string;
+
+            /** AgentError kind. */
+            public kind: flyteidl.admin.AgentError.Kind;
+
+            /** AgentError origin. */
+            public origin: flyteidl.core.ExecutionError.ErrorKind;
+
+            /**
+             * Creates a new AgentError instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns AgentError instance
+             */
+            public static create(properties?: flyteidl.admin.IAgentError): flyteidl.admin.AgentError;
+
+            /**
+             * Encodes the specified AgentError message. Does not implicitly {@link flyteidl.admin.AgentError.verify|verify} messages.
+             * @param message AgentError message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: flyteidl.admin.IAgentError, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes an AgentError message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns AgentError
+             * @throws {Error} If the payload is not a reader or valid buffer
+             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+             */
+            public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.AgentError;
+
+            /**
+             * Verifies an AgentError message.
+             * @param message Plain object to verify
+             * @returns `null` if valid, otherwise the reason why it is not
+             */
+            public static verify(message: { [k: string]: any }): (string|null);
+        }
+
+        namespace AgentError {
+
+            /** Kind enum. */
+            enum Kind {
+                NON_RECOVERABLE = 0,
+                RECOVERABLE = 1
+            }
+        }
+
         /** Properties of a ClusterAssignment. */
         interface IClusterAssignment {
 

package/gen/pb-js/flyteidl.js

@@ -24598,6 +24598,7 @@
                  * @property {Array.<flyteidl.core.ITaskLog>|null} [logLinks] Resource logLinks
                  * @property {flyteidl.core.TaskExecution.Phase|null} [phase] Resource phase
                  * @property {google.protobuf.IStruct|null} [customInfo] Resource customInfo
+                 * @property {flyteidl.admin.IAgentError|null} [agentError] Resource agentError
                  */
     
                 /**
@@ -24664,6 +24665,14 @@
                  */
                 Resource.prototype.customInfo = null;
     
+                /**
+                 * Resource agentError.
+                 * @member {flyteidl.admin.IAgentError|null|undefined} agentError
+                 * @memberof flyteidl.admin.Resource
+                 * @instance
+                 */
+                Resource.prototype.agentError = null;
+    
                 /**
                  * Creates a new Resource instance using the specified properties.
                  * @function create
@@ -24701,6 +24710,8 @@
                         writer.uint32(/* id 5, wireType 0 =*/40).int32(message.phase);
                     if (message.customInfo != null && message.hasOwnProperty("customInfo"))
                         $root.google.protobuf.Struct.encode(message.customInfo, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
+                    if (message.agentError != null && message.hasOwnProperty("agentError"))
+                        $root.flyteidl.admin.AgentError.encode(message.agentError, writer.uint32(/* id 7, wireType 2 =*/58).fork()).ldelim();
                     return writer;
                 };
     
@@ -24742,6 +24753,9 @@
                         case 6:
                             message.customInfo = $root.google.protobuf.Struct.decode(reader, reader.uint32());
                             break;
+                        case 7:
+                            message.agentError = $root.flyteidl.admin.AgentError.decode(reader, reader.uint32());
+                            break;
                         default:
                             reader.skipType(tag & 7);
                             break;
@@ -24808,6 +24822,11 @@
                         if (error)
                             return "customInfo." + error;
                     }
+                    if (message.agentError != null && message.hasOwnProperty("agentError")) {
+                        var error = $root.flyteidl.admin.AgentError.verify(message.agentError);
+                        if (error)
+                            return "agentError." + error;
+                    }
                     return null;
                 };
     
@@ -26704,6 +26723,175 @@
                 return GetTaskLogsResponse;
             })();
     
+            admin.AgentError = (function() {
+    
+                /**
+                 * Properties of an AgentError.
+                 * @memberof flyteidl.admin
+                 * @interface IAgentError
+                 * @property {string|null} [code] AgentError code
+                 * @property {flyteidl.admin.AgentError.Kind|null} [kind] AgentError kind
+                 * @property {flyteidl.core.ExecutionError.ErrorKind|null} [origin] AgentError origin
+                 */
+    
+                /**
+                 * Constructs a new AgentError.
+                 * @memberof flyteidl.admin
+                 * @classdesc Represents an AgentError.
+                 * @implements IAgentError
+                 * @constructor
+                 * @param {flyteidl.admin.IAgentError=} [properties] Properties to set
+                 */
+                function AgentError(properties) {
+                    if (properties)
+                        for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+                            if (properties[keys[i]] != null)
+                                this[keys[i]] = properties[keys[i]];
+                }
+    
+                /**
+                 * AgentError code.
+                 * @member {string} code
+                 * @memberof flyteidl.admin.AgentError
+                 * @instance
+                 */
+                AgentError.prototype.code = "";
+    
+                /**
+                 * AgentError kind.
+                 * @member {flyteidl.admin.AgentError.Kind} kind
+                 * @memberof flyteidl.admin.AgentError
+                 * @instance
+                 */
+                AgentError.prototype.kind = 0;
+    
+                /**
+                 * AgentError origin.
+                 * @member {flyteidl.core.ExecutionError.ErrorKind} origin
+                 * @memberof flyteidl.admin.AgentError
+                 * @instance
+                 */
+                AgentError.prototype.origin = 0;
+    
+                /**
+                 * Creates a new AgentError instance using the specified properties.
+                 * @function create
+                 * @memberof flyteidl.admin.AgentError
+                 * @static
+                 * @param {flyteidl.admin.IAgentError=} [properties] Properties to set
+                 * @returns {flyteidl.admin.AgentError} AgentError instance
+                 */
+                AgentError.create = function create(properties) {
+                    return new AgentError(properties);
+                };
+    
+                /**
+                 * Encodes the specified AgentError message. Does not implicitly {@link flyteidl.admin.AgentError.verify|verify} messages.
+                 * @function encode
+                 * @memberof flyteidl.admin.AgentError
+                 * @static
+                 * @param {flyteidl.admin.IAgentError} message AgentError message or plain object to encode
+                 * @param {$protobuf.Writer} [writer] Writer to encode to
+                 * @returns {$protobuf.Writer} Writer
+                 */
+                AgentError.encode = function encode(message, writer) {
+                    if (!writer)
+                        writer = $Writer.create();
+                    if (message.code != null && message.hasOwnProperty("code"))
+                        writer.uint32(/* id 1, wireType 2 =*/10).string(message.code);
+                    if (message.kind != null && message.hasOwnProperty("kind"))
+                        writer.uint32(/* id 3, wireType 0 =*/24).int32(message.kind);
+                    if (message.origin != null && message.hasOwnProperty("origin"))
+                        writer.uint32(/* id 4, wireType 0 =*/32).int32(message.origin);
+                    return writer;
+                };
+    
+                /**
+                 * Decodes an AgentError message from the specified reader or buffer.
+                 * @function decode
+                 * @memberof flyteidl.admin.AgentError
+                 * @static
+                 * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
+                 * @param {number} [length] Message length if known beforehand
+                 * @returns {flyteidl.admin.AgentError} AgentError
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                AgentError.decode = function decode(reader, length) {
+                    if (!(reader instanceof $Reader))
+                        reader = $Reader.create(reader);
+                    var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.AgentError();
+                    while (reader.pos < end) {
+                        var tag = reader.uint32();
+                        switch (tag >>> 3) {
+                        case 1:
+                            message.code = reader.string();
+                            break;
+                        case 3:
+                            message.kind = reader.int32();
+                            break;
+                        case 4:
+                            message.origin = reader.int32();
+                            break;
+                        default:
+                            reader.skipType(tag & 7);
+                            break;
+                        }
+                    }
+                    return message;
+                };
+    
+                /**
+                 * Verifies an AgentError message.
+                 * @function verify
+                 * @memberof flyteidl.admin.AgentError
+                 * @static
+                 * @param {Object.<string,*>} message Plain object to verify
+                 * @returns {string|null} `null` if valid, otherwise the reason why it is not
+                 */
+                AgentError.verify = function verify(message) {
+                    if (typeof message !== "object" || message === null)
+                        return "object expected";
+                    if (message.code != null && message.hasOwnProperty("code"))
+                        if (!$util.isString(message.code))
+                            return "code: string expected";
+                    if (message.kind != null && message.hasOwnProperty("kind"))
+                        switch (message.kind) {
+                        default:
+                            return "kind: enum value expected";
+                        case 0:
+                        case 1:
+                            break;
+                        }
+                    if (message.origin != null && message.hasOwnProperty("origin"))
+                        switch (message.origin) {
+                        default:
+                            return "origin: enum value expected";
+                        case 0:
+                        case 1:
+                        case 2:
+                            break;
+                        }
+                    return null;
+                };
+    
+                /**
+                 * Kind enum.
+                 * @name flyteidl.admin.AgentError.Kind
+                 * @enum {string}
+                 * @property {number} NON_RECOVERABLE=0 NON_RECOVERABLE value
+                 * @property {number} RECOVERABLE=1 RECOVERABLE value
+                 */
+                AgentError.Kind = (function() {
+                    var valuesById = {}, values = Object.create(valuesById);
+                    values[valuesById[0] = "NON_RECOVERABLE"] = 0;
+                    values[valuesById[1] = "RECOVERABLE"] = 1;
+                    return values;
+                })();
+    
+                return AgentError;
+            })();
+    
             admin.ClusterAssignment = (function() {
     
                 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/flyteidl",
-  "version": "1.13.9",
+  "version": "1.14.0",
   "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
   "repository": {
     "type": "git",

package/protos/docs/contributing.md

@@ -0,0 +1,68 @@
+## Contributing to FlyteIDL
+
+## Install Tooling
+
+1. Run ``make download_tooling`` to install generator dependencies.
+
+```bash
+   make download_tooling
+```
+
+2. Ensure Docker is installed locally.
+3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
+
+```bash
+    make generate
+```
+
+4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
+
+```bash
+   make doc-requirements.txt
+```
+
+## Docs structure
+
+The index.rst files for protos are arranged in parallel under the ``docs`` folder.
+All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
+
+```
+docs
+├── admin
+│   ├── admin.rst
+│   └── index.rst
+├── core
+│   ├── core.rst
+│   └── index.rst
+├── datacatalog
+│   ├── datacatalog.rst
+│   └── index.rst
+├── event
+│   ├── event.rst
+│   └── index.rst
+├── plugins
+│   ├── index.rst
+│   └── plugins.rst
+├── service
+│   ├── index.rst
+│   └── service.rst
+```
+
+Each module in protos has a module in docs with the same name.
+For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
+
+
+## Generating Documentation
+
+* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
+```
+     core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
+     # Remove any currently generated file
+     ls -d protos/docs/core/* | grep -v index.rst | xargs rm
+     protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
+```
+
+* ``make generate`` generates the modified rst files.
+
+* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
+

package/protos/{index.rst → docs_index.rst}

@@ -16,3 +16,4 @@ and documentation of all these entities.
 	docs/event/index
 	docs/plugins/index
 	docs/service/index
+	docs/contributing

package/protos/flyteidl/admin/agent.proto

@@ -138,6 +138,8 @@ message Resource {
   core.TaskExecution.Phase phase = 5;
   // Custom data specific to the agent.
   google.protobuf.Struct custom_info = 6;
+  // The error raised during execution
+  AgentError agent_error = 7;
 }
 
 // A message used to delete a task.
@@ -256,3 +258,22 @@ message GetTaskLogsResponse {
     GetTaskLogsResponseBody body = 2;
   }
 }
+
+// Error message to propagate detailed errors from agent executions to the execution
+// engine.
+message AgentError {
+  // A simplified code for errors, so that we can provide a glossary of all possible errors.
+  string code = 1;
+
+  // Defines a generic error type that dictates the behavior of the retry strategy.
+  enum Kind {
+    NON_RECOVERABLE = 0;
+    RECOVERABLE = 1;
+  }
+
+  // An abstract error kind for this error. Defaults to Non_Recoverable if not specified.
+  Kind kind = 3;
+
+  // Defines the origin of the error (system, user, unknown).
+  core.ExecutionError.ErrorKind origin = 4;
+}

package/protos/flyteidl/admin/common.proto

@@ -29,6 +29,7 @@ message NamedEntityIdentifier {
 
 // The status of the named entity is used to control its visibility in the UI.
 enum NamedEntityState {
+    reserved 3, 4;
     // By default, all named entities are considered active and under development.
     NAMED_ENTITY_ACTIVE = 0;
 

package/protos/flyteidl/admin/execution.proto

@@ -206,6 +206,8 @@ message SystemMetadata {
 message ExecutionMetadata {
     // The method by which this execution was launched.
     enum ExecutionMode {
+	reserved 7;
+
         // The default execution mode, MANUAL implies that an execution was launched by an individual.
         MANUAL = 0;