cpflow 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b703678fbaeb6b6300473a8f4529a7c9e62dcc2439ab22cae79abe1a01f83fad
-  data.tar.gz: 9a75cf47df352fce3efe005ebc283d1581befdc5185d8628de8eca0b3df70c5a
+  metadata.gz: 692a5e1a11ae3d172e2adf9cf4da3573f6fa639e69b49d797c8b09d619d1ccb4
+  data.tar.gz: e6a66549f0e5bb67816205a28a6d2df0cd5f8b53a2bf1d2e003985a19da5ce0e
 SHA512:
-  metadata.gz: 26cff99f48b33180c93f3d90d1f726c766f7cf49ed983bb1079cc4260affa95f1e8d8596f21817f910f2abead651fca7856284245d2cb8ae936b100fde7507e9
-  data.tar.gz: aa7160f2cb036ccff1aa99484a5566102331f07cabf0afe6e5fe4f592a0a1de68cb1c205706a694a91e10bc5ff5f2104dd5edc9d235985fd67e136f3a4b2b1f7
+  metadata.gz: 5c855e9908cc2b7cd014b51f7196cabec19f2f950a98c5b9116dfb2fc68b5cd703492864eb4ec9ed9b016ea18d23801feadfe5ea57321e90001fcbd99c7e04d2
+  data.tar.gz: 270f3f96e3a4a61a3875f9410e7116adfe5dc0a08bfccac43ff66b329da629e167a253986444e61c4832088afc65090e50d14da8b00c7a4e57d92ba642835e32

data/.rubocop.yml

@@ -20,3 +20,7 @@ RSpec/ExampleLength:
 
 RSpec/MultipleExpectations:
   Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: true
+  Max: 5

data/CHANGELOG.md

@@ -14,6 +14,19 @@ Changes since the last non-beta release.
 
 _Please add entries here for your pull requests that have not yet been released._
 
+## [4.1.0] - 2024-12-17
+
+### Fixed
+
+- Fixed issue where `run` command fails when runner workload has ENV but original workload does not. [PR 227](https://github.com/shakacode/control-plane-flow/pull/227) by [Rafael Gomes](https://github.com/rafaelgomesxyz).
+- Fixed potential infinite loop that could occur for a command if one of the execution steps fails and gets stuck. [PR 217](https://github.com/shakacode/control-plane-flow/pull/217) by [Zakir Dzhamaliddinov](https://github.com/zzaakiirr).
+- Fixed issue where app cannot be deleted because one of the workloads has a volumeset in-use. [PR 245](https://github.com/shakacode/control-plane-flow/pull/245) by [Zakir Dzhamaliddinov](https://github.com/zzaakiirr).
+- Fixed `resolv` may be not properly required [PR 250](https://github.com/shakacode/control-plane-flow/pull/250) by [Sergey Tarasov](https://github.com/dzirtusss).
+
+### Added
+
+- Added `--docker-context` option to `build-image` command. [PR 250](https://github.com/shakacode/control-plane-flow/pull/250) by [Sergey Tarasov](https://github.com/dzirtusss).
+
 
 ## [4.0.0] - 2024-08-21
 
@@ -263,7 +276,8 @@ Deprecated `cpl` gem. New gem is `cpflow`.
 
 First release.
 
-[Unreleased]: https://github.com/shakacode/control-plane-flow/compare/v4.0.0...HEAD
+[Unreleased]: https://github.com/shakacode/control-plane-flow/compare/v4.1.0...HEAD
+[4.1.0]: https://github.com/shakacode/control-plane-flow/compare/v4.0.0...v4.1.0
 [4.0.0]: https://github.com/shakacode/control-plane-flow/compare/v3.0.1...v4.0.0
 [3.0.1]: https://github.com/shakacode/control-plane-flow/compare/v3.0.0...v3.0.1
 [3.0.0]: https://github.com/shakacode/control-plane-flow/compare/v2.2.4...v3.0.0

data/COMM-LICENSE.txt

@@ -0,0 +1,9 @@
+Control Plane Flow - Commercial Licensing
+
+Control Plane Flow is currently licensed under the GNU Lesser General Public License v3.0, which allows for broad use, including integration with proprietary software, as long as modifications to Control Plane Flow itself are open-sourced.
+
+While there are no current commercial license offerings, ShakaCode LLC reserves the right to offer commercial licenses or additional options in the future. This may include support packages, premium features, or alternative licensing terms.
+
+For any inquiries or expressions of interest in potential commercial licensing, please reach out to ShakaCode LLC at justin@shakacode.com.
+
+You can find the full terms of the GNU Lesser General Public License v3.0 at <http://www.gnu.org/licenses/lgpl-3.0.html>.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpflow (4.0.0)
+    cpflow (4.1.0)
       dotenv (~> 2.8.1)
       jwt (~> 2.8.1)
       psych (~> 5.1.0)

data/LICENSE

@@ -1,21 +1,8 @@
-MIT License
+Copyright (c) 2024 ShakaCode LLC
 
-Copyright (c) 2022 ShakaCode
+Control Plane Flow is an Open Source project licensed under the terms of
+the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Control Plane Flow may offer commercial-friendly licensing options in the future.
+You can find any applicable commercial license terms in COMM-LICENSE.txt.
+For inquiries, please contact justin@shakacode.com.

data/README.md

@@ -1,9 +1,9 @@
 # The power of Kubernetes with the ease of Heroku!
 
-<meta name="author" content="Justin Gordon and Sergey Tarasov">
-<meta name="description" content="Instructions on how to migrate from Heroku to Control Plane and a CLI called cpflow to make it easier.">
-<meta name="copyright" content="ShakaCode, 2023">
-<meta name="keywords" content="Control Plane, Heroku, Kubernetes, K8, Infrastructure">
+<meta name="author" content="Justin Gordon and Sergey Tarasov" />
+<meta name="description" content="Instructions on how to migrate from Heroku to Control Plane and a CLI called cpflow to make it easier." />
+<meta name="copyright" content="ShakaCode, 2023" />
+<meta name="keywords" content="Control Plane, Heroku, Kubernetes, K8, Infrastructure" />
 <meta name="google-site-verification" content="dIV4nMplcYl6YOKOaZMqgvdKXhLJ4cdYY6pS6e_YrPU" />
 
 [![RSpec](https://github.com/shakacode/control-plane-flow/actions/workflows/rspec.yml/badge.svg)](https://github.com/shakacode/control-plane-flow/actions/workflows/rspec.yml)
@@ -12,7 +12,9 @@
 [![Gem](https://badge.fury.io/rb/cpflow.svg)](https://badge.fury.io/rb/cpflow)
 
 
-Enable the [Heroku Flow](https://www.heroku.com/flow) deployment model with [Control Plane](https://shakacode.controlplane.com) using the `cpflow` gem.
+Leverage the power of Kubernetes with the ease of Heroku! The `cpflow` gem enables simple CI configuration for Heroku-style "review apps," staging deployments, and seamless promotion from staging to production. This is similar to the the [Heroku Flow](https://www.heroku.com/flow) deployment model.
+
+Follow the "convention over configuration" philosophy to streamline your deployment workflows and reduce complexity.
 
 ----
 
@@ -20,8 +22,8 @@ _If you need a free demo account for Control Plane (no CC required), you can con
 
 ---
 
-Be sure to see the [demo app](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane)
-If you would like to see the simple YAML configuration and setup,
+Be sure to see the [demo app](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane), which includes simple YAML configurations and setup for `cpflow`.
+
 Also, check [how the `cpflow` gem (this project) is used in the Github actions](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.github/actions/deploy-to-control-plane/action.yml).
 Here is a brief [video overview](https://www.youtube.com/watch?v=llaQoAV_6Iw).
 
@@ -33,11 +35,11 @@ Control Plane's `cpln` CLI.
 Heroku provides a UX and CLI that enables easy publishing of Ruby on Rails and other apps. This ease of use comes via
 many "Heroku" abstractions and naming conventions.
 
-Control Plane, on the other hand, gives you access to raw cloud computing power. However, you need to know precisely how
-to use it.
+Control Plane provides access to raw cloud computing power but lacks the simple abstractions of Heroku. The `cpflow` CLI bridges this gap, delivering a streamlined and familiar experience for developers.
+
+While this repository simplifies migration from Heroku, the `cpflow` CLI is versatile and can be used for new applications as well. It follows a **concept mapping** and **helper CLI** approach to streamline deployment workflows and minimize manual effort.
 
-To simplify migration to and usage of Control Plane for Heroku users, this repository provides a **concept mapping** and
-a **helper CLI** based on templates to save lots of day-to-day typing (and human errors).
+Additionally, the documentation includes numerous examples and practical tips for teams transitioning from Heroku to Kubernetes, helping them make the most of Control Plane's advanced features.
 
 1. [Key Features](#key-features)
 2. [Concept Mapping](#concept-mapping)
@@ -58,8 +60,9 @@ a **helper CLI** based on templates to save lots of day-to-day typing (and human
 
 ## Key Features
 
-- A `cpflow` command to complement the default Control Plane `cpln` command with "Heroku style scripting." The Ruby source
-  can serve as inspiration for your own scripts.
+- The `cpflow` CLI complements the Control Plane `cpln` CLI, enabling "Heroku-style scripting" for review apps, staging, and production environments.
+- Extensive Heroku-to-Control Plane migration examples included in the documentation.
+- Convention-driven configuration to simplify workflows and reduce custom scripting requirements.
 - Easy to understand Heroku to Control Plane conventions in setup and naming.
 - **Safe, production-ready** equivalents of `heroku run` and `heroku run:detached` for Control Plane.
 - Automatic sequential release tagging for Docker images.

data/docs/commands.md

@@ -1,4 +1,4 @@
-<!-- NOTE: This file is automatically generated by running `script/generate_commands_docs`. Do NOT edit it manually. -->
+{ /* Automatically Generated <!-- NOTE: This file is automatically generated by running `script/update_command_docs`. Do NOT edit it manually. --> */}
 
 ## Common Options
 
@@ -431,8 +431,8 @@ cpflow run -a $APP_NAME --entrypoint /app/alternative-entrypoint.sh -- rails db:
 - Creates an app and all its workloads
 - Specify the templates for the app and workloads through `setup_app_templates` in the `.controlplane/controlplane.yml` file
 - This should only be used for temporary apps like review apps, never for persistent apps like production or staging (to update workloads for those, use 'cpflow apply-template' instead)
-- Configures app to have org-level secrets with default name "{APP_PREFIX}-secrets"
-  using org-level policy with default name "{APP_PREFIX}-secrets-policy" (names can be customized, see docs)
+- Configures app to have org-level secrets with default name `"{APP_PREFIX}-secrets"`
+  using org-level policy with default name `"{APP_PREFIX}-secrets-policy"` (names can be customized, see docs)
 - Creates identity for secrets if it does not exist
 - Use `--skip-secrets-setup` to prevent the automatic setup of secrets,
   or set it through `skip_secrets_setup` in the `.controlplane/controlplane.yml` file

data/docs/postgres.md

@@ -25,7 +25,7 @@ And if the database is small or it is a hobby app, this should not be looked any
 However, this is not acceptable for 99% of production apps as their databases are huge and maintenance time
 should be as small as possible.
 
-Rough timing for a 1Gb database can be (but your mileage may vary):
+Rough timing for a 1Tb database can be (but your mileage may vary):
 
 - 2.5h creating Heroku backup
 - 0.5h downloading backup to EC2
@@ -52,7 +52,7 @@ The migration process with Bucardo looks as follows:
 
 Maintenance downtime here can be minutes not hours or days like in p1, but no free lunches - the process is more complex.
 
-Rough timing for a 1Gb database can be (but your mileage may vary):
+Rough timing for a 1Tb database can be (but your mileage may vary):
 
 - whatever setup time, no hurry
 - 1.5 days for onetimecopy (in 1 thread) - DDL changes not allowed, but no downtime

data/lib/command/base.rb

@@ -442,6 +442,17 @@ module Command
         }
       }
     end
+
+    def self.docker_context_option
+      {
+        name: :docker_context,
+        params: {
+          desc: "Path to the docker build context directory",
+          type: :string,
+          required: false
+        }
+      }
+    end
     # rubocop:enable Metrics/MethodLength
 
     def self.all_options
@@ -465,45 +476,50 @@ module Command
       $stderr
     end
 
-    def step_error(error, abort_on_error: true)
-      message = error.message
-      if abort_on_error
-        progress.puts(" #{Shell.color('failed!', :red)}\n\n")
-        Shell.abort(message)
-      else
-        Shell.write_to_tmp_stderr(message)
-      end
-    end
-
-    def step_finish(success)
+    def step_finish(success, abort_on_error: true)
       if success
         progress.puts(" #{Shell.color('done!', :green)}")
       else
         progress.puts(" #{Shell.color('failed!', :red)}\n\n#{Shell.read_from_tmp_stderr}\n\n")
+        exit(ExitCode::ERROR_DEFAULT) if abort_on_error
       end
     end
 
-    def step(message, abort_on_error: true, retry_on_failure: false) # rubocop:disable Metrics/MethodLength
+    def step(message, abort_on_error: true, retry_on_failure: false, max_retry_count: 1000, wait: 1, &block) # rubocop:disable Metrics/MethodLength
       progress.print("#{message}...")
 
       Shell.use_tmp_stderr do
         success = false
 
         begin
-          if retry_on_failure
-            until (success = yield)
-              progress.print(".")
-              Kernel.sleep(1)
+          success =
+            if retry_on_failure
+              with_retry(max_retry_count: max_retry_count, wait: wait, &block)
+            else
+              yield
             end
-          else
-            success = yield
-          end
         rescue RuntimeError => e
-          step_error(e, abort_on_error: abort_on_error)
+          Shell.write_to_tmp_stderr(e.message)
         end
 
-        step_finish(success)
+        step_finish(success, abort_on_error: abort_on_error)
+      end
+    end
+
+    def with_retry(max_retry_count:, wait:)
+      retry_count = 0
+      success = false
+
+      while !success && retry_count <= max_retry_count
+        success = yield
+        break if success
+
+        progress.print(".")
+        Kernel.sleep(wait)
+        retry_count += 1
       end
+
+      success
     end
 
     def cp

data/lib/command/build_image.rb

@@ -5,7 +5,8 @@ module Command
     NAME = "build-image"
     OPTIONS = [
       app_option(required: true),
-      commit_option
+      commit_option,
+      docker_context_option
     ].freeze
     ACCEPTS_EXTRA_OPTIONS = true
     DESCRIPTION = "Builds and pushes the image to Control Plane"
@@ -34,9 +35,12 @@ module Command
       build_args = []
       build_args.push("GIT_COMMIT=#{commit}") if commit
 
+      docker_context = config.options[:docker_context] || config.app_dir
+
       cp.image_build(image_url, dockerfile: dockerfile,
                                 docker_args: config.args,
-                                build_args: build_args)
+                                build_args: build_args,
+                                docker_context: docker_context)
 
       push_path = "/org/#{config.org}/image/#{image_name}"
 

data/lib/command/delete.rb

@@ -106,9 +106,9 @@ module Command
     def delete_volumesets
       @volumesets.each do |volumeset|
         step("Deleting volumeset '#{volumeset['name']}' from app '#{config.app}'") do
-          # If the volumeset is attached to a workload, we need to delete the workload first
-          workload = volumeset.dig("status", "usedByWorkload")&.split("/")&.last
-          cp.delete_workload(workload) if workload
+          # If the volumeset is attached to workloads, we need to delete the workloads first
+          workloads = volumeset.dig("status", "workloadLinks")&.map { |workload_link| workload_link.split("/").last }
+          workloads&.each { |workload| cp.delete_workload(workload) }
 
           cp.delete_volumeset(volumeset["name"])
         end

data/lib/command/deploy_image.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "resolv"
+
 module Command
   class DeployImage < Base
     NAME = "deploy-image"

data/lib/command/run.rb

@@ -207,7 +207,7 @@ module Command
         original_env_str = original_container_spec["env"]&.sort_by { |env| env["name"] }.to_s
         env_str = container_spec["env"]&.sort_by { |env| env["name"] }.to_s
         if original_env_str != env_str
-          container_spec["env"] = original_container_spec["env"]
+          container_spec["env"] = original_container_spec["env"] || []
           should_update = true
         end
 

data/lib/command/setup_app.rb

@@ -14,8 +14,8 @@ module Command
       - Creates an app and all its workloads
       - Specify the templates for the app and workloads through `setup_app_templates` in the `.controlplane/controlplane.yml` file
       - This should only be used for temporary apps like review apps, never for persistent apps like production or staging (to update workloads for those, use 'cpflow apply-template' instead)
-      - Configures app to have org-level secrets with default name "{APP_PREFIX}-secrets"
-        using org-level policy with default name "{APP_PREFIX}-secrets-policy" (names can be customized, see docs)
+      - Configures app to have org-level secrets with default name `"{APP_PREFIX}-secrets"`
+        using org-level policy with default name `"{APP_PREFIX}-secrets-policy"` (names can be customized, see docs)
       - Creates identity for secrets if it does not exist
       - Use `--skip-secrets-setup` to prevent the automatic setup of secrets,
         or set it through `skip_secrets_setup` in the `.controlplane/controlplane.yml` file

data/lib/core/controlplane.rb

@@ -90,7 +90,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
     api.query_images(org: a_org, gvc: a_gvc, gvc_op_type: gvc_op)
   end
 
-  def image_build(image, dockerfile:, docker_args: [], build_args: [])
+  def image_build(image, dockerfile:, docker_context:, docker_args: [], build_args: [])
     # https://docs.controlplane.com/guides/push-image#step-2
     # Might need to use `docker buildx build` if compatiblitity issues arise
     cmd = "docker build --platform=linux/amd64 -t #{image} -f #{dockerfile}"
@@ -98,7 +98,7 @@ class Controlplane # rubocop:disable Metrics/ClassLength
 
     cmd += " #{docker_args.join(' ')}" if docker_args.any?
     build_args.each { |build_arg| cmd += " --build-arg #{build_arg}" }
-    cmd += " #{config.app_dir}"
+    cmd += " #{docker_context}"
 
     perform!(cmd)
   end

data/lib/cpflow/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Cpflow
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
   MIN_CPLN_VERSION = "3.1.0"
 end

data/script/update_command_docs

@@ -44,7 +44,7 @@ commands_str = commands_str_arr.join("\n\n")
 file_path = "#{__dir__}/../docs/commands.md"
 file_data =
   <<~DATA
-    <!-- NOTE: This file is automatically generated by running `script/generate_commands_docs`. Do NOT edit it manually. -->
+    { /* Automatically Generated <!-- NOTE: This file is automatically generated by running `script/update_command_docs`. Do NOT edit it manually. --> */}
 
     ## Common Options
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpflow
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -87,6 +87,7 @@ files:
 - ".rubocop.yml"
 - ".simplecov_spawn.rb"
 - CHANGELOG.md
+- COMM-LICENSE.txt
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock