[ResourceCluster Part1] ResourceClustersManager actor + contracts #175
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| /* | ||
| * Copyright 2022 Netflix, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.mantisrx.control.plane.resource.cluster; | ||
|
|
||
| import static akka.pattern.Patterns.pipe; | ||
|
|
||
| import akka.actor.AbstractActorWithTimers; | ||
| import akka.actor.Props; | ||
| import akka.japi.pf.ReceiveBuilder; | ||
| import io.mantisrx.control.plane.resource.cluster.proto.GetResourceClusterSpecRequest; | ||
| import io.mantisrx.control.plane.resource.cluster.proto.ListResourceClusterRequest; | ||
| import io.mantisrx.control.plane.resource.cluster.proto.ProvisionResourceClusterRequest; | ||
| import io.mantisrx.control.plane.resource.cluster.proto.ResourceClusterAPIProto.GetResourceClusterResponse; | ||
| import io.mantisrx.control.plane.resource.cluster.proto.ResourceClusterAPIProto.ListResourceClustersResponse; | ||
| import io.mantisrx.control.plane.resource.cluster.proto.ResourceClusterProvisionSubmissionResponse; | ||
| import io.mantisrx.control.plane.resource.cluster.proto.ScaleResourceRequest; | ||
| import io.mantisrx.control.plane.resource.cluster.resourceprovider.IResourceClusterProvider; | ||
| import io.mantisrx.control.plane.resource.cluster.resourceprovider.IResourceClusterStorageProvider; | ||
| import io.mantisrx.control.plane.resource.cluster.resourceprovider.InMemoryOnlyResourceClusterStorageProvider; | ||
| import io.mantisrx.control.plane.resource.cluster.writable.ResourceClusterSpecWritable; | ||
| import io.mantisrx.master.jobcluster.proto.BaseResponse.ResponseCode; | ||
| import io.mantisrx.shaded.com.google.common.annotations.VisibleForTesting; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.CompletionStage; | ||
| import java.util.stream.Collectors; | ||
| import lombok.extern.slf4j.Slf4j; | ||
|
|
||
| /** | ||
| * This actor is responsible to translate requests for resource cluster related operations from API server and other | ||
| * actors to binded resource cluster provider implementation. | ||
| */ | ||
| @Slf4j | ||
| public class ResourceClustersHostManagerActor extends AbstractActorWithTimers { | ||
|
|
||
| @VisibleForTesting | ||
| static Props props( | ||
| final IResourceClusterProvider resourceClusterProvider) { | ||
| return Props.create( | ||
| ResourceClustersHostManagerActor.class, | ||
| resourceClusterProvider, | ||
| new InMemoryOnlyResourceClusterStorageProvider()); | ||
| } | ||
|
|
||
| public static Props props( | ||
| final IResourceClusterProvider resourceClusterProvider, | ||
| final IResourceClusterStorageProvider resourceStorageProvider) { | ||
| // TODO(andyz): investigate atlas metered-mailbox. | ||
| return Props.create(ResourceClustersHostManagerActor.class, resourceClusterProvider, resourceStorageProvider); | ||
| } | ||
|
|
||
| private final IResourceClusterProvider resourceClusterProvider; | ||
| private final IResourceClusterStorageProvider resourceClusterStorageProvider; | ||
|
|
||
| public ResourceClustersHostManagerActor( | ||
| final IResourceClusterProvider resourceClusterProvider, | ||
| final IResourceClusterStorageProvider resourceStorageProvider) { | ||
| this.resourceClusterProvider = resourceClusterProvider; | ||
| this.resourceClusterStorageProvider = resourceStorageProvider; | ||
| } | ||
|
|
||
| @Override | ||
| public Receive createReceive() { | ||
| return ReceiveBuilder.create() | ||
| .match(ProvisionResourceClusterRequest.class, this::onProvisionResourceClusterRequest) | ||
| .match(ScaleResourceRequest.class, this::onScaleResourceClusterRequest) | ||
| .match(ListResourceClusterRequest.class, this::onListResourceClusterRequest) | ||
| .match(GetResourceClusterSpecRequest.class, this::onGetResourceClusterSpecRequest) | ||
| .match(ResourceClusterProvisionSubmissionResponse.class, this::onResourceClusterProvisionResponse) | ||
| .build(); | ||
| } | ||
|
|
||
| private void onResourceClusterProvisionResponse(ResourceClusterProvisionSubmissionResponse resp) { | ||
| this.resourceClusterProvider.getResponseHandler().handleProvisionResponse(resp); | ||
| } | ||
|
|
||
| private void onListResourceClusterRequest(ListResourceClusterRequest req) { | ||
| pipe(this.resourceClusterStorageProvider.getRegisteredResourceClustersWritable() | ||
| .thenApply(clustersW -> | ||
| ListResourceClustersResponse.builder() | ||
| .responseCode(ResponseCode.SUCCESS) | ||
| .registeredResourceClusters(clustersW.getClusters().entrySet().stream().map( | ||
| kv -> ListResourceClustersResponse.RegisteredResourceCluster.builder() | ||
| .id(kv.getValue().getClusterId()) | ||
| .version(kv.getValue().getVersion()) | ||
| .build()) | ||
| .collect(Collectors.toList())) | ||
| .build() | ||
| ).exceptionally(err -> | ||
| ListResourceClustersResponse.builder() | ||
| .message(err.getMessage()) | ||
| .responseCode(ResponseCode.SERVER_ERROR).build()), | ||
| getContext().dispatcher()) | ||
| .to(getSender()); | ||
| } | ||
|
|
||
| private void onGetResourceClusterSpecRequest(GetResourceClusterSpecRequest req) { | ||
| pipe(this.resourceClusterStorageProvider.getResourceClusterSpecWritable(req.getId()) | ||
| .thenApply(specW -> { | ||
| if (specW == null) { | ||
| return GetResourceClusterResponse.builder() | ||
| .responseCode(ResponseCode.CLIENT_ERROR_NOT_FOUND) | ||
| .build(); | ||
| } | ||
| return GetResourceClusterResponse.builder() | ||
| .responseCode(ResponseCode.SUCCESS) | ||
| .clusterSpec(specW.getClusterSpec()) | ||
| .build(); | ||
| }) | ||
| .exceptionally(err -> | ||
| GetResourceClusterResponse.builder() | ||
| .responseCode(ResponseCode.SERVER_ERROR) | ||
| .message(err.getMessage()) | ||
| .build()), | ||
| getContext().dispatcher()) | ||
| .to(getSender()); | ||
| } | ||
|
|
||
| private void onProvisionResourceClusterRequest(ProvisionResourceClusterRequest req) { | ||
| /* | ||
| For a provision request, the following steps will be taken: | ||
| 1. Persist the cluster request with spec to the resource storage provider. | ||
| 2. Once persisted, reply to sender (e.g. http server route) to confirm the accepted request. | ||
| 3. Queue the long-running provision task via resource cluster provider and register callback to self. | ||
| 4. Handle provision callback and error handling. | ||
| (only logging for now as agent registration will happen directly inside agent). | ||
| */ | ||
| log.info("Entering onProvisionResourceClusterRequest: " + req); | ||
|
|
||
| ResourceClusterSpecWritable specWritable = ResourceClusterSpecWritable.builder() | ||
| .clusterSpec(req.getClusterSpec()) | ||
| .version("") | ||
| .id(req.getClusterId()) | ||
| .build(); | ||
|
|
||
| // Cluster spec is returned for API request. | ||
| CompletionStage<GetResourceClusterResponse> updateSpecToStoreFut = | ||
| this.resourceClusterStorageProvider.registerAndUpdateClusterSpec(specWritable) | ||
| .thenApply(specW -> GetResourceClusterResponse.builder() | ||
| .responseCode(ResponseCode.SUCCESS) | ||
| .clusterSpec(specW.getClusterSpec()) | ||
| .build()) | ||
| .exceptionally(err -> | ||
| GetResourceClusterResponse.builder() | ||
| .responseCode(ResponseCode.SERVER_ERROR) | ||
| .message(err.getMessage()) | ||
| .build()); | ||
| pipe(updateSpecToStoreFut, getContext().dispatcher()).to(getSender()); | ||
| log.debug("[Pipe finish] storing cluster spec."); | ||
|
|
||
| // Provision response is directed back to this actor to handle its submission result. | ||
| CompletionStage<ResourceClusterProvisionSubmissionResponse> provisionFut = | ||
| updateSpecToStoreFut | ||
| .thenCompose(resp -> { | ||
| if (resp.responseCode.equals(ResponseCode.SUCCESS)) { | ||
| return this.resourceClusterProvider.provisionClusterIfNotPresent(req); | ||
| } | ||
| return CompletableFuture.completedFuture( | ||
| ResourceClusterProvisionSubmissionResponse.builder().response(resp.message).build()); | ||
| }) | ||
| .exceptionally(err -> ResourceClusterProvisionSubmissionResponse.builder().error(err).build()); | ||
| pipe(provisionFut, getContext().dispatcher()).to(getSelf()); | ||
| log.debug("[Pipe finish 2]: returned provision fut."); | ||
| } | ||
|
|
||
| private void onScaleResourceClusterRequest(ScaleResourceRequest req) { | ||
| log.info("Entering onScaleResourceClusterRequest: " + req); | ||
| pipe(this.resourceClusterProvider.scaleResource(req), getContext().dispatcher()).to(getSender()); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /* | ||
| * Copyright 2022 Netflix, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.mantisrx.control.plane.resource.cluster.proto; | ||
|
|
||
| import lombok.Builder; | ||
| import lombok.Value; | ||
|
|
||
| @Builder | ||
| @Value | ||
| public class GetResourceClusterSpecRequest { | ||
| String id; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /* | ||
| * Copyright 2022 Netflix, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.mantisrx.control.plane.resource.cluster.proto; | ||
|
|
||
| import lombok.Builder; | ||
| import lombok.Value; | ||
|
|
||
| @Builder | ||
| @Value | ||
| public class ListResourceClusterRequest { | ||
|
Contributor
There was a problem hiding this comment. move these within the actor class.
Collaborator
Author
There was a problem hiding this comment. All these contracts in a single file are going to make it a huge one though? Also, there are composite referenced classes that are already huge by themselves. |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * Copyright 2022 Netflix, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.mantisrx.control.plane.resource.cluster.proto; | ||
|
|
||
| public enum MantisResourceClusterEnvType { | ||
| Default, | ||
| Dev, | ||
| Test, | ||
| Prod | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: maybe we should try to not align the colons given that this is constantly going to change based on the longest module name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think editor config might help streamline these. I will take a look.