uffizzi_core 2.2.23 → 2.2.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 173a91720da5a1063dd5db63c18c0232a5621dd68b77a120b81341aafba4c2a8
-  data.tar.gz: 03f50a4669fe8688f0e3d280b0589c5123f39ad710cf24d09bdaea19235cc9d3
+  metadata.gz: 70847fae8bc28249be5879f8496e7436e05079077dc23ad53394d08676158be6
+  data.tar.gz: 2ac3e45d651e069f5e11b69b022efa285c5f0c0f176fb5a17c0bc58c3d4dad88
 SHA512:
-  metadata.gz: 75934782b7e324fa161b9968efe45454e3483f791980ba85b8342a8c93ce49951483d06250154fdba2bf212aa8ea5794531d90afcf1039825f4d4ddfc8917c82
-  data.tar.gz: a5c73682a9152c98c1801379c91c72fbf66212b429d9412d240731f80181d21b91349cdda6e02d51e5616a1968ebb5ea5c99baec830aa1e3fd7cd3e441078b15
+  metadata.gz: c128f0afe2384d0763597a9bbc3977748282a454a7d6396680b6f6642f00aa3b6ea32ee0d6c1125846338fec29e8ec02a0bf135d16943a3a2f3ff1f7caf5e797
+  data.tar.gz: 8a0877404587daa608bb636f6500c03578d711ab7cb8e58db97ed9cb663114374cef6f8a619f6dbc9a5c0c0ac3fe4478bf559f53df1c3b6f266d3820f7661f3c

data/app/clients/uffizzi_core/controller_client.rb

@@ -78,6 +78,10 @@ class UffizziCore::ControllerClient
     get("/namespaces/#{namespace}/cluster/#{name}")
   end
 
+  def patch_cluster(name:, namespace:, body:)
+    patch("/namespaces/#{namespace}/cluster/#{name}", body)
+  end
+
   private
 
   def get(url, params = {})
@@ -88,6 +92,10 @@ class UffizziCore::ControllerClient
     make_request(:post, url, params)
   end
 
+  def patch(url, params = {})
+    make_request(:patch, url, params)
+  end
+
   def make_request(method, url, params)
     response = connection.send(method, url, params)
     body = response.body

data/app/controllers/uffizzi_core/api/cli/v1/projects/clusters_controller.rb

@@ -11,13 +11,18 @@ class UffizziCore::Api::Cli::V1::Projects::ClustersController < UffizziCore::Api
     clusters = resource_project.clusters.enabled
     return respond_with clusters if request_by_admin? || valid_request_from_ci_workflow?
 
-    respond_with clusters.deployed_by_user(current_user)
+    respond_with clusters.deployed_by_user(current_user), each_serializer: UffizziCore::Api::Cli::V1::Projects::ShortClusterSerializer
   end
 
   def create
+    version = cluster_params[:k8s_version]
+    kubernetes_distribution = find_kubernetes_distribution(version)
+    return render_distribution_version_error(version) if kubernetes_distribution.blank?
+
     cluster_form = UffizziCore::Api::Cli::V1::Cluster::CreateForm.new(cluster_params)
     cluster_form.project = resource_project
     cluster_form.deployed_by = current_user
+    cluster_form.kubernetes_distribution = kubernetes_distribution
     return respond_with cluster_form unless cluster_form.save
 
     UffizziCore::ClusterService.start_deploy(cluster_form)
@@ -25,6 +30,32 @@ class UffizziCore::Api::Cli::V1::Projects::ClustersController < UffizziCore::Api
     respond_with cluster_form
   end
 
+  def scale_down
+    if resource_cluster.deployed?
+      UffizziCore::ClusterService.scale_down!(resource_cluster)
+      return respond_with resource_cluster
+    end
+
+    return render_scale_error(I18n.t('cluster.already_asleep', name: resource_cluster.name)) if resource_cluster.scaled_down?
+
+    if resource_cluster.deploying_namespace? || resource_cluster.deploying?
+      render_scale_error(I18n.t('cluster.deploy_in_process', name: resource_cluster.name))
+    end
+  rescue AASM::InvalidTransition, UffizziCore::ClusterScaleError => e
+    render_scale_error(e.message)
+  end
+
+  def scale_up
+    if resource_cluster.scaled_down?
+      UffizziCore::ClusterService.scale_up!(resource_cluster)
+      return respond_with resource_cluster
+    end
+
+    return render_scale_error(I18n.t('cluster.already_awake', name: resource_cluster.name)) if resource_cluster.deployed?
+  rescue AASM::InvalidTransition, UffizziCore::ClusterScaleError => e
+    render_scale_error(e.message)
+  end
+
   def show
     respond_with resource_cluster
   end
