Rename app -> stack_orchestrator (#625)

stack_orchestrator/deploy/k8s/cluster_info.py

@@ -0,0 +1,105 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http:#www.gnu.org/licenses/>.
+
+from kubernetes import client
+from typing import Any, List, Set
+
+from stack_orchestrator.opts import opts
+from stack_orchestrator.deploy.k8s.helpers import named_volumes_from_pod_files, volume_mounts_for_service, volumes_for_pod_files
+from stack_orchestrator.deploy.k8s.helpers import parsed_pod_files_map_from_file_names
+
+
+class ClusterInfo:
+    parsed_pod_yaml_map: Any = {}
+    image_set: Set[str] = set()
+    app_name: str = "test-app"
+    deployment_name: str = "test-deployment"
+
+    def __init__(self) -> None:
+        pass
+
+    def int_from_pod_files(self, pod_files: List[str]):
+        self.parsed_pod_yaml_map = parsed_pod_files_map_from_file_names(pod_files)
+        # Find the set of images in the pods
+        for pod_name in self.parsed_pod_yaml_map:
+            pod = self.parsed_pod_yaml_map[pod_name]
+            services = pod["services"]
+            for service_name in services:
+                service_info = services[service_name]
+                image = service_info["image"]
+                self.image_set.add(image)
+        if opts.o.debug:
+            print(f"image_set: {self.image_set}")
+
+    def get_pvcs(self):
+        result = []
+        volumes = named_volumes_from_pod_files(self.parsed_pod_yaml_map)
+        if opts.o.debug:
+            print(f"Volumes: {volumes}")
+        for volume_name in volumes:
+            spec = client.V1PersistentVolumeClaimSpec(
+                storage_class_name="standard",
+                access_modes=["ReadWriteOnce"],
+                resources=client.V1ResourceRequirements(
+                    requests={"storage": "2Gi"}
+                )
+            )
+            pvc = client.V1PersistentVolumeClaim(
+                metadata=client.V1ObjectMeta(name=volume_name,
+                                             labels={"volume-label": volume_name}),
+                spec=spec,
+            )
+            result.append(pvc)
+        return result
+
+    # to suit the deployment, and also annotate the container specs to point at said volumes
+    def get_deployment(self):
+        containers = []
+        for pod_name in self.parsed_pod_yaml_map:
+            pod = self.parsed_pod_yaml_map[pod_name]
+            services = pod["services"]
+            for service_name in services:
+                container_name = service_name
+                service_info = services[service_name]
+                image = service_info["image"]
+                volume_mounts = volume_mounts_for_service(self.parsed_pod_yaml_map, service_name)
+                container = client.V1Container(
+                    name=container_name,
+                    image=image,
+                    ports=[client.V1ContainerPort(container_port=80)],
+                    volume_mounts=volume_mounts,
+                    resources=client.V1ResourceRequirements(
+                        requests={"cpu": "100m", "memory": "200Mi"},
+                        limits={"cpu": "500m", "memory": "500Mi"},
+                    ),
+                )
+                containers.append(container)
+        volumes = volumes_for_pod_files(self.parsed_pod_yaml_map)
+        template = client.V1PodTemplateSpec(
+            metadata=client.V1ObjectMeta(labels={"app": self.app_name}),
+            spec=client.V1PodSpec(containers=containers, volumes=volumes),
+        )
+        spec = client.V1DeploymentSpec(
+            replicas=1, template=template, selector={
+                "matchLabels":
+                {"app": self.app_name}})
+
+        deployment = client.V1Deployment(
+            api_version="apps/v1",
+            kind="Deployment",
+            metadata=client.V1ObjectMeta(name=self.deployment_name),
+            spec=spec,
+        )
+        return deployment

stack_orchestrator/deploy/k8s/deploy_k8s.py

@@ -0,0 +1,128 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http:#www.gnu.org/licenses/>.
+
+from pathlib import Path
+from kubernetes import client, config
+
+from stack_orchestrator.deploy.deployer import Deployer, DeployerConfigGenerator
+from stack_orchestrator.deploy.k8s.helpers import create_cluster, destroy_cluster, load_images_into_kind
+from stack_orchestrator.deploy.k8s.helpers import pods_in_deployment, log_stream_from_string, generate_kind_config
+from stack_orchestrator.deploy.k8s.cluster_info import ClusterInfo
+from stack_orchestrator.opts import opts
+
+
+class K8sDeployer(Deployer):
+    name: str = "k8s"
+    core_api: client.CoreV1Api
+    apps_api: client.AppsV1Api
+    k8s_namespace: str = "default"
+    kind_cluster_name: str
+    cluster_info : ClusterInfo
+
+    def __init__(self, compose_files, compose_project_name, compose_env_file) -> None:
+        if (opts.o.debug):
+            print(f"Compose files: {compose_files}")
+            print(f"Project name: {compose_project_name}")
+            print(f"Env file: {compose_env_file}")
+        self.kind_cluster_name = compose_project_name
+        self.cluster_info = ClusterInfo()
+        self.cluster_info.int_from_pod_files(compose_files)
+
+    def connect_api(self):
+        config.load_kube_config(context=f"kind-{self.kind_cluster_name}")
+        self.core_api = client.CoreV1Api()
+        self.apps_api = client.AppsV1Api()
+
+    def up(self, detach, services):
+        # Create the kind cluster
+        # HACK: pass in the config file path here
+        create_cluster(self.kind_cluster_name, "./test-deployment-dir/kind-config.yml")
+        self.connect_api()
+        # Ensure the referenced containers are copied into kind
+        load_images_into_kind(self.kind_cluster_name, self.cluster_info.image_set)
+        # Figure out the PVCs for this deployment
+        pvcs = self.cluster_info.get_pvcs()
+        for pvc in pvcs:
+            if opts.o.debug:
+                print(f"Sending this: {pvc}")
+            pvc_resp = self.core_api.create_namespaced_persistent_volume_claim(body=pvc, namespace=self.k8s_namespace)
+            if opts.o.debug:
+                print("PVCs created:")
+                print(f"{pvc_resp}")
+        # Process compose files into a Deployment
+        deployment = self.cluster_info.get_deployment()
+        # Create the k8s objects
+        if opts.o.debug:
+            print(f"Sending this: {deployment}")
+        deployment_resp = self.apps_api.create_namespaced_deployment(
+            body=deployment, namespace=self.k8s_namespace
+        )
+        if opts.o.debug:
+            print("Deployment created:")
+            print(f"{deployment_resp.metadata.namespace} {deployment_resp.metadata.name} \
+                  {deployment_resp.metadata.generation} {deployment_resp.spec.template.spec.containers[0].image}")
+
+    def down(self, timeout, volumes):
+        # Delete the k8s objects
+        # Destroy the kind cluster
+        destroy_cluster(self.kind_cluster_name)
+
+    def ps(self):
+        self.connect_api()
+        # Call whatever API we need to get the running container list
+        ret = self.core_api.list_pod_for_all_namespaces(watch=False)
+        if ret.items:
+            for i in ret.items:
+                print("%s\t%s\t%s" % (i.status.pod_ip, i.metadata.namespace, i.metadata.name))
+        ret = self.core_api.list_node(pretty=True, watch=False)
+        return []
+
+    def port(self, service, private_port):
+        # Since we handle the port mapping, need to figure out where this comes from
+        # Also look into whether it makes sense to get ports for k8s
+        pass
+
+    def execute(self, service_name, command, tty, envs):
+        # Call the API to execute a command in a running container
+        pass
+
+    def logs(self, services, tail, follow, stream):
+        self.connect_api()
+        pods = pods_in_deployment(self.core_api, "test-deployment")
+        if len(pods) > 1:
+            print("Warning: more than one pod in the deployment")
+        k8s_pod_name = pods[0]
+        log_data = self.core_api.read_namespaced_pod_log(k8s_pod_name, namespace="default", container="test")
+        return log_stream_from_string(log_data)
+
+    def run(self, image, command, user, volumes, entrypoint=None):
+        # We need to figure out how to do this -- check why we're being called first
+        pass
+
+
+class K8sDeployerConfigGenerator(DeployerConfigGenerator):
+    config_file_name: str = "kind-config.yml"
+
+    def __init__(self) -> None:
+        super().__init__()
+
+    def generate(self, deployment_dir: Path):
+        # Check the file isn't already there
+        # Get the config file contents
+        content = generate_kind_config(deployment_dir)
+        config_file = deployment_dir.joinpath(self.config_file_name)
+        # Write the file
+        with open(config_file, "w") as output_file:
+            output_file.write(content)

stack_orchestrator/deploy/k8s/helpers.py

@@ -0,0 +1,212 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http:#www.gnu.org/licenses/>.
+
+from kubernetes import client
+from pathlib import Path
+import subprocess
+from typing import Any, Set
+
+from stack_orchestrator.opts import opts
+from stack_orchestrator.util import get_yaml
+
+
+def _run_command(command: str):
+    if opts.o.debug:
+        print(f"Running: {command}")
+    result = subprocess.run(command, shell=True)
+    if opts.o.debug:
+        print(f"Result: {result}")
+
+
+def create_cluster(name: str, config_file: str):
+    _run_command(f"kind create cluster --name {name} --config {config_file}")
+
+
+def destroy_cluster(name: str):
+    _run_command(f"kind delete cluster --name {name}")
+
+
+def load_images_into_kind(kind_cluster_name: str, image_set: Set[str]):
+    for image in image_set:
+        _run_command(f"kind load docker-image {image} --name {kind_cluster_name}")
+
+
+def pods_in_deployment(core_api: client.CoreV1Api, deployment_name: str):
+    pods = []
+    pod_response = core_api.list_namespaced_pod(namespace="default", label_selector="app=test-app")
+    if opts.o.debug:
+        print(f"pod_response: {pod_response}")
+    for pod_info in pod_response.items:
+        pod_name = pod_info.metadata.name
+        pods.append(pod_name)
+    return pods
+
+
+def log_stream_from_string(s: str):
+    # Note response has to be UTF-8 encoded because the caller expects to decode it
+    yield ("ignore", s.encode())
+
+
+def named_volumes_from_pod_files(parsed_pod_files):
+    # Parse the compose files looking for named volumes
+    named_volumes = []
+    for pod in parsed_pod_files:
+        parsed_pod_file = parsed_pod_files[pod]
+        if "volumes" in parsed_pod_file:
+            volumes = parsed_pod_file["volumes"]
+            for volume in volumes.keys():
+                # Volume definition looks like:
+                # 'laconicd-data': None
+                named_volumes.append(volume)
+    return named_volumes
+
+
+def volume_mounts_for_service(parsed_pod_files, service):
+    result = []
+    # Find the service
+    for pod in parsed_pod_files:
+        parsed_pod_file = parsed_pod_files[pod]
+        if "services" in parsed_pod_file:
+            services = parsed_pod_file["services"]
+            for service_name in services:
+                if service_name == service:
+                    service_obj = services[service_name]
+                    if "volumes" in service_obj:
+                        volumes = service_obj["volumes"]
+                        for mount_string in volumes:
+                            # Looks like: test-data:/data
+                            (volume_name, mount_path) = mount_string.split(":")
+                            volume_device = client.V1VolumeMount(mount_path=mount_path, name=volume_name)
+                            result.append(volume_device)
+    return result
+
+
+def volumes_for_pod_files(parsed_pod_files):
+    result = []
+    for pod in parsed_pod_files:
+        parsed_pod_file = parsed_pod_files[pod]
+        if "volumes" in parsed_pod_file:
+            volumes = parsed_pod_file["volumes"]
+            for volume_name in volumes.keys():
+                claim = client.V1PersistentVolumeClaimVolumeSource(claim_name=volume_name)
+                volume = client.V1Volume(name=volume_name, persistent_volume_claim=claim)
+                result.append(volume)
+    return result
+
+
+def _get_host_paths_for_volumes(parsed_pod_files):
+    result = {}
+    for pod in parsed_pod_files:
+        parsed_pod_file = parsed_pod_files[pod]
+        if "volumes" in parsed_pod_file:
+            volumes = parsed_pod_file["volumes"]
+            for volume_name in volumes.keys():
+                volume_definition = volumes[volume_name]
+                host_path = volume_definition["driver_opts"]["device"]
+                result[volume_name] = host_path
+    return result
+
+
+def parsed_pod_files_map_from_file_names(pod_files):
+    parsed_pod_yaml_map : Any = {}
+    for pod_file in pod_files:
+        with open(pod_file, "r") as pod_file_descriptor:
+            parsed_pod_file = get_yaml().load(pod_file_descriptor)
+            parsed_pod_yaml_map[pod_file] = parsed_pod_file
+    if opts.o.debug:
+        print(f"parsed_pod_yaml_map: {parsed_pod_yaml_map}")
+    return parsed_pod_yaml_map
+
+
+def _generate_kind_mounts(parsed_pod_files):
+    volume_definitions = []
+    volume_host_path_map = _get_host_paths_for_volumes(parsed_pod_files)
+    for pod in parsed_pod_files:
+        parsed_pod_file = parsed_pod_files[pod]
+        if "services" in parsed_pod_file:
+            services = parsed_pod_file["services"]
+            for service_name in services:
+                service_obj = services[service_name]
+                if "volumes" in service_obj:
+                    volumes = service_obj["volumes"]
+                    for mount_string in volumes:
+                        # Looks like: test-data:/data
+                        (volume_name, mount_path) = mount_string.split(":")
+                        volume_definitions.append(
+                            f"  - hostPath: {volume_host_path_map[volume_name]}\n    containerPath: /var/local-path-provisioner"
+                            )
+    return (
+        "" if len(volume_definitions) == 0 else (
+            "  extraMounts:\n"
+            f"{''.join(volume_definitions)}"
+        )
+    )
+
+
+def _generate_kind_port_mappings(parsed_pod_files):
+    port_definitions = []
+    for pod in parsed_pod_files:
+        parsed_pod_file = parsed_pod_files[pod]
+        if "services" in parsed_pod_file:
+            services = parsed_pod_file["services"]
+            for service_name in services:
+                service_obj = services[service_name]
+                if "ports" in service_obj:
+                    ports = service_obj["ports"]
+                    for port_string in ports:
+                        # TODO handle the complex cases
+                        # Looks like: 80 or something more complicated
+                        port_definitions.append(f"  - containerPort: {port_string}\n    hostPort: {port_string}")
+    return (
+        "" if len(port_definitions) == 0 else (
+            "  extraPortMappings:\n"
+            f"{''.join(port_definitions)}"
+        )
+    )
+
+
+# This needs to know:
+# The service ports for the cluster
+# The bind mounted volumes for the cluster
+#
+# Make ports like this:
+#  extraPortMappings:
+#  - containerPort: 80
+#    hostPort: 80
+#    # optional: set the bind address on the host
+#    # 0.0.0.0 is the current default
+#    listenAddress: "127.0.0.1"
+#    # optional: set the protocol to one of TCP, UDP, SCTP.
+#    # TCP is the default
+#    protocol: TCP
+# Make bind mounts like this:
+#  extraMounts:
+#  - hostPath: /path/to/my/files
+#    containerPath: /files
+def generate_kind_config(deployment_dir: Path):
+    compose_file_dir = deployment_dir.joinpath("compose")
+    # TODO: this should come from the stack file, not this way
+    pod_files = [p for p in compose_file_dir.iterdir() if p.is_file()]
+    parsed_pod_files_map = parsed_pod_files_map_from_file_names(pod_files)
+    port_mappings_yml = _generate_kind_port_mappings(parsed_pod_files_map)
+    mounts_yml = _generate_kind_mounts(parsed_pod_files_map)
+    return (
+        "kind: Cluster\n"
+        "apiVersion: kind.x-k8s.io/v1alpha4\n"
+        "nodes:\n"
+        "- role: control-plane\n"
+        f"{port_mappings_yml}\n"
+        f"{mounts_yml}\n"
+    )