cpl 1.0.0 → 1.0.2

data/lib/cpl/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
+  MIN_CPLN_VERSION = "0.0.71"
 end

data/lib/cpl.rb

@@ -40,16 +40,57 @@ end
 module Cpl
   class Error < StandardError; end
 
-  class Cli < Thor
+  class Cli < Thor # rubocop:disable Metrics/ClassLength
     package_name "cpl"
     default_task :no_command
 
     def self.start(*args)
+      check_cpln_version
+      check_cpl_version
       fix_help_option
 
       super(*args)
     end
 
+    def self.check_cpln_version # rubocop:disable Metrics/MethodLength
+      return if @checked_cpln_version
+
+      @checked_cpln_version = true
+
+      result = `cpln --version 2>/dev/null`
+      if $CHILD_STATUS.success?
+        data = JSON.parse(result)
+
+        version = data["npm"]
+        min_version = Cpl::MIN_CPLN_VERSION
+        if Gem::Version.new(version) < Gem::Version.new(min_version)
+          ::Shell.abort("Current 'cpln' version: #{version}. Minimum supported version: #{min_version}. " \
+                        "Please update it with 'npm update -g @controlplane/cli'.")
+        end
+      else
+        ::Shell.abort("Can't find 'cpln' executable. Please install it with 'npm install -g @controlplane/cli'.")
+      end
+    end
+
+    def self.check_cpl_version # rubocop:disable Metrics/MethodLength
+      return if @checked_cpl_version
+
+      @checked_cpl_version = true
+
+      result = `gem search ^cpl$ --remote 2>/dev/null`
+      return unless $CHILD_STATUS.success?
+
+      matches = result.match(/cpl \((.+)\)/)
+      return unless matches
+
+      version = Cpl::VERSION
+      latest_version = matches[1]
+      return unless Gem::Version.new(version) < Gem::Version.new(latest_version)
+
+      ::Shell.warn("You are not using the latest 'cpl' version. Please update it with 'gem update cpl'.")
+      $stderr.puts
+    end
+
     # This is so that we're able to run `cpl COMMAND --help` to print the help
     # (it basically changes it to `cpl --help COMMAND`, which Thor recognizes)
     # Based on https://stackoverflow.com/questions/49042591/how-to-add-help-h-flag-to-thor-command

data/script/update_command_docs

@@ -46,7 +46,7 @@ file_data =
   <<~DATA
     <!-- NOTE: This file is automatically generated by running `script/generate_commands_docs`. Do NOT edit it manually. -->
 
