[PoC] Implement RFC Improve Stack management

https://github.com/cloudfoundry/community/pull/1220/files

Author: FloThinksPi

app/actions/build_create.rb

@@ -45,6 +45,7 @@ def create_and_stage(package:, lifecycle:, metadata: nil, start_after_staging: f
       raise InvalidPackage.new('Cannot stage package whose state is not ready.') if package.state != PackageModel::READY_STATE
 
       requested_buildpacks_disabled!(lifecycle)
+      validate_stack!(lifecycle, package)
 
       staging_details                     = get_staging_details(package, lifecycle)
       staging_details.start_after_staging = start_after_staging
@@ -74,11 +75,13 @@ def create_and_stage(package:, lifecycle:, metadata: nil, start_after_staging: f
 
         Repositories::AppUsageEventRepository.new.create_from_build(build, 'STAGING_STARTED')
         app = package.app
-        Repositories::BuildEventRepository.record_build_create(build,
-                                                               @user_audit_info,
-                                                               app.name,
-                                                               app.space_guid,
-                                                               app.organization_guid)
+        Repositories::BuildEventRepository.record_build_create(
+          build,
+          @user_audit_info,
+          app.name,
+          app.space_guid,
+          app.organization_guid
+        )
       end
 
       logger.info("build created: #{build.guid}")
@@ -93,6 +96,22 @@ def create_and_stage(package:, lifecycle:, metadata: nil, start_after_staging: f
 
     private
 
+    def validate_stack!(lifecycle, package)
+      return unless lifecycle.type == Lifecycles::BUILDPACK
+
+      stack = Stack.find(name: lifecycle.staging_stack)
+      return unless stack
+
+      case stack.state
+      when 'DEPRECATED'
+        logger.warn("Stack '#{stack.name}' is deprecated. #{stack.description}")
+      when 'LOCKED'
+        raise CloudController::Errors::ApiError.new_from_details('StackLocked', stack.name, stack.description) if package.app.processes.empty?
+      when 'DISABLED'
+        raise CloudController::Errors::ApiError.new_from_details('StackDisabled', stack.name, stack.description)
+      end
+    end
+
     def requested_buildpacks_disabled!(lifecycle)
       return if lifecycle.type == Lifecycles::DOCKER
 

app/actions/stack_create.rb

@@ -6,7 +6,8 @@ class Error < ::StandardError
     def create(message)
       stack = VCAP::CloudController::Stack.create(
         name: message.name,
-        description: message.description
+        description: message.description,
+        state: message.state
       )
 
       MetadataUpdate.update(stack, message)

app/actions/stack_update.rb

@@ -9,6 +9,8 @@ def initialize
 
     def update(stack, message)
       stack.db.transaction do
+        stack.state = message.state if message.requested?(:state)
+        stack.save
         MetadataUpdate.update(stack, message)
       end
       @logger.info("Finished updating metadata on stack #{stack.guid}")

app/controllers/v3/stacks_controller.rb

@@ -55,6 +55,8 @@ def update
     stack = StackUpdate.new.update(stack, message)
 
     render status: :ok, json: Presenters::V3::StackPresenter.new(stack)
+  rescue StackUpdate::InvalidStack => e
+    unprocessable! e
   end
 
   def show_apps

app/messages/stack_create_message.rb

@@ -2,9 +2,11 @@
 
 module VCAP::CloudController
   class StackCreateMessage < MetadataBaseMessage
-    register_allowed_keys %i[name description]
+    register_allowed_keys %i[name description state]
 
     validates :name, presence: true, length: { maximum: 250 }
     validates :description, length: { maximum: 250 }
+    validates :state, inclusion: { in: %w[ACTIVE DEPRECATED LOCKED DISABLED],
+                                   message: 'must be one of [ACTIVE, DEPRECATED, LOCKED, DISABLED]' }, allow_nil: true
   end
 end

app/messages/stack_update_message.rb

@@ -2,8 +2,11 @@
 
 module VCAP::CloudController
   class StackUpdateMessage < MetadataBaseMessage
-    register_allowed_keys []
+    register_allowed_keys [:state]
 
     validates_with NoAdditionalKeysValidator
+
+    validates :state, inclusion: { in: %w[ACTIVE DEPRECATED LOCKED DISABLED],
+                                   message: 'must be one of [ACTIVE, DEPRECATED, LOCKED, DISABLED]' }, allow_nil: true
   end
 end

app/models/runtime/stack.rb

@@ -26,8 +26,8 @@ class AppsStillPresentError < StandardError
 
     plugin :serialization
 
-    export_attributes :name, :description, :build_rootfs_image, :run_rootfs_image
-    import_attributes :name, :description, :build_rootfs_image, :run_rootfs_image
+    export_attributes :name, :description, :build_rootfs_image, :run_rootfs_image, :state
+    import_attributes :name, :description, :build_rootfs_image, :run_rootfs_image, :state
 
     strip_attributes :name
 
@@ -43,6 +43,7 @@ def around_save
     def validate
       validates_presence :name
       validates_unique :name
+      validates_includes %w[ACTIVE DEPRECATED LOCKED DISABLED], :state, allow_missing: true
     end
 
     def before_destroy
@@ -95,7 +96,7 @@ def self.populate_from_hash(hash)
         stack.set(hash)
         Steno.logger('cc.stack').warn('stack.populate.collision', hash) if stack.modified?
       else
-        create(hash.slice('name', 'description', 'build_rootfs_image', 'run_rootfs_image'))
+        create(hash.slice('name', 'description', 'build_rootfs_image', 'run_rootfs_image', 'state'))
       end
     end
   end

app/presenters/v3/stack_presenter.rb

@@ -14,6 +14,7 @@ def to_hash
         description: stack.description,
         run_rootfs_image: stack.run_rootfs_image,
         build_rootfs_image: stack.build_rootfs_image,
+        state: stack.state,
         default: stack.default?,
         metadata: {
           labels: hashified_labels(stack.labels),

db/migrations/20250724135100_add_state_to_stacks.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:stacks) do
+      add_column :state, String, null: false, default: 'ACTIVE', size: 255
+    end
+  end
+end

devenv.sh

@@ -18,27 +18,27 @@ help_command() {
 
 # Create a clean development environment
 create_command(){
-  docker-compose -p "" down
+  docker compose -p "" down
   docker buildx bake -f docker-compose.yml &
-  docker-compose -p "" pull &
+  docker compose -p "" pull &
   wait $(jobs -p)
-  docker-compose -p "" up -d --build
+  docker compose -p "" up -d --build
   ./.devcontainer/scripts/setupDevelopmentEnvironment.sh
 }
 
 # Start containers
 start_command(){
-  docker-compose -p "" start
+  docker compose -p "" start
 }
 
 # Stop containers
 stop_command(){
-  docker-compose -p "" stop
+  docker compose -p "" stop
 }
 
 # Remove containers
 destroy_command(){
-  docker-compose -p "" down
+  docker compose -p "" down
 }
 
 # Call Setup IDEs Script
@@ -72,7 +72,7 @@ fi
 # Check Prerequisites
 export should_exit=0
 # Check Path Exists
-for p in docker docker-compose ruby bundle mysql psql yq; do
+for p in docker ruby bundle mysql psql yq; do
     if ! command -v "${p}" >/dev/null 2>&1; then
       echo "Error: Dependency \"$p\" is not installed" && export should_exit=1
     fi