@@ -57,4 +88,20 @@ class UffizziCore::Api::Cli::V1::Projects::ClustersController < UffizziCore::Api
   def cluster_params
     params.require(:cluster)
   end
+
+  def render_scale_error(message)
+    render json: { errors: { state: [message] } }, status: :unprocessable_entity
+  end
+
+  def find_kubernetes_distribution(version)
+    return UffizziCore::KubernetesDistribution.default if version.blank?
+
+    UffizziCore::KubernetesDistribution.find_by(version: version)
+  end
+
+  def render_distribution_version_error(version)
+    available_versions = UffizziCore::KubernetesDistribution.pluck(:version).join(', ')
+    message = I18n.t('kubernetes_distribution.not_available', version: version, available_versions: available_versions)
+    render json: { errors: { kubernetes_distribution: [message] } }, status: :unprocessable_entity
+  end
 end

data/app/errors/uffizzi_core/cluster_scale_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class UffizziCore::ClusterScaleError < StandardError
+  def initialize(action)
+    message = I18n.t('cluster.scaling_failed', action: action)
+
+    super(message)
+  end
+end

data/app/jobs/uffizzi_core/cluster/manage_scaling_down_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class UffizziCore::Cluster::ManageScalingDownJob < UffizziCore::ApplicationJob
+  sidekiq_options queue: :clusters, retry: Settings.default_job_retry_count
+
+  def perform(id)
+    cluster = UffizziCore::Cluster.find(id)
+
+    UffizziCore::ClusterService.manage_scale_down(cluster)
+  end
+end

data/app/jobs/uffizzi_core/cluster/manage_scaling_up_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class UffizziCore::Cluster::ManageScalingUpJob < UffizziCore::ApplicationJob
+  sidekiq_options queue: :clusters, retry: Settings.default_job_retry_count
+
+  def perform(id, try = 1)
+    cluster = UffizziCore::Cluster.find(id)
+
+    UffizziCore::ClusterService.manage_scale_up(cluster, try)
+  end
+end

data/app/lib/uffizzi_core/concerns/models/cluster.rb

@@ -6,6 +6,7 @@ module UffizziCore::Concerns::Models::Cluster
 
   NAMESPACE_PREFIX = 'c'
 
+  # rubocop:disable Metrics/BlockLength
   included do
     include AASM
     extend Enumerize
@@ -20,12 +21,17 @@ module UffizziCore::Concerns::Models::Cluster
     enumerize :creation_source, in: UffizziCore.cluster_creation_sources, scope: true, predicates: true
     attribute :creation_source, :string, default: :manual
     validates :creation_source, presence: true
+    belongs_to :kubernetes_distribution, optional: true
 
     aasm(:state) do
       state :deploying_namespace, initial: true
       state :failed_deploy_namespace
       state :deploying
       state :deployed
+      state :scaling_down
+      state :scaled_down
+      state :scaling_up
+      state :failed_scale_up
       state :failed
       state :disabled
 
@@ -41,12 +47,40 @@ module UffizziCore::Concerns::Models::Cluster
         transitions from: [:deploying], to: :deployed
       end
 
+      event :start_scaling_down do
+        transitions from: [:deployed], to: :scaling_down
+      end
+
+      event :scale_down do
+        transitions from: [:scaling_down], to: :scaled_down
+      end
+
+      event :start_scaling_up do
+        transitions from: [:scaled_down, :failed_scale_up], to: :scaling_up
+      end
+
+      event :scale_up do
+        transitions from: [:scaling_up], to: :deployed
+      end
+
+      event :fail_scale_up do
+        transitions from: [:scaling_up], to: :failed_scale_up
+      end
+
       event :fail do
         transitions from: [:deploying], to: :failed
       end
 
       event :disable, after: :after_disable do
-        transitions from: [:deploying_namespace, :failed_deploy_namespace, :deploying, :deployed, :failed], to: :disabled
+        transitions from: [
+          :deploying_namespace,
+          :failed_deploy_namespace,
+          :deploying,
+          :deployed,
+          :scaling_down,
+          :scaled_down,
+          :failed,
+        ], to: :disabled
       end
     end
 
@@ -58,4 +92,5 @@ module UffizziCore::Concerns::Models::Cluster
       [NAMESPACE_PREFIX, id].join
     end
   end
