README
¶
Flyteadmin
=============
[](https://github.com/lyft/flyteadmin/releases/latest)
[](https://pkg.go.dev/mod/github.com/lyft/flyteadmin)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
[](https://codecov.io/gh/lyft/flyteadmin)
[](https://goreportcard.com/report/github.com/lyft/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 |
|---|---|
|
pkg
|
|
|
async/schedule/aws
Functions for serializing and deserializing scheduled events in AWS.
|
Functions for serializing and deserializing scheduled events in AWS. |
|
async/schedule/interfaces
Defines an event scheduler interface
|
Defines an event scheduler interface |
|
async/schedule/mocks
Mock implementation of a WorkflowExecutor for use in tests.
|
Mock implementation of a WorkflowExecutor for use in tests. |
|
async/schedule/noop
No-op event event scheduler for use in development.
|
No-op event event scheduler for use in development. |
|
common
Defines a common set of filters that can be applied in queries for supported databases types.
|
Defines a common set of filters that can be applied in queries for supported databases types. |
|
errors
Defines the error messages used within FlyteAdmin categorized by common error codes.
|
Defines the error messages used within FlyteAdmin categorized by common error codes. |
|
flytek8s
Collection of shared utils for initializing kubernetes clients within flyteadmin.
|
Collection of shared utils for initializing kubernetes clients within flyteadmin. |
|
manager/impl/shared
Shared constants for the manager implementation.
|
Shared constants for the manager implementation. |
|
manager/impl/testutils
Provides sample closures for use in tests.
|
Provides sample closures for use in tests. |
|
manager/impl/util
Util around parsing request filters Shared method implementations.
|
Util around parsing request filters Shared method implementations. |
|
manager/impl/validation
Miscellaneous functions to validate that required proto and spec fields are non empty when required for execution.
|
Miscellaneous functions to validate that required proto and spec fields are non empty when required for execution. |
|
repositories/errors
Generic errors used across files in repositories/ Postgres-specific implementation of an ErrorTransformer.
|
Generic errors used across files in repositories/ Postgres-specific implementation of an ErrorTransformer. |
|
repositories/mocks
Mock implementation of a workflow repo to be used for tests.
|
Mock implementation of a workflow repo to be used for tests. |
|
repositories/transformers
Handles translating gRPC request & response objects to and from repository model objects
|
Handles translating gRPC request & response objects to and from repository model objects |
|
rpc/adminservice
Per endpoint service Metrics.
|
Per endpoint service Metrics. |
|
runtime
Interface for configurable values used in entity registration and validation
|
Interface for configurable values used in entity registration and validation |
Click to show internal directories.
Click to hide internal directories.