zenml-nightly 0.67.0.dev20241002__py3-none-any.whl → 0.68.0.dev20241027__py3-none-any.whl

zenml/zen_server/deploy/terraform/recipes/gcp/zen_server.tf

@@ -1,114 +0,0 @@
-# create the ZenServer deployment
-resource "kubernetes_namespace" "zen-server" {
-  metadata {
-    name = "${var.name}-${var.namespace}"
-  }
-}
-
-# enable secret manager
-resource "google_project_service" "secret_manager" {
-  count = var.enable_secrets_manager_api ? 1 : 0
-  project = var.project_id
-  service = "secretmanager.googleapis.com"
-
-  disable_on_destroy = false
-}
-
-resource "helm_release" "zen-server" {
-
-  name      = "${var.name}-zenmlserver"
-  chart     = var.helm_chart
-  namespace = kubernetes_namespace.zen-server.metadata[0].name
-
-  set {
-    name  = "zenml.image.repository"
-    value = var.zenmlserver_image_repo
-  }
-  set {
-    name = "zenml.image.tag"
-    value = var.zenmlserver_image_tag
-  }
-
-  set {
-    name  = "zenml.deploymentType"
-    value = "gcp"
-  }
-
-  set {
-    name  = "zenml.secretsStore.type"
-    value = var.enable_secrets_manager_api? "gcp" : "sql"
-  }
-  set {
-    name  = "zenml.secretsStore.gcp.project_idd"
-    value = var.project_id
-
-  }
-
-  set {
-    name = "zenml.analyticsOptIn"
-    value = var.analytics_opt_in
-  }
-
-  # set up the right path for ZenML
-  set {
-    name  = "zenml.ingress.annotations.nginx\\.ingress\\.kubernetes\\.io/rewrite-target"
-    value = ""
-  }
-  set {
-    name  = "zenml.ingress.host"
-    value = var.create_ingress_controller ? "zenml.${data.kubernetes_service.ingress-controller[0].status.0.load_balancer.0.ingress.0.ip}.nip.io" : "zenml.${var.ingress_controller_ip}.nip.io"
-  }
-  set {
-    name  = "zenml.ingress.tls.enabled"
-    value = var.ingress_tls
-  }
-  set {
-    name  = "zenml.ingress.tls.generateCerts"
-    value = var.ingress_tls_generate_certs
-  }
-  set {
-    name  = "zenml.ingress.tls.secretName"
-    value = "${var.name}-${var.ingress_tls_secret_name}"
-  }
-
-  # set parameters for the mysql database
-  set {
-    name  = "zenml.database.url"
-    value = var.deploy_db ? "mysql://${var.database_username}:${module.metadata_store[0].generated_user_password}@${module.metadata_store[0].instance_first_ip_address}:3306/${var.db_name}" : var.database_url
-  }
-  set {
-    name  = "zenml.database.sslCa"
-    value = var.deploy_db ? "" : var.database_ssl_ca
-  }
-  set {
-    name  = "zenml.database.sslCert"
-    value = var.deploy_db ? "" : var.database_ssl_cert
-  }
-  set {
-    name  = "zenml.database.sslKey"
-    value = var.deploy_db ? "" : var.database_ssl_key
-  }
-  set {
-    name  = "zenml.database.sslVerifyServerCert"
-    value = var.deploy_db ? false : var.database_ssl_verify_server_cert
-  }
-  depends_on = [
-    resource.kubernetes_namespace.zen-server
-  ]
-}
-
-data "kubernetes_secret" "certificates" {
-  metadata {
-    name      = "${var.name}-${var.ingress_tls_secret_name}"
-    namespace = "${var.name}-${var.namespace}"
-  }
-  binary_data = {
-    "tls.crt" = ""
-    "tls.key" = ""
-    "ca.crt"  = ""
-  }
-
-  depends_on = [
-    helm_release.zen-server
-  ]
-}

zenml/zen_server/deploy/terraform/terraform_zen_server.py

@@ -1,246 +0,0 @@
-#  Copyright (c) ZenML GmbH 2022. All Rights Reserved.
-#
-#  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:
-#
-#       https://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.
-"""Service implementation for the ZenML terraform server deployment."""
-
-import json
-import os
-from pathlib import Path
-from typing import Any, Dict, Optional, cast
-from uuid import UUID
-
-from pydantic import ConfigDict
-
-from zenml.logger import get_logger
-from zenml.services import ServiceType
-from zenml.services.terraform.terraform_service import (
-    TerraformService,
-    TerraformServiceConfig,
-)
-from zenml.utils.io_utils import get_global_config_directory
-from zenml.zen_server.deploy.deployment import ServerDeploymentConfig
-
-logger = get_logger(__name__)
-
-ZEN_SERVER_HEALTHCHECK_URL_PATH = "health"
-
-TERRAFORM_ZENML_SERVER_CONFIG_SUBPATH = os.path.join(
-    "zen_server",
-    "terraform",
-)
-
-TERRAFORM_ZENML_SERVER_CONFIG_PATH = os.path.join(
-    get_global_config_directory(),
-    TERRAFORM_ZENML_SERVER_CONFIG_SUBPATH,
-)
-TERRAFORM_ZENML_SERVER_CONFIG_FILENAME = os.path.join(
-    TERRAFORM_ZENML_SERVER_CONFIG_PATH, "service.json"
-)
-TERRAFORM_ZENML_SERVER_RECIPE_SUBPATH = "recipes"
-TERRAFORM_VALUES_FILE_PATH = "values.tfvars.json"
-TERRAFORM_DEPLOYED_ZENSERVER_OUTPUT_URL = "zenml_server_url"
-TERRAFORM_DEPLOYED_ZENSERVER_OUTPUT_TLS_CRT = "tls_crt"
-TERRAFORM_DEPLOYED_ZENSERVER_OUTPUT_TLS_KEY = "tls_key"
-TERRAFORM_DEPLOYED_ZENSERVER_OUTPUT_CA_CRT = "ca_crt"
-
-TERRAFORM_ZENML_SERVER_DEFAULT_TIMEOUT = 60
-
-
-ZENML_HELM_CHART_SUBPATH = "helm"
-
-
-def get_helm_chart_path() -> str:
-    """Get the ZenML server helm chart path.
-
-    The ZenML server helm chart files are located in a folder relative to the
-    `zenml.zen_server.deploy` Python module.
-
-    Returns:
-        The helm chart path.
-    """
-    import zenml.zen_server.deploy as deploy_module
-
-    path = os.path.join(
-        os.path.dirname(deploy_module.__file__),
-        ZENML_HELM_CHART_SUBPATH,
-    )
-    return path
-
-
-class TerraformServerDeploymentConfig(ServerDeploymentConfig):
-    """Terraform server deployment configuration.
-
-    Attributes:
-        log_level: The log level to set the terraform client to. Choose one of
-            TRACE, DEBUG, INFO, WARN or ERROR (case insensitive).
-        helm_chart: The path to the ZenML server helm chart to use for
-            deployment.
-        zenmlserver_image_repo: The repository to use for the zenml server.
-        zenmlserver_image_tag: The tag to use for the zenml server docker
-            image.
-        namespace: The Kubernetes namespace to deploy the ZenML server to.
-        kubectl_config_path: The path to the kubectl config file to use for
-            deployment.
-        ingress_tls: Whether to use TLS for the ingress.
-        ingress_tls_generate_certs: Whether to generate self-signed TLS
-            certificates for the ingress.
-        ingress_tls_secret_name: The name of the Kubernetes secret to use for
-            the ingress.
-        create_ingress_controller: Whether to deploy an nginx ingress
-            controller as part of the deployment.
-        ingress_controller_ip: The ingress controller IP to use for
-            the ingress self-signed certificate and to compute the ZenML server
-            URL.
-        deploy_db: Whether to create a SQL database service as part of the recipe.
-        database_username: The username for the database.
-        database_password: The password for the database.
-        database_url: The URL of the RDS instance to use for the ZenML server.
-        database_ssl_ca: The path to the SSL CA certificate to use for the
-            database connection.
-        database_ssl_cert: The path to the client SSL certificate to use for the
-            database connection.
-        database_ssl_key: The path to the client SSL key to use for the
-            database connection.
-        database_ssl_verify_server_cert: Whether to verify the database server
-            SSL certificate.
-        analytics_opt_in: Whether to enable analytics.
-    """
-
-    log_level: str = "ERROR"
-
-    helm_chart: str = get_helm_chart_path()
-    zenmlserver_image_repo: str = "zenmldocker/zenml-server"
-    zenmlserver_image_tag: str = "latest"
-    namespace: str = "zenmlserver"
-    kubectl_config_path: str = os.path.join(
-        str(Path.home()), ".kube", "config"
-    )
-    ingress_tls: bool = False
-    ingress_tls_generate_certs: bool = True
-    ingress_tls_secret_name: str = "zenml-tls-certs"
-    create_ingress_controller: bool = True
-    ingress_controller_ip: str = ""
-    deploy_db: bool = True
-    database_username: str = "user"
-    database_password: str = ""
-    database_url: str = ""
-    database_ssl_ca: str = ""
-    database_ssl_cert: str = ""
-    database_ssl_key: str = ""
-    database_ssl_verify_server_cert: bool = True
-    analytics_opt_in: bool = True
-    model_config = ConfigDict(extra="allow")
-
-
-class TerraformZenServerConfig(TerraformServiceConfig):
-    """Terraform Zen server configuration.
-
-    Attributes:
-        server: The deployment configuration.
-    """
-
-    server: TerraformServerDeploymentConfig
-    copy_terraform_files: bool = True
-
-
-class TerraformZenServer(TerraformService):
-    """Service that can be used to start a terraform ZenServer.
-
-    Attributes:
-        config: service configuration
-        endpoint: service endpoint
-    """
-
-    SERVICE_TYPE = ServiceType(
-        name="terraform_zenml_server",
-        type="zen_server",
-        flavor="terraform",
-        description="Terraform ZenML server deployment",
-    )
-
-    config: TerraformZenServerConfig
-
-    @classmethod
-    def get_service(cls) -> Optional["TerraformZenServer"]:
-        """Load and return the terraform ZenML server service, if present.
-
-        Returns:
-            The terraform ZenML server service or None, if the terraform server
-            deployment is not found.
-        """
-        try:
-            with open(TERRAFORM_ZENML_SERVER_CONFIG_FILENAME, "r") as f:
-                return cast(
-                    TerraformZenServer, TerraformZenServer.from_json(f.read())
-                )
-        except FileNotFoundError:
-            return None
-
-    def get_vars(self) -> Dict[str, Any]:
-        """Get variables as a dictionary.
-
-        Returns:
-            A dictionary of variables to use for the Terraform deployment.
-        """
-        # get the contents of the server deployment config as dict
-        filter_vars = ["log_level", "provider"]
-        # filter keys that are not modeled as terraform deployment vars
-        vars = {
-            k: str(v) if isinstance(v, UUID) else v
-            for k, v in self.config.server.model_dump().items()
-            if k not in filter_vars
-        }
-        assert self.status.runtime_path
-
-        with open(
-            os.path.join(
-                self.status.runtime_path, self.config.variables_file_path
-            ),
-            "w",
-        ) as fp:
-            json.dump(vars, fp, indent=4)
-
-        return vars
-
-    def provision(self) -> None:
-        """Provision the service."""
-        super().provision()
-        logger.info(
-            f"Your ZenML server is now deployed with URL:\n"
-            f"{self.get_server_url()}"
-        )
-
-    def get_server_url(self) -> str:
-        """Returns the deployed ZenML server's URL.
-
-        Returns:
-            The URL of the deployed ZenML server.
-        """
-        return str(
-            self.terraform_client.output(
-                TERRAFORM_DEPLOYED_ZENSERVER_OUTPUT_URL, full_value=True
-            )
-        )
-
-    def get_certificate(self) -> Optional[str]:
-        """Returns the CA certificate configured for the ZenML server.
-
-        Returns:
-            The CA certificate configured for the ZenML server.
-        """
-        return cast(
-            str,
-            self.terraform_client.output(
-                TERRAFORM_DEPLOYED_ZENSERVER_OUTPUT_CA_CRT, full_value=True
-            ),
-        )