Oct 22, 2019
README
Flyteadmin
=============
Flyteadmin is the control plane for Flyte responsible for managing entities (task, workflows, launch plans) and
administering workflow executions. Flyteadmin implements the
`AdminService <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/service/admin.proto>`_ which
defines a stateless REST/gRPC service for interacting with registered Flyte entities and executions.
Flyteadmin uses a relational style Metadata Store abstracted by `GORM <http://gorm.io/>`_ ORM library.
Before Check-In
~~~~~~~~~~~~~~~
Flyte Admin has a few useful make targets for linting and testing. Please use these before checking in to help suss out
minor bugs and linting errors.
.. code-block:: console
make goimports
.. code-block:: console
make test_unit
.. code-block:: console
make lint
Directories
| Path | Synopsis |
|---|---|
| cmd | |
| cmd/entrypoints | |
| pkg/async/notifications | |
| pkg/async/notifications/implementations | |
| pkg/async/notifications/interfaces | |
| pkg/async/notifications/mocks | |
| pkg/async/schedule | |
| pkg/async/schedule/aws | Functions for serializing and deserializing scheduled events in AWS. |
| pkg/async/schedule/aws/interfaces | |
| pkg/async/schedule/aws/mocks | |
| pkg/async/schedule/interfaces | Defines an event scheduler interface |
| pkg/async/schedule/mocks | Mock implementation of a WorkflowExecutor for use in tests. |
| pkg/async/schedule/noop | No-op event event scheduler for use in development. |
| pkg/clusterresource | |
| pkg/common | Defines a common set of filters that can be applied in queries for supported databases types. |
| pkg/common/mocks | |
| pkg/config | |
| pkg/data | |
| pkg/data/implementations | |
| pkg/data/interfaces | |
| pkg/data/mocks | |
| pkg/errors | Defines the error messages used within FlyteAdmin categorized by common error codes. |
| pkg/executioncluster | |
| pkg/executioncluster/impl | |
| pkg/executioncluster/interfaces | |
| pkg/executioncluster/mocks | |
| pkg/flytek8s | Collection of shared utils for initializing kubernetes clients within flyteadmin. |
| pkg/manager/impl | |
| pkg/manager/impl/executions | |
| pkg/manager/impl/shared | Shared constants for the manager implementation. |
| pkg/manager/impl/testutils | Provides sample closures for use in tests. |
| pkg/manager/impl/util | Util around parsing request filters Shared method implementations. |
| pkg/manager/impl/validation | Miscellaneous functions to validate that required proto and spec fields are non empty when required for execution. |
| pkg/manager/interfaces | |
| pkg/manager/mocks | |
| pkg/repositories | |
| pkg/repositories/config | |
| pkg/repositories/errors | Generic errors used across files in repositories/ Postgres-specific implementation of an ErrorTransformer. |
| pkg/repositories/gormimpl | Shared utils for postgresql tests. |
| pkg/repositories/interfaces | |
| pkg/repositories/mocks | Mock implementation of a workflow repo to be used for tests. |
| pkg/repositories/models | |
| pkg/repositories/transformers | Handles translating gRPC request & response objects to and from repository model objects |
| pkg/rpc/adminservice | Per endpoint service Metrics. |
| pkg/rpc/adminservice/tests | |
| pkg/rpc/adminservice/util | |
| pkg/runtime | Interface for configurable values used in entity registration and validation |
| pkg/runtime/interfaces | |
| pkg/runtime/mocks | |
| pkg/workflowengine/impl | |
| pkg/workflowengine/interfaces | |
| pkg/workflowengine/mocks | |
| tests |