+  # rubocop:enable Metrics/BlockLength
 end

data/app/lib/uffizzi_core/concerns/models/kubernetes_distribution.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module UffizziCore::Concerns::Models::KubernetesDistribution
+  extend ActiveSupport::Concern
+
+  included do
+    self.table_name = UffizziCore.table_names[:kubernetes_distributions]
+
+    has_many :clusters
+
+    def self.default
+      find_by(default: true)
+    end
+  end
+end

data/app/models/uffizzi_core/kubernetes_distribution.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class UffizziCore::KubernetesDistribution < UffizziCore::ApplicationRecord
+  include UffizziCore::Concerns::Models::KubernetesDistribution
+end

data/app/policies/uffizzi_core/api/cli/v1/projects/clusters_policy.rb

@@ -13,6 +13,14 @@ class UffizziCore::Api::Cli::V1::Projects::ClustersPolicy < UffizziCore::Applica
     context.user_access_module.admin_or_developer_access_to_project?(context.user, context.project)
   end
 
+  def scale_down?
+    context.user_access_module.admin_or_developer_access_to_project?(context.user, context.project)
+  end
+
+  def scale_up?
+    context.user_access_module.admin_or_developer_access_to_project?(context.user, context.project)
+  end
+
   def destroy?
     context.user_access_module.admin_or_developer_access_to_project?(context.user, context.project)
   end

data/app/serializers/uffizzi_core/api/cli/v1/projects/cluster_serializer.rb

@@ -3,5 +3,9 @@
 class UffizziCore::Api::Cli::V1::Projects::ClusterSerializer < UffizziCore::BaseSerializer
   type :cluster
 
-  attributes :id, :name, :state, :kubeconfig, :created_at, :host
+  attributes :id, :name, :state, :kubeconfig, :created_at, :host, :k8s_version
+
+  def k8s_version
+    object.kubernetes_distribution&.version || UffizziCore::KubernetesDistribution.default.version
+  end
 end

data/app/serializers/uffizzi_core/api/cli/v1/projects/short_cluster_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class UffizziCore::Api::Cli::V1::Projects::ShortClusterSerializer < UffizziCore::BaseSerializer
+  type :cluster
+
+  attributes :id, :name
+end

data/app/serializers/uffizzi_core/controller/create_cluster/cluster_serializer.rb

@@ -4,11 +4,25 @@ class UffizziCore::Controller::CreateCluster::ClusterSerializer < UffizziCore::B
   include UffizziCore::DependencyInjectionConcern
   include_module_if_exists('UffizziCore::Controller::CreateCluster::ClusterSerializerModule')
 
-  attributes :name, :manifest, :base_ingress_host
+  attributes :name, :manifest, :base_ingress_host, :distro, :image
 
   def base_ingress_host
     managed_dns_zone = controller_settings_service.vcluster(object).managed_dns_zone
 
     [object.namespace, managed_dns_zone].join('.')
   end
+
+  def image
+    kubernetes_distribution.image
+  end
+
+  def distro
+    kubernetes_distribution.distro
+  end
+
+  private
+
+  def kubernetes_distribution
+    @kubernetes_distribution ||= object.kubernetes_distribution
+  end
 end

data/app/serializers/uffizzi_core/controller/update_cluster/cluster_serializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class UffizziCore::Controller::UpdateCluster::ClusterSerializer < UffizziCore::BaseSerializer
+  include UffizziCore::DependencyInjectionConcern
+  include_module_if_exists('UffizziCore::Controller::UpdateCluster::ClusterSerializerModule')
+
+  attributes :name, :manifest, :base_ingress_host
+
+  def base_ingress_host
+    managed_dns_zone = controller_settings_service.vcluster(object).managed_dns_zone
+
+    [object.namespace, managed_dns_zone].join('.')
+  end
+end

data/app/services/uffizzi_core/cluster_service.rb

@@ -24,6 +24,32 @@ class UffizziCore::ClusterService
       UffizziCore::Cluster::ManageDeployingJob.perform_in(5.seconds, cluster.id)
     end
 
+    def scale_up!(cluster)
+      cluster.start_scaling_up!
+      UffizziCore::ControllerService.patch_cluster(cluster, sleep: false)
+      UffizziCore::Cluster::ManageScalingUpJob.perform_in(5.seconds, cluster.id)
+    end
+
+    def manage_scale_up(cluster, try)
+      return cluster.fail_scale_up! if try > Settings.vcluster.max_scale_up_retry_count
+      return cluster.scale_up! if ready?(cluster)
+
+      UffizziCore::Cluster::ManageScalingUpJob.perform_in(5.seconds, cluster.id, ++try)
+    end
+
+    def scale_down!(cluster)
+      cluster.start_scaling_down!
+      UffizziCore::ControllerService.patch_cluster(cluster, sleep: true)
+
+      UffizziCore::Cluster::ManageScalingDownJob.perform_in(5.seconds, cluster.id)
+    end
+
+    def manage_scale_down(cluster)
+      return cluster.scale_down! unless awake?(cluster)
+
+      UffizziCore::Cluster::ManageScalingDownJob.perform_in(5.seconds, cluster.id)
+    end
+
     def manage_deploying(cluster, try)
       return if cluster.disabled?
       return cluster.fail! if try > Settings.vcluster.max_creation_retry_count
@@ -41,5 +67,19 @@ class UffizziCore::ClusterService
 
       UffizziCore::Cluster::ManageDeployingJob.perform_in(5.seconds, cluster.id, ++try)
     end
+
+    private
+
+    def awake?(cluster)
+      data = UffizziCore::ControllerService.show_cluster(cluster)
+
+      !data.status.sleep
+    end
+
+    def ready?(cluster)
+      data = UffizziCore::ControllerService.show_cluster(cluster)
+
+      data.status.ready
+    end
   end
 end

data/app/services/uffizzi_core/controller_service.rb

@@ -110,6 +110,13 @@ class UffizziCore::ControllerService
       controller_client(cluster).delete_cluster(namespace: cluster.namespace)
     end
 
+    def patch_cluster(cluster, sleep:)
+      body = UffizziCore::Controller::UpdateCluster::ClusterSerializer.new(cluster).as_json
+      body[:sleep] = sleep
+
+      controller_client(cluster).patch_cluster(name: cluster.name, namespace: cluster.namespace, body: body)
+    end
+
     private
 
     def check_any_container_has_public_port(containers)

data/config/locales/en.yml

@@ -83,11 +83,20 @@ en:
   deployment:
     invalid_state: Preview with ID deployment-%{id} %{state}
     already_exists: An active deployment already exists
+  
+  cluster:
+    already_asleep: The cluster %{name} is already asleep.
+    already_awake: The cluster %{name} is already awake.
+    scaling_failed: Failed to %{action} cluster.
+    deploy_in_process: Please wait until the cluster %{name} is deployed.
 
   session:
     unsupported_login_type: This type of login is not supported
     unauthorized: Unauthorized
 
+  kubernetes_distribution:
+    not_available: "The k8s version %{version} is not supported. Available version are: %{available_versions}."
+
   enumerize:
     credential:
       type:

data/config/routes.rb

@@ -10,7 +10,12 @@ UffizziCore::Engine.routes.draw do
         resources :projects, only: ['index', 'show', 'destroy'], param: :slug do
           scope module: :projects do
             resource :compose_file, only: ['show', 'create', 'destroy']
-            resources :clusters, only: [:index, :create, :show, :destroy], param: :name
+            resources :clusters, only: [:index, :create, :show, :destroy], param: :name do
+              member do
+                put :scale_down
+                put :scale_up
+              end
+            end
             resources :deployments, only: ['index', 'show', 'create', 'destroy', 'update'] do
               post :deploy_containers, on: :member
               scope module: :deployments do

data/db/migrate/20231009162719_create_uffizzi_core_kubernetes_distributions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateUffizziCoreKubernetesDistributions < ActiveRecord::Migration[6.1]
+  def change
+    create_table :uffizzi_core_kubernetes_distributions do |t|
+      t.string :version
+      t.string :distro
+      t.string :image
+      t.boolean :default, default: false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20231009182412_add_kubernetes_distribution_id_to_uffizzi_core_clusters.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddKubernetesDistributionIdToUffizziCoreClusters < ActiveRecord::Migration[6.1]
+  def change
+    add_column(:uffizzi_core_clusters, :kubernetes_distribution_id, :integer, foreign_key: true)
+  end
+end

data/lib/uffizzi_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UffizziCore
-  VERSION = '2.2.23'
+  VERSION = '2.2.25'
 end

data/lib/uffizzi_core.rb

@@ -66,6 +66,7 @@ module UffizziCore
     host_volume_files: :uffizzi_core_host_volume_files,
     container_host_volume_files: :uffizzi_core_container_host_volume_files,
     deployment_events: :uffizzi_core_deployment_events,
+    kubernetes_distributions: :uffizzi_core_kubernetes_distributions,
   }
   mattr_accessor :user_creation_sources, default: [:system, :online_registration, :google, :sso]
   mattr_accessor :user_project_roles, default: [:admin, :developer, :viewer]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi_core
 version: !ruby/object:Gem::Version
-  version: 2.2.23
+  version: 2.2.25
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -804,6 +804,7 @@ files:
 - app/controllers/uffizzi_core/api/cli/v1/projects_controller.rb
 - app/controllers/uffizzi_core/api/cli/v1/sessions_controller.rb
 - app/controllers/uffizzi_core/application_controller.rb
+- app/errors/uffizzi_core/cluster_scale_error.rb
 - app/errors/uffizzi_core/compose_file/build_error.rb
 - app/errors/uffizzi_core/compose_file/credential_error.rb
 - app/errors/uffizzi_core/compose_file/parse_error.rb
@@ -841,6 +842,8 @@ files:
 - app/jobs/uffizzi_core/cluster/delete_job.rb
 - app/jobs/uffizzi_core/cluster/deploy_job.rb
 - app/jobs/uffizzi_core/cluster/manage_deploying_job.rb
+- app/jobs/uffizzi_core/cluster/manage_scaling_down_job.rb
+- app/jobs/uffizzi_core/cluster/manage_scaling_up_job.rb
 - app/jobs/uffizzi_core/config_file/apply_job.rb
 - app/jobs/uffizzi_core/deployment/create_credential_job.rb
 - app/jobs/uffizzi_core/deployment/create_credentials_job.rb
@@ -865,6 +868,7 @@ files:
 - app/lib/uffizzi_core/concerns/models/deployment_event.rb
 - app/lib/uffizzi_core/concerns/models/event.rb
 - app/lib/uffizzi_core/concerns/models/host_volume_file.rb
+- app/lib/uffizzi_core/concerns/models/kubernetes_distribution.rb
 - app/lib/uffizzi_core/concerns/models/membership.rb
 - app/lib/uffizzi_core/concerns/models/payment.rb
 - app/lib/uffizzi_core/concerns/models/price.rb
@@ -909,6 +913,7 @@ files:
 - app/models/uffizzi_core/deployment_event.rb
 - app/models/uffizzi_core/event.rb
 - app/models/uffizzi_core/host_volume_file.rb
+- app/models/uffizzi_core/kubernetes_distribution.rb
 - app/models/uffizzi_core/membership.rb
 - app/models/uffizzi_core/payment.rb
 - app/models/uffizzi_core/price.rb
@@ -982,6 +987,7 @@ files:
 - app/serializers/uffizzi_core/api/cli/v1/projects/deployments_serializer.rb
 - app/serializers/uffizzi_core/api/cli/v1/projects/deployments_serializer/user_serializer.rb
 - app/serializers/uffizzi_core/api/cli/v1/projects/secret_serializer.rb
+- app/serializers/uffizzi_core/api/cli/v1/projects/short_cluster_serializer.rb
 - app/serializers/uffizzi_core/api/cli/v1/short_project_serializer.rb
 - app/serializers/uffizzi_core/api/cli/v1/user_serializer.rb
 - app/serializers/uffizzi_core/api/cli/v1/user_serializer/account_serializer.rb
@@ -997,6 +1003,7 @@ files:
 - app/serializers/uffizzi_core/controller/deploy_containers/container_serializer/container_host_volume_file_serializer.rb
 - app/serializers/uffizzi_core/controller/deploy_containers/credential_serializer.rb
 - app/serializers/uffizzi_core/controller/deploy_containers/host_volume_file_serializer.rb
+- app/serializers/uffizzi_core/controller/update_cluster/cluster_serializer.rb
 - app/services/uffizzi_core/account_service.rb
 - app/services/uffizzi_core/activity_item_service.rb
 - app/services/uffizzi_core/ci_service.rb
@@ -1088,6 +1095,8 @@ files:
 - db/migrate/20230711101901_add_host_to_clusters.rb
 - db/migrate/20230810140316_add_source_to_uffizzi_core_clusters.rb
 - db/migrate/20230824150022_update_name_constraint_to_projects.rb
+- db/migrate/20231009162719_create_uffizzi_core_kubernetes_distributions.rb
+- db/migrate/20231009182412_add_kubernetes_distribution_id_to_uffizzi_core_clusters.rb
 - db/seeds.rb
 - lib/tasks/uffizzi_core_tasks.rake
 - lib/uffizzi_core.rb