36338774f1
* add single json file * update doc * update doc |
||
|---|---|---|
| .. | ||
| api | ||
| src | ||
| test | ||
| Dockerfile | ||
| Dockerfile.persistenceagent | ||
| Dockerfile.scheduledworkflow | ||
| Dockerfile.viewercontroller | ||
| OWNERS | ||
| README.md | ||
README.md
This directory contains code for the components that comprise the Kubeflow Pipelines backend.
Building & Testing
All components can be built using Bazel. To build everything under backend, run:
bazel build --action_env=PATH --define=grpc_no_ares=true //backend/...
To run all tests:
bazel test --action_env=PATH --define=grpc_no_ares=true //backend/...
The API server itself can only be built/tested using Bazel. The following commands target building and testing just the API server.
bazel build --action_env=PATH --define=grpc_no_ares=true backend/src/apiserver/...
bazel test --action_env=PATH --define=grpc_no_ares=true backend/src/apiserver/...
Building Go client library and swagger files
After making changes to proto files, the Go client libraries and swagger files need to be regenerated and checked-in. The backend/api/generate_api.sh script takes care of this.
Updating BUILD files
As the backend is written in Go, the BUILD files can be updated automatically using Gazelle. Whenever a Go file is added or updated, run the following to ensure the BUILD files are updated as well:
bazel run //:gazelle
If a new external Go dependency is added, or an existing one has its version
bumped in the go.mod file, ensure the BUILD files pick this up by updating
the WORKSPACE go_repository rules using the following command:
bazel run //:gazelle -- update-repos --from_file=go.mod