-    ### Common Options
+    ## Common Options
 
     ```
     -a XXX, --app XXX         app ref on Control Plane (GVC)
@@ -55,7 +55,7 @@ file_data =
     This `-a` option is used in most of the commands and will pick all other app configurations from the project-specific
     `.controlplane/controlplane.yml` file.
 
-    ### Commands
+    ## Commands
 
     #{commands_str}
   DATA

data/templates/daily-task.yml

@@ -4,23 +4,24 @@ spec:
   # https://docs.controlplane.com/reference/workload#cron-configuration
   type: cron
   job:
-    # Run daily job at 2am, see cron docs
+    # Run daily job at 2am (see cron docs)
     schedule: 0  2  *  *  *
     # Never or OnFailure
     restartPolicy: Never
   containers:
     - name: daily-task
+      cpu: 50m
+      memory: 256Mi
       args:
         - bundle
         - exec
         - rails
         - db:prepare
-      cpu: 50m
       inheritEnv: true
-      image: '/org/APP_ORG/image/APP_IMAGE'
-      memory: 256Mi
+      image: "/org/APP_ORG/image/APP_IMAGE"
   defaultOptions:
     autoscaling:
+      minScale: 1
       maxScale: 1
     capacityAI: false
   firewallConfig:

data/templates/maintenance.yml

@@ -6,15 +6,16 @@ spec:
     - name: maintenance
       env:
         - name: PORT
-          value: '3000'
+          value: "3000"
         - name: PAGE_URL
-          value: ''
-      image: 'shakacode/maintenance-mode'
+          value: ""
+      image: "shakacode/maintenance-mode"
       ports:
         - number: 3000
           protocol: http
   defaultOptions:
     autoscaling:
+      minScale: 1
       maxScale: 1
     capacityAI: false
     timeoutSeconds: 60

data/templates/memcached.yml

@@ -7,15 +7,16 @@ spec:
       cpu: 3m
       memory: 10Mi
       args:
-        - '-l'
+        - "-l"
         - 0.0.0.0
-      image: 'memcached:alpine'
+      image: "memcached:alpine"
       ports:
         - number: 11211
           protocol: tcp
   defaultOptions:
     autoscaling:
       metric: latency
+      minScale: 1
       maxScale: 1
     capacityAI: false
   firewallConfig:

data/templates/postgres.yml

@@ -13,17 +13,18 @@ spec:
           value: password123
         - name: POSTGRES_USER
           value: postgres
-      image: 'postgres:13.8-alpine'
+      image: "postgres:13.8-alpine"
       ports:
         - number: 5432
           protocol: tcp
       volumes:
         - path: /var/lib/postgresql/data
           recoveryPolicy: retain
-          uri: 'scratch://postgres-vol'
+          uri: "scratch://postgres-vol"
   defaultOptions:
     autoscaling:
       metric: latency
+      minScale: 1
       maxScale: 1
     capacityAI: false
   firewallConfig:

data/templates/rails.yml

@@ -5,14 +5,15 @@ spec:
   containers:
     - name: rails
       cpu: 512m
-      inheritEnv: true
-      image: '/org/APP_ORG/image/APP_IMAGE'
       memory: 1Gi
+      inheritEnv: true
+      image: "/org/APP_ORG/image/APP_IMAGE"
       ports:
         - number: 3000
           protocol: http
   defaultOptions:
     autoscaling:
+      minScale: 1
       maxScale: 1
     capacityAI: false
     timeoutSeconds: 60

data/templates/redis.yml

@@ -6,13 +6,14 @@ spec:
     - name: redis
       cpu: 3m
       memory: 20Mi
-      image: 'redis:latest'
+      image: "redis:latest"
       ports:
         - number: 6379
           protocol: tcp
   defaultOptions:
     autoscaling:
       metric: latency
+      minScale: 1
       maxScale: 1
     capacityAI: false
   firewallConfig:

data/templates/sidekiq.yml

@@ -4,21 +4,30 @@ spec:
   type: standard
   containers:
     - name: sidekiq
+      cpu: 50m
+      memory: 256Mi
       args:
         - bundle
         - exec
         - sidekiq
-        - '-C'
+        - "-C"
         - config/sidekiq.yml
-      cpu: 50m
       inheritEnv: true
-      image: '/org/APP_ORG/image/APP_IMAGE'
-      memory: 256Mi
+      image: "/org/APP_ORG/image/APP_IMAGE"
       ports:
         - number: 7433
           protocol: http
+      lifecycle:
+        preStop:
+          exec:
+            command:
+              - pkill
+              - "-TSTP"
+              - "-f"
+              - ^sidekiq\s
   defaultOptions:
     autoscaling:
+      minScale: 1
       maxScale: 1
     capacityAI: false
   firewallConfig:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -219,9 +219,14 @@ files:
 - bin/cpl
 - cpl
 - cpl.gemspec
+- docs/assets/grafana-alert.png
+- docs/assets/memcached.png
+- docs/assets/sidekiq-pre-stop-hook.png
 - docs/commands.md
+- docs/migrating.md
 - docs/postgres.md
 - docs/redis.md
+- docs/tips.md
 - docs/troubleshooting.md
 - examples/circleci.yml
 - examples/controlplane.yml
@@ -251,6 +256,7 @@ files:
 - lib/command/ps_restart.rb
 - lib/command/ps_start.rb
 - lib/command/ps_stop.rb
+- lib/command/ps_wait.rb
 - lib/command/run.rb
 - lib/command/run_cleanup.rb
 - lib/command/run_detached.rb