feat: first draft of Infrastructure API and related models

build-logic/project-plugins/src/main/kotlin/com.hedera.fullstack.jpms-modules.gradle.kts

@@ -24,6 +24,7 @@ plugins {
 javaModuleDependencies {
     moduleNameToGA.put("com.hedera.fullstack.junit.support", "com.hedera.fullstack:fullstack-junit-support")
     moduleNameToGA.put("com.hedera.fullstack.test.toolkit", "com.hedera.fullstack:fullstack-test-toolkit")
+    moduleNameToGA.put("com.hedera.fullstack.base.api", "com.hedera.fullstack:fullstack-base-api")
     moduleNameToGA.put("com.hedera.fullstack.readiness.api", "com.hedera.fullstack:fullstack-readiness-api")
     moduleNameToGA.put("com.hedera.fullstack.monitoring.api", "com.hedera.fullstack:fullstack-monitoring-api")
     moduleNameToGA.put("com.hedera.fullstack.validator.api", "com.hedera.fullstack:fullstack-validator-api")

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/providers/InfrastructureManager.java → fullstack-core/fullstack-configuration-api/src/main/java/com/hedera/fullstack/configuration/model/InstallType.java

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
-package com.hedera.fullstack.infrastructure.api.providers;
+package com.hedera.fullstack.configuration.model;
 
-public interface InfrastructureManager {}
+public enum InstallType {
+    NMT,
+    DIRECT_INSTALL
+}

fullstack-core/fullstack-configuration-api/src/main/java/com/hedera/fullstack/configuration/model/NetworkDeploymentConfiguration.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.configuration.model;
+
+/**
+ * A container class to hold all configuration needed to hold the NetworkDeployment
+ */
+public class NetworkDeploymentConfiguration {
+
+    // FUTURE: This class needs to closely reflect what will be passed in values.yaml
+
+    InstallType installType;
+    Topology topology;
+}

fullstack-core/fullstack-configuration-api/src/main/java/com/hedera/fullstack/configuration/model/Node.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.configuration.model;
+
+public record Node(int ram, int cpu, int nodeID, int nodeAccountID) {}

fullstack-core/fullstack-infrastructure-core/src/main/java/com/hedera/fullstack/infrastructure/core/Dummy.java → fullstack-core/fullstack-configuration-api/src/main/java/com/hedera/fullstack/configuration/model/Topology.java

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
-package com.hedera.fullstack.infrastructure.core;
+package com.hedera.fullstack.configuration.model;
 
-public class Dummy {}
+import java.util.List;
+
+public record Topology(List<Node> nodes) {}

fullstack-core/fullstack-configuration-api/src/main/java/module-info.java

@@ -1 +1,3 @@
-module com.hedera.fullstack.configuration.api {}
+module com.hedera.fullstack.configuration.api {
+    exports com.hedera.fullstack.configuration.model;
+}

fullstack-core/fullstack-infrastructure-api/build.gradle.kts

@@ -22,5 +22,6 @@ plugins {
 
 dependencies {
     api(platform(project(":fullstack-bom")))
-    implementation(project(mapOf("path" to ":fullstack-helm-client")))
+    implementation(project(":fullstack-helm-client"))
+    implementation(project(":fullstack-configuration-api"))
 }

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/exceptions/DeploymentLimitReachedException.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.exceptions;
+
+public class DeploymentLimitReachedException extends Exception {}

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/exceptions/InfrastructureException.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.exceptions;
+
+public class InfrastructureException extends Exception {}

fullstack-core/fullstack-resource-generator-api/src/main/java/com/hedera/fullstack/resource/generator/api/Dummy.java → fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/exceptions/InstallationException.java

@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-package com.hedera.fullstack.resource.generator.api;
+package com.hedera.fullstack.infrastructure.api.exceptions;
 
-public class Dummy {}
+public class InstallationException extends Exception {}

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/exceptions/InvalidConfigurationException.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.exceptions;
+
+public class InvalidConfigurationException extends Exception {}

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/exceptions/NetworkDeploymentNotFoundException.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.exceptions;
+
+public class NetworkDeploymentNotFoundException extends Exception {}

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/manager/InfrastructureManager.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.manager;
+
+import com.hedera.fullstack.configuration.model.NetworkDeploymentConfiguration;
+import com.hedera.fullstack.infrastructure.api.exceptions.DeploymentLimitReachedException;
+import com.hedera.fullstack.infrastructure.api.exceptions.InfrastructureException;
+import com.hedera.fullstack.infrastructure.api.exceptions.InvalidConfigurationException;
+import com.hedera.fullstack.infrastructure.api.exceptions.NetworkDeploymentNotFoundException;
+import com.hedera.fullstack.infrastructure.api.model.NetworkDeployment;
+import java.util.List;
+import java.util.concurrent.Future;
+
+/**
+ * InfrastructureManager is the main entry point into infrastructure management for FST <br/>
+ * <br/>
+ * Responsibilities:
+ * <ol>
+ *  <li> Manages the lifecycle of a {@link NetworkDeployment}</li>
+ *  <li> Acts as a registry for all {@link NetworkDeployment}s created by it</li></li>
+ * </ol>
+ *
+ * <hr/>
+ * <strong> About NetworkDeployments </strong>
+ * <p>
+ * A {@link NetworkDeployment} represents all the workloads and their components needed for a Hedera ecosystem. <br/>
+ * Upon instantiation, the {@link NetworkDeployment} object can interact with its workloads and components directly
+ * and does not need {@link InfrastructureManager}.
+ * </p>
+ */
+public interface InfrastructureManager {
+
+    default NetworkDeployment createNetworkDeployment(NetworkDeploymentConfiguration hederaNetwork)
+            throws InvalidConfigurationException, DeploymentLimitReachedException, InfrastructureException {
+        return null;
+    }
+
+    /**
+     * Creates the {@link NetworkDeployment} based on the {@link NetworkDeploymentConfiguration} provided.
+     * This is a long running process, expected time is in the order of a few minutes.
+     * Note: the {@link NetworkDeployment} can be spread across multiple clusters and cloud providers.
+     */
+    Future<NetworkDeployment> createNetworkDeploymentAsync(NetworkDeploymentConfiguration hederaNetwork)
+            throws InvalidConfigurationException, DeploymentLimitReachedException, InfrastructureException;
+
+    /**
+     * List all the {@link NetworkDeployment}s created by this InfrastructureManager
+     * TODO: --> @return a list of {@link NetworkDeployment}s
+     */
+    List<NetworkDeployment> listNetworkDeployments();
+
+    /**
+     * Returns the {@link NetworkDeployment} with the given id
+     * @param id  Unique identifier of the {@link NetworkDeployment}, the implementation
+     *           will usually be a combination of namespace, job name and job id etc.
+     * @return the {@link NetworkDeployment} with the given id
+     * @throws NetworkDeploymentNotFoundException
+     */
+    NetworkDeployment networkDeploymentById(String id) throws NetworkDeploymentNotFoundException;
+
+    /**
+     * Deletes the {@link NetworkDeployment} with the given id and all its workload replicas and components
+     * @param id Unique identifier of the {@link NetworkDeployment}, the implementation
+     *           will usually be a combination of namespace, job name and job id etc.
+     * @return true if the {@link NetworkDeployment} was deleted successfully, false otherwise
+     * @throws NetworkDeploymentNotFoundException
+     */
+    Future<Boolean> deleteNetworkDeployment(String id) throws NetworkDeploymentNotFoundException;
+}

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/model/AbstractWorkload.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.model;
+
+import java.util.List;
+
+public class AbstractWorkload<T extends Workload> implements Workload {
+
+    List<WorkloadReplica<T>> replicas;
+    Cluster cluster;
+
+    @Override
+    public Cluster cluster() {
+        return cluster;
+    }
+
+    @Override
+    public List<WorkloadReplica<T>> replicas() {
+        return replicas;
+    }
+}

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/model/Cluster.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.model;
+
+import com.hedera.fullstack.infrastructure.api.traits.KubernetesAware;
+import java.util.List;
+
+/**
+ * A {@link Cluster}
+ *
+ * <ul>
+ *    <li>is a set of physical or virtual machines which can be used to deploy {@link Workload}s</li>
+ *    <li>can be a public or private cloud, or a bare metal cluster in any geography</li>
+ *    <li>can host a subset of or all of the{@link Workload}s within a {@link NetworkDeployment}</li>
+ *    <li> must be able to expose the {@link Component}s (ones which need) of {@link Workload}s in way that its
+ *    reachable from {@link Component}s hosted on other {@link Cluster}s</li>
+ * </ul>
+ */
+public interface Cluster extends KubernetesAware {
+
+    /**
+     * @return the {@link Workload}s hosted on this {@link Cluster}
+     */
+    List<Workload> listWorkloads();
+
+    /**
+     * @return the {@link Workload} hosted on this {@link Cluster} of the given type
+     */
+    <T extends Workload> T findWorkloadByType(Class<T> workloadType);
+}

fullstack-core/fullstack-infrastructure-api/src/main/java/com/hedera/fullstack/infrastructure/api/model/Component.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2023 Hedera Hashgraph, LLC
+ *
+ * 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 com.hedera.fullstack.infrastructure.api.model;
+
+import com.hedera.fullstack.configuration.model.NetworkDeploymentConfiguration;
+import com.hedera.fullstack.infrastructure.api.traits.Labeled;
+
+// only individual classes will implement PodAware and ServiceAware
+public interface Component extends Labeled {
+
+    // lifecycle
+    // this should be mostly done by helm
+    default void init() {}
+
+    default void configure(NetworkDeploymentConfiguration deploymentNetworkDeploymentConfiguration) {}
+
+    default void destroy() {}
+}