@flyteorg/flyteidl 0.24.10 → 0.24.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,31 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Flyteidl
|
|
2
|
+
|
|
3
|
+
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).
|
|
2
4
|
|
|
3
|
-
This is one of the core repositories of Flyte and contains the Specification of the Flyte Lanugage using protobuf messages, the Backend API specification in gRPC and Swagger REST. The repo contains 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 API's (the services grouped under Flyteadmin).
|
|
4
5
|
|
|
5
6
|
[](https://slack.flyte.org)
|
|
6
7
|
|
|
7
8
|
* [flyte.org](https://flyte.org)
|
|
8
9
|
* [Flyte Docs](http://docs.flyte.org)
|
|
9
|
-
* [
|
|
10
|
+
* [Flyteidl API reference documentation](https://docs.flyte.org/projects/flyteidl/en/stable/index.html)
|
|
10
11
|
|
|
11
|
-
## Contributing to
|
|
12
|
+
## Contributing to Flyteidl
|
|
12
13
|
|
|
13
|
-
## Tooling for
|
|
14
|
+
## Tooling for Flyteidl
|
|
14
15
|
|
|
15
|
-
1. Run ``make download_tooling`` to install generator dependencies
|
|
16
|
+
1. Run ``make download_tooling`` to install generator dependencies.
|
|
16
17
|
|
|
17
18
|
```bash
|
|
18
19
|
make download_tooling
|
|
19
20
|
```
|
|
20
21
|
|
|
21
|
-
2.
|
|
22
|
-
3.
|
|
22
|
+
2. Ensure Docker is installed locally.
|
|
23
|
+
3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
|
|
23
24
|
|
|
24
25
|
```bash
|
|
25
26
|
make generate
|
|
26
27
|
```
|
|
27
28
|
|
|
28
|
-
4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and
|
|
29
|
+
4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
|
|
29
30
|
|
|
30
31
|
```bash
|
|
31
32
|
make doc-requirements.txt
|
|
@@ -33,8 +34,8 @@ This is one of the core repositories of Flyte and contains the Specification of
|
|
|
33
34
|
|
|
34
35
|
## Docs structure
|
|
35
36
|
|
|
36
|
-
The index.rst files for protos are
|
|
37
|
-
All the proto definitions are within protos/flyteidl and
|
|
37
|
+
The index.rst files for protos are arranged in parallel under the ``docs`` folder.
|
|
38
|
+
All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
|
|
38
39
|
|
|
39
40
|
```
|
|
40
41
|
docs
|
|
@@ -58,13 +59,13 @@ docs
|
|
|
58
59
|
│ └── service.rst
|
|
59
60
|
```
|
|
60
61
|
|
|
61
|
-
Each module in protos has
|
|
62
|
-
|
|
62
|
+
Each module in protos has a module in docs with the same name.
|
|
63
|
+
For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
|
|
63
64
|
|
|
64
65
|
|
|
65
|
-
##
|
|
66
|
+
## Generating Documentation
|
|
66
67
|
|
|
67
|
-
* If
|
|
68
|
+
* 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.
|
|
68
69
|
```
|
|
69
70
|
core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
|
|
70
71
|
# Remove any currently generated file
|
|
@@ -72,7 +73,7 @@ eg : protos/flyteidl/core has same named doc structure placing it index and othe
|
|
|
72
73
|
protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
|
|
73
74
|
```
|
|
74
75
|
|
|
75
|
-
* ``make generate``
|
|
76
|
+
* ``make generate`` generates the modified rst files.
|
|
76
77
|
|
|
77
|
-
* ``make html``
|
|
78
|
+
* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
|
|
78
79
|
|
package/package.json
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
Flyte Admin Service entities
|
|
2
2
|
============================
|
|
3
3
|
|
|
4
|
-
These are the control plane entities that can be used to
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
These are the control plane entities that can be used to communicate with the
|
|
5
|
+
FlyteAdmin service over gRPC or REST. The endpoint specification is defined in the
|
|
7
6
|
`Admin raw protos <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/admin>`__
|
|
8
7
|
|
|
9
8
|
.. toctree::
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
Core Flyte language specification
|
|
2
2
|
=================================
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
structures like
|
|
6
|
-
of the various entities in Flyte
|
|
4
|
+
Protocol buffers provide details about core data
|
|
5
|
+
structures like :ref:`workflows <divedeep-workflows>`, :ref:`tasks <divedeep-tasks>`, :ref:`nodes <divedeep-nodes>`, and Literals. They are the specifications
|
|
6
|
+
of the various entities in Flyte and the type system.
|
|
7
7
|
|
|
8
8
|
`Core raw protos <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/core>`__
|
|
9
9
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
Flyte Data Catalog Service
|
|
2
|
-
|
|
2
|
+
============================
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
to catalog artifacts generated by task executions.
|
|
7
|
-
data and tagged by the user so
|
|
4
|
+
Protos provides the interface definition for the Data Catalog Service. Data Catalog is a service to
|
|
5
|
+
index parameterized, strongly-typed data artifacts across revisions. It is used in the Flyte ecosystem
|
|
6
|
+
to catalog artifacts generated by the task executions. The output generated by a task can be stored as artifact
|
|
7
|
+
data and tagged by the user so as to be retrieved later by that tag.
|
|
8
8
|
|
|
9
9
|
`Datacatalog raw proto <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/datacatalog/datacatalog.proto>`__
|
|
10
10
|
|
|
@@ -9,14 +9,13 @@ External Eventing system.
|
|
|
9
9
|
Flyte Internal Eventing
|
|
10
10
|
========================
|
|
11
11
|
|
|
12
|
-
This is the interface used by the dataplane (execution engine) to communicate
|
|
13
|
-
workflow and task progress back to the **control plane** admin service.
|
|
12
|
+
This is the interface used by the dataplane (execution engine) to communicate with the control plane admin service about the workflow and task progress.
|
|
14
13
|
|
|
15
14
|
Flyte External Eventing - Event Egress
|
|
16
15
|
=======================================
|
|
17
16
|
|
|
18
|
-
This refers to the interface for all the event messages
|
|
19
|
-
**control plane** and
|
|
17
|
+
This refers to the interface for all the event messages leaving the Flyte
|
|
18
|
+
**control plane** and reaching on the configured pubsub channel.
|
|
20
19
|
|
|
21
20
|
`Event raw proto <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/event/event.proto>`__
|
|
22
21
|
|