flyteadmin

module
Version: v1.1.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2022 License: Apache-2.0

README

FlyteAdmin

Current Release Master GoDoc License CodeCoverage Go Report Card Commit activity Commit since last release Slack

FlyteAdmin is the control plane for Flyte responsible for managing entities (task, workflows, launch plans) and administering workflow executions. FlyteAdmin implements the AdminService 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 ORM library.

For more background on Flyte, check out the official website and the docs

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.

  # Please make sure you have all the dependencies installed:
  $ make install
  
  # In case you are only missing goimports:
  $ go install golang.org/x/tools/cmd/goimports@latest
  $ make goimports
  $ make test_unit
  $ make lint

Directories

Path Synopsis
Contains types needed to start up a standalone OAuth2 Authorization Server or delegate authentication to an external provider.
Contains types needed to start up a standalone OAuth2 Authorization Server or delegate authentication to an external provider.
authzserver
OAuthServer implementation that serve oauth2 authorize and client_credentials flows.
OAuthServer implementation that serve oauth2 authorize and client_credentials flows.
cmd
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
core
Package core This is core package for the scheduler which includes - scheduler interface - scheduler implementation using gocron https://github.com/robfig/cron - updater which updates the schedules in the scheduler by reading periodically from the DB - snapshot runner which snapshot the schedules with there last exec times so that it can be used as check point in case of a crash.
Package core This is core package for the scheduler which includes - scheduler interface - scheduler implementation using gocron https://github.com/robfig/cron - updater which updates the schedules in the scheduler by reading periodically from the DB - snapshot runner which snapshot the schedules with there last exec times so that it can be used as check point in case of a crash.
dbapi
Package dbapi This package implements the event scheduler interface which is called whenever a launchplan is enabled or disabled.
Package dbapi This package implements the event scheduler interface which is called whenever a launchplan is enabled or disabled.
executor
Package executor This package provides an interface to talk to admin for scheduled executions.
Package executor This package provides an interface to talk to admin for scheduled executions.
identifier
Package identifier This package provides utility functions for creating a unique schedule name and execution name
Package identifier This package provides utility functions for creating a unique schedule name and execution name
repositories
Package repositories This package provides the interfaces and implementations to save and retrieve schedules and snapshots from the DB.
Package repositories This package provides the interfaces and implementations to save and retrieve schedules and snapshots from the DB.
snapshoter
Package snapshoter This package provides the ability to snapshot all the schedules in the scheduler job store and persist them in the DB in GOB binary format.
Package snapshoter This package provides the ability to snapshot all the schedules in the scheduler job store and persist them in the DB in GOB binary format.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL