Skip to content

Commit

Permalink
Remove dangling MCAD and InstaScale references
Browse files Browse the repository at this point in the history
Cleanup a few MCAD/InstaScale references missed in c771aae.
  • Loading branch information
dgrove-oss authored and openshift-merge-bot[bot] committed Apr 19, 2024
1 parent b90451c commit abdebf5
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 26 deletions.
10 changes: 0 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,6 @@ The following should be installed in your working environment:
## Basic Overview
The main entrypoint for the operator is `main.go`

The MCAD and InstaScale custom resources are defined under the `api` dir:
- See `mcad_types.go` and `instascale_types.go`

The MCAD and InstaScale resource templates can be found under `config/internal`:
- Sorted under `mcad` and `instascale` subdirs

The code for MCAD/InstaScale resource reconcilliation can be found in the `controllers` dir:
- See `mcad_controller.go` and `instascale_controller.go`

## Building and Deployment
If changes are made in the `api` dir, run: `make manifests`
- This will generate new CRDs and associated files
Expand Down Expand Up @@ -53,7 +44,6 @@ The CodeFlare Operator currently has unit tests and pre-commit checks
- Note that both are required for CI to pass on pull requests

To write and inspect unit tests:
- MCAD and InstaScale unit tests under `mcad_controller_test.go` and `instascale_controller_test.go` in the `controllers` dir
- Unit test functions are defined in `suite_test.go` (with utils in `util/util.go`) in the `controllers dir`
- Test cases defined under `controllers/testdata`

Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# codeflare-operator

Operator for installation and lifecycle management of CodeFlare distributed workload stack, starting with MCAD and InstaScale
Operator for installation and lifecycle management of CodeFlare distributed workload stack.

<!-- Don't delete these comments, they are used to generate Compatibility Matrix table for release automation -->
<!-- Compatibility Matrix start -->
Expand All @@ -9,9 +9,7 @@ CodeFlare Stack Compatibility Matrix
| Component | Version |
|------------------------------|---------------------------------------------------------------------------------------------------|
| CodeFlare Operator | [v1.3.1](https://github.com/project-codeflare/codeflare-operator/releases/tag/v1.3.1) |
| Multi-Cluster App Dispatcher | [v1.40.0](https://github.com/project-codeflare/multi-cluster-app-dispatcher/releases/tag/v1.40.0) |
| CodeFlare-SDK | [v0.15.1](https://github.com/project-codeflare/codeflare-sdk/releases/tag/v0.15.1) |
| InstaScale | [v0.4.0](https://github.com/project-codeflare/instascale/releases/tag/v0.4.0) |
| KubeRay | [v1.0.0](https://github.com/opendatahub-io/kuberay/releases/tag/v1.0.0) |
<!-- Compatibility Matrix end -->

Expand Down Expand Up @@ -90,7 +88,7 @@ The e2e tests can be executed locally by running the following commands:
To properly run e2e tests on disconnected cluster user has to provide additional environment variables to properly configure testing environment:
- `CODEFLARE_TEST_PYTORCH_IMAGE` - image tag for image used to run training job using MCAD
- `CODEFLARE_TEST_PYTORCH_IMAGE` - image tag for image used to run training job
- `CODEFLARE_TEST_RAY_IMAGE` - image tag for Ray cluster image
- `MNIST_DATASET_URL` - URL where MNIST dataset is available
- `PIP_INDEX_URL` - URL where PyPI server with needed dependencies is running
Expand Down Expand Up @@ -118,8 +116,6 @@ For ODH tests additional environment variables are needed:
There may be instances in which a new CodeFlare stack release requires releases of only a subset of the stack components. Examples could be hotfixes for a specific component. In these instances:

1. Build updated components as needed:
- Build and release [MCAD](https://github.com/project-codeflare/multi-cluster-app-dispatcher)
- Build and release [InstaScale](https://github.com/project-codeflare/instascale)
- Build and release [CodeFlare-SDK](https://github.com/project-codeflare/codeflare-sdk)

2. Invoke [tag-and-build.yml](https://github.com/project-codeflare/codeflare-operator/actions/workflows/tag-and-build.yml) GitHub action, this action will create a repository tag, build and push operator image.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,7 @@ spec:
keywords:
- Pipelines
- Scaling
- MCAD
- App
- InstaScale
- Jobs
links:
- name: Codeflare Operator
Expand Down
12 changes: 4 additions & 8 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,10 @@ import (
)

var (
scheme = runtime.NewScheme()
setupLog = ctrl.Log.WithName("setup")
OperatorVersion = "UNKNOWN"
McadVersion = "UNKNOWN"
InstaScaleVersion = "UNKNOWN"
BuildDate = "UNKNOWN"
scheme = runtime.NewScheme()
setupLog = ctrl.Log.WithName("setup")
OperatorVersion = "UNKNOWN"
BuildDate = "UNKNOWN"
)

func init() {
Expand Down Expand Up @@ -90,8 +88,6 @@ func main() {

setupLog.Info("Build info",
"operatorVersion", OperatorVersion,
"mcadVersion", McadVersion,
"instaScaleVersion", InstaScaleVersion,
"date", BuildDate,
)

Expand Down

0 comments on commit abdebf5

Please sign in to comment.