cpl 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd7383099c36f633d327424fcb36561e2b925120e63f1b814158a43bd55103f
-  data.tar.gz: eafdf0607fe28d3c24f8132e3a116085020c94639d5b05a5accec4d4de651ca5
+  metadata.gz: 976c390927b51f67afe7a161b7185242261afb4c24db893026457b205fe61b12
+  data.tar.gz: b55bec82c485eb413c9a8787d34172e2c7e89212c15e319f3f626c652c3ac6e7
 SHA512:
-  metadata.gz: b443d26a3fa91400dbb6d2e71b730a26bd1405df2f03e7f9446179323e2becb532ec69d81d93f22578fe8793dbabec9a2283efc16a107decdb5aaa9e4a615281
-  data.tar.gz: 34ab7670bc372af9b8991678de9d99a9c60429b3caebeeeb2775046a9be3d4a7fb7335d9cbeb3a6c2ba06bb29ef40ab7c2cffbcd20737cfb62eb4048b07a8926
+  metadata.gz: 678825b452c56d5c481639de70904ab087f29e362c4b8ced34d3c2131f15a176f78c0c928b02449ebc96a0e69bd1e5c2cd1982577e06a0b62000aa0993bd4f91
+  data.tar.gz: a40e2ea6bfb43122c919d9126d6fffdb6a9722396bed1c4b22b5874d06f9b2126ee4f14e6df37047bb417bcb0788b3b19869d03b34801030b6e8e373f47950c2

data/.rubocop.yml

@@ -14,3 +14,9 @@ Style/Documentation:
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (0.6.0)
+    cpl (0.7.0)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       psych (~> 5.1.0)
@@ -10,14 +10,19 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     childprocess (4.1.0)
+    crack (0.4.5)
+      rexml
     debug (1.7.2)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.8.1)
+    hashdiff (1.0.1)
     iniparse (1.5.0)
     io-console (0.6.0)
     irb (1.6.4)
@@ -32,6 +37,7 @@ GEM
       ast (~> 2.4.1)
     psych (5.1.0)
       stringio
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.2)
@@ -78,8 +84,14 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     stringio (3.0.6)
-    thor (1.2.1)
+    thor (1.2.2)
+    timecop (0.9.6)
     unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -94,6 +106,9 @@ DEPENDENCIES
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.18.1)
   simplecov (~> 0.22.0)
+  timecop (~> 0.9.6)
+  vcr (~> 6.1.0)
+  webmock (~> 3.18.1)
 
 BUNDLED WITH
    2.3.26

data/README.md

@@ -28,11 +28,12 @@ To simplify migration to and usage of Control Plane for Heroku users, this repos
 6. [Environment](#environment)
 7. [Database](#database)
 8. [In-memory databases](#in-memory-databases)
-9. [CLI commands reference](#cli-commands-reference)
-10. [Mapping of Heroku Commands to `cpl` and `cpln`](#mapping-of-heroku-commands-to-cpl-and-cpln)
-11. [Examples](#examples)
-12. [Migrating Postgres database from Heroku infrastructure](/docs/postgres.md)
-13. [Migrating Redis database from Heroku infrastructure](/docs/redis.md)
+9. [Scheduled jobs](#scheduled-jobs)
+10. [CLI commands reference](#cli-commands-reference)
+11. [Mapping of Heroku Commands to `cpl` and `cpln`](#mapping-of-heroku-commands-to-cpl-and-cpln)
+12. [Examples](#examples)
+13. [Migrating Postgres database from Heroku infrastructure](/docs/postgres.md)
+14. [Migrating Redis database from Heroku infrastructure](/docs/redis.md)
 
 ## Key features
 
@@ -105,14 +106,28 @@ Do not confuse the `cpl` CLI with the `cpln` CLI. The `cpl` CLI is the Heroku to
 **Notes:**
 
 1. `myapp` is an app name defined in the `.controlplane/controlplane.yml` file, such as `ror-tutorial` in [this `controlplane.yml` file](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.controlplane/controlplane.yml).
-2. Other files in the `.controlplane/templates` directory are used by the `cpl setup` command.
+2. Other files in the `.controlplane/templates` directory are used by the `cpl setup-app` and `cpl apply-template` commands.
 
 ### Initial Setup and Deployment
 
+Before the initial setup, add the templates for the app to `.controlplane/controlplane.yml`, using the `setup` key:
+
+```yaml
+myapp:
+  setup:
+    - gvc
+    - postgres
+    - redis
+    - memcached
+    - rails
+    - sidekiq
+```
+
+Note how the templates correspond to files in the `.controlplane/templates` directory.
+
 ```sh
 # Provision infrastructure (one-time-only for new apps) using templates.
-# Note how the arguments correspond to files in the `.controlplane/templates` directory.
-cpl setup gvc postgres redis memcached rails sidekiq -a myapp
+cpl setup-app -a myapp
 
 # Build and push image with auto-tagging "myapp:1_456".
 cpl build-image -a myapp --commit 456
@@ -214,7 +229,7 @@ apps:
     <<: *common
     # Use a different organization for production.
     cpln_org: my-org-production
-    # Allows running the command `cpl pipeline-promote my-app-staging` to promote the staging app to production.
+    # Allows running the command `cpl promote-app-from-upstream -a my-app-production` to promote the staging app to production.
     upstream: my-app-staging
   my-app-other:
     <<: *common
@@ -313,6 +328,38 @@ For production purposes or where restarts are not an option, you should use exte
 We provide default `redis` and `memcached` templates in this repo optimized for Control Plane and suitable
 for development purposes.
 
+## Scheduled jobs
+
+Control Plane supports scheduled jobs via [cron workloads](https://docs.controlplane.com/reference/workload#cron).
+
+Here's a partial example of a template for a cron workload, using the app image:
+
+```yaml
+kind: workload
+name: daily-task
+spec:
+  type: cron
+  job:
+    # Run daily job at 2am
+    schedule: 0  2  *  *  *
+    # Never or OnFailure
+    restartPolicy: Never
+  containers:
+    - name: daily-task
+      args:
+        - bundle
+        - exec
+        - rails
+        - db:prepare
+      image: "/org/APP_ORG/image/APP_IMAGE"
+```
+
+A complete example can be found at [templates/daily-task.yml](templates/daily-task.yml), optimized for Control Plane and suitable for development purposes.
+
+You can create the cron workload by adding the template for it to the `.controlplane/templates` folder and running `cpl apply-template my-template -a my-app`, where `my-template` is the name of the template file (`my-template.yml`).
+
+Then to view the logs of the cron workload, you can run `cpl logs -a my-app -w my-template`.
+
 ## CLI commands reference:
 
 Click [here](/docs/commands.md) to see the commands.
@@ -327,17 +374,17 @@ cpl --help
 
 **`[WIP]`**
 
-| Heroku Command                                                                                                 | `cpl` or `cpln` |
-| -------------------------------------------------------------------------------------------------------------- | --------------- |
-| [heroku ps](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-ps-type-type)                     | `cpl ps`        |
-| [heroku config](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-config)                       | ?               |
-| [heroku maintenance](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-maintenance)             | ?               |
-| [heroku logs](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-logs)                           | `cpl logs`      |
-| [heroku pg](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-pg-database)                      | ?               |
-| [heroku pipelines:promote](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-pipelines-promote) | `cpl promote`   |
-| [heroku psql](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-psql-database)                  | ?               |
-| [heroku redis](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-redis-database)                | ?               |
-| [heroku releases](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-releases)                   | ?               |
+| Heroku Command                                                                                                 | `cpl` or `cpln`                 |
+| -------------------------------------------------------------------------------------------------------------- | ------------------------------- |
+| [heroku ps](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-ps-type-type)                     | `cpl ps`                        |
+| [heroku config](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-config)                       | ?                               |
+| [heroku maintenance](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-maintenance)             | `cpl maintenance`               |
+| [heroku logs](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-logs)                           | `cpl logs`                      |
+| [heroku pg](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-pg-database)                      | ?                               |
+| [heroku pipelines:promote](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-pipelines-promote) | `cpl promote-app-from-upstream` |
+| [heroku psql](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-psql-database)                  | ?                               |
+| [heroku redis](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-redis-database)                | ?                               |
+| [heroku releases](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-releases)                   | ?                               |
 
 ## Examples
 

data/Rakefile

@@ -4,11 +4,11 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:rspec)
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[rspec rubocop]
 
 desc "Updates commands.md file"
 task :command_docs do

data/cpl.gemspec

@@ -26,6 +26,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rake",  "~> 0.6.0"
   spec.add_development_dependency "rubocop-rspec", "~> 2.18.1"
   spec.add_development_dependency "simplecov",     "~> 0.22.0"
+  spec.add_development_dependency "timecop",       "~> 0.9.6"
+  spec.add_development_dependency "vcr",           "~> 6.1.0"
+  spec.add_development_dependency "webmock",       "~> 3.18.1"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |file|
     file.match(%r{^(coverage|pkg|spec|tmp)/})

data/docs/commands.md

@@ -39,7 +39,8 @@ cpl apply-template gvc postgres redis rails -a $APP_NAME
 
 - Builds and pushes the image to Control Plane
 - Automatically assigns image numbers, e.g., `app:1`, `app:2`, etc.
-- Uses `.controlplane/Dockerfile`
+- Uses `.controlplane/Dockerfile` or a different Dockerfile specified through `dockerfile` in the `.controlplane/controlplane.yml` file
+- If a commit is provided through `--commit` or `-c`, it will be set as the runtime env var `GIT_COMMIT`
 
 ```sh
 cpl build-image -a $APP_NAME
@@ -167,6 +168,51 @@ cpl logs -a $APP_NAME
 cpl logs -a $APP_NAME -w $WORKLOAD_NAME
 ```
 
+### `maintenance`
+
+- Checks if maintenance mode is on or off for an app
+- Outputs 'on' or 'off'
+- Specify the one-off workload through `one_off_workload` in the `.controlplane/controlplane.yml` file
+- Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+- Maintenance mode is only supported for domains that use path based routing mode and have a route configured for the prefix '/' on either port 80 or 443
+
+```sh
+cpl maintenance -a $APP_NAME
+```
+
+### `maintenance:off`
+
+- Disables maintenance mode for an app
+- Specify the one-off workload through `one_off_workload` in the `.controlplane/controlplane.yml` file
+- Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+- Maintenance mode is only supported for domains that use path based routing mode and have a route configured for the prefix '/' on either port 80 or 443
+
+```sh
+cpl maintenance:off -a $APP_NAME
+```
+
+### `maintenance:on`
+
+- Enables maintenance mode for an app
+- Specify the one-off workload through `one_off_workload` in the `.controlplane/controlplane.yml` file
+- Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+- Maintenance mode is only supported for domains that use path based routing mode and have a route configured for the prefix '/' on either port 80 or 443
+
+```sh
+cpl maintenance:on -a $APP_NAME
+```
+
+### `maintenance:set-page`
+
+- Sets the page for maintenance mode
+- Only works if the maintenance workload uses the `shakacode/maintenance-mode` image
+- Will set the URL as an env var `PAGE_URL` on the maintenance workload
+- Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+
+```sh
+cpl maintenance:set-page PAGE_URL -a $APP_NAME
+```
+
 ### `open`
 
 - Opens the app endpoint URL in the default browser
@@ -244,6 +290,7 @@ cpl ps:stop -a $APP_NAME -w $WORKLOAD_NAME
 - Runs one-off **_interactive_** replicas (analog of `heroku run`)
 - Uses `Standard` workload type and `cpln exec` as the execution method, with CLI streaming
 - May not work correctly with tasks that last over 5 minutes (there's a Control Plane scaling bug at the moment)
+- If `fix_terminal_size` is `true` in the `.controlplane/controlplane.yml` file, the remote terminal size will be fixed to match the local terminal size (may also be overriden through `--terminal-size`)
 
 > **IMPORTANT:** Useful for development where it's needed for interaction, and where network connection drops and
 > task crashing are tolerable. For production tasks, it's better to use `cpl run:detached`.
@@ -252,6 +299,12 @@ cpl ps:stop -a $APP_NAME -w $WORKLOAD_NAME
 # Opens shell (bash by default).
 cpl run -a $APP_NAME
 
+# Need to quote COMMAND if setting ENV value or passing args.
+cpl run 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
+
+# COMMAND may also be passed at the end (in this case, no need to quote).
+cpl run -a $APP_NAME -- rails db:migrate
+
 # Runs command, displays output, and exits shell.
 cpl run ls / -a $APP_NAME
 cpl run rails db:migrate:status -a $APP_NAME
@@ -263,14 +316,25 @@ cpl run rails c -a $APP_NAME
 cpl run rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
 cpl run rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
 
-# Uses a different workload
+# Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
 cpl run bash -a $APP_NAME -w other-workload
 
 # Overrides remote CPLN_TOKEN env variable with local token.
-# Useful when need superuser rights in remote container
+# Useful when superuser rights are needed in remote container.
 cpl run bash -a $APP_NAME --use-local-token
 ```
 
+### `run:cleanup`
+
+- Deletes stale run workloads for an app
+- Workloads are considered stale based on how many days since created
+- `stale_run_workload_created_days` in the `.controlplane/controlplane.yml` file specifies the number of days after created that the workload is considered stale
+- Will ask for explicit user confirmation of deletion
+
+```sh
+cpl run:cleanup -a $APP_NAME
+```
+
 ### `run:detached`
 
 - Runs one-off **_non-interactive_** replicas (close analog of `heroku run:detached`)
@@ -282,9 +346,12 @@ cpl run bash -a $APP_NAME --use-local-token
 ```sh
 cpl run:detached rails db:prepare -a $APP_NAME
 
-# Need to quote COMMAND if setting ENV value or passing args to command to run
+# Need to quote COMMAND if setting ENV value or passing args.
 cpl run:detached 'LOG_LEVEL=warn rails db:migrate' -a $APP_NAME
 
+# COMMAND may also be passed at the end (in this case, no need to quote).
+cpl run:detached -a $APP_NAME -- rails db:migrate
+
 # Uses some other image.
 cpl run:detached rails db:migrate -a $APP_NAME --image /some/full/image/path
 
@@ -295,7 +362,7 @@ cpl run:detached rails db:migrate -a $APP_NAME --image latest
 cpl run:detached rails db:migrate -a $APP_NAME --image appimage:123 # Exact image name
 cpl run:detached rails db:migrate -a $APP_NAME --image latest       # Latest sequential image
 
-# Uses a different workload
+# Uses a different workload than `one_off_workload` from `.controlplane/controlplane.yml`.
 cpl run:detached rails db:migrate:status -a $APP_NAME -w other-workload
 ```
 

data/examples/circleci.yml

@@ -66,7 +66,7 @@ build-review-app:
         name: Provision review app if needed
         command: |
           if ! cpl exist -a ${APP_NAME}; then
-            cpl setup gvc postgres redis memcached rails sidekiq -a ${APP_NAME}
+            cpl setup-app -a ${APP_NAME}
             echo "export NEW_APP=true" >> $BASH_ENV
           fi
     - run:

data/examples/controlplane.yml

@@ -23,6 +23,9 @@ aliases:
       - postgres
       - memcached
 
+    # Configure the workload name used when maintenance mode is on (defaults to 'maintenance')
+    maintenance_workload: maintenance
+
 apps:
   my-app-staging:
     # Use the values from the common section above

data/lib/command/base.rb

@@ -153,6 +153,29 @@ module Command
       }
     end
 
+    def self.terminal_size_option(required: false)
+      {
+        name: :terminal_size,
+        params: {
+          banner: "ROWS,COLS",
+          desc: "Override remote terminal size (e.g. `--terminal-size 10,20`)",
+          type: :string,
+          required: required
+        }
+      }
+    end
+
+    def self.wait_option(title = "", required: false)
+      {
+        name: :wait,
+        params: {
+          desc: "Waits for #{title}",
+          type: :boolean,
+          required: required
+        }
+      }
+    end
+
     def self.all_options
       methods.grep(/_option$/).map { |method| send(method.to_s) }
     end
@@ -185,7 +208,7 @@ module Command
 
     def ensure_workload_deleted(workload)
       progress.puts "- Ensure workload is deleted"
-      cp.workload_delete(workload)
+      cp.delete_workload(workload)
     end
 
     def latest_image_from(items, app_name: config.app, name_only: true)
@@ -212,8 +235,9 @@ module Command
     def latest_image_next(app = config.app, org = config.org)
       @latest_image_next ||= {}
       @latest_image_next[app] ||= begin
-        image = latest_image(app, org).split(":").first
-        image += ":#{extract_image_number(latest_image) + 1}"
+        latest_image_name = latest_image(app, org)
+        image = latest_image_name.split(":").first
+        image += ":#{extract_image_number(latest_image_name) + 1}"
         image += "_#{config.options[:commit]}" if config.options[:commit]
         image
       end
@@ -229,29 +253,44 @@ module Command
       $stderr
     end
 
-    def step(message, abort_on_error: true) # rubocop:disable Metrics/MethodLength
+    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)
+      if success
+        progress.puts(" #{Shell.color('done!', :green)}")
+      else
+        progress.puts(" #{Shell.color('failed!', :red)}\n\n#{Shell.read_from_tmp_stderr}\n\n")
+      end
+    end
+
+    def step(message, abort_on_error: true, retry_on_failure: false) # rubocop:disable Metrics/MethodLength
       progress.print("#{message}...")
 
       Shell.use_tmp_stderr do
         success = false
 
         begin
-          success = yield
-        rescue RuntimeError => e
-          message = e.message
-          if abort_on_error
-            progress.puts(" #{Shell.color('failed!', :red)}\n\n")
-            Shell.abort(message)
+          if retry_on_failure
+            until (success = yield)
+              progress.print(".")
+              sleep 1
+            end
           else
-            Shell.write_to_tmp_stderr(message)
+            success = yield
           end
+        rescue RuntimeError => e
+          step_error(e, abort_on_error: abort_on_error)
         end
 
-        if success
-          progress.puts(" #{Shell.color('done!', :green)}")
-        else
-          progress.puts(" #{Shell.color('failed!', :red)}\n\n#{Shell.read_from_tmp_stderr}\n\n")
-        end
+        step_finish(success)
       end
     end
 

data/lib/command/build_image.rb

@@ -11,18 +11,30 @@ module Command
     LONG_DESCRIPTION = <<~DESC
       - Builds and pushes the image to Control Plane
       - Automatically assigns image numbers, e.g., `app:1`, `app:2`, etc.
-      - Uses `.controlplane/Dockerfile`
+      - Uses `.controlplane/Dockerfile` or a different Dockerfile specified through `dockerfile` in the `.controlplane/controlplane.yml` file
+      - If a commit is provided through `--commit` or `-c`, it will be set as the runtime env var `GIT_COMMIT`
     DESC
 
-    def call
+    def call # rubocop:disable Metrics/MethodLength
       ensure_docker_running!
 
       dockerfile = config.current[:dockerfile] || "Dockerfile"
       dockerfile = "#{config.app_cpln_dir}/#{dockerfile}"
 
+      raise "Can't find Dockerfile at '#{dockerfile}'." unless File.exist?(dockerfile)
+
       progress.puts("Building image from Dockerfile '#{dockerfile}'...\n\n")
 
-      cp.image_build(latest_image_next, dockerfile: dockerfile)
+      image_name = latest_image_next
+      image_url = "#{config.org}.registry.cpln.io/#{image_name}"
+
+      commit = config.options[:commit]
+      build_args = []
+      build_args.push("GIT_COMMIT=#{commit}") if commit
+
+      cp.image_build(image_url, dockerfile: dockerfile, build_args: build_args)
+
+      progress.puts("\nPushed image to '/org/#{config.org}/image/#{image_name}'.")
     end
 
     private

data/lib/command/copy_image_from_upstream.rb

@@ -29,7 +29,7 @@ module Command
       ensure_docker_running!
 
       @upstream = config[:upstream]
-      @upstream_org = config.apps[@upstream.to_sym][:cpln_org] || config.apps[@upstream.to_sym][:org]
+      @upstream_org = config.apps[@upstream.to_sym][:cpln_org]
       ensure_upstream_org!
 
       create_upstream_profile

data/lib/command/info.rb

@@ -90,7 +90,7 @@ module Command
         config.apps.each do |app_name, app_options|
           next if config.app && !app_matches?(config.app, app_name, app_options)
 
-          org = app_options[:cpln_org] || app_options[:org]
+          org = app_options[:cpln_org]
           result.push(org) unless result.include?(org)
         end
       end
@@ -104,7 +104,7 @@ module Command
       config.apps.each do |app_name, app_options|
         next if config.app && !app_matches?(config.app, app_name, app_options)
 
-        app_org = app_options[:cpln_org] || app_options[:org]
+        app_org = app_options[:cpln_org]
         result.push(app_name.to_s) if app_org == org
       end
 
@@ -173,7 +173,11 @@ module Command
       puts "\nSome apps/workloads are missing. Please create them with:"
 
       @missing_apps_workloads.each do |app, workloads|
-        puts "  - `cpl setup #{workloads.join(' ')} -a #{app}`"
+        if workloads.include?("gvc")
+          puts "  - `cpl setup-app -a #{app}`"
+        else
+          puts "  - `cpl apply-template #{workloads.join(' ')} -a #{app}`"
+        end
       end
     end
 
@@ -183,9 +187,9 @@ module Command
       puts "\nThere are no apps starting with some names. If you wish to create any, do so with " \
            "(replace 'whatever' with whatever suffix you want):"
 
-      @missing_apps_starting_with.each do |app, workloads|
+      @missing_apps_starting_with.each do |app, _workloads|
         app_with_suffix = "#{app}#{app.end_with?('-') ? '' : '-'}whatever"
-        puts "  - `cpl setup #{workloads.join(' ')} -a #{app_with_suffix}`"
+        puts "  - `cpl setup-app -a #{app_with_suffix}`"
       end
     end
 

data/lib/command/maintenance.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Command
+  class Maintenance < Base
+    NAME = "maintenance"
+    OPTIONS = [
+      app_option(required: true)
+    ].freeze
+    DESCRIPTION = "Checks if maintenance mode is on or off for an app"
+    LONG_DESCRIPTION = <<~DESC
+      - Checks if maintenance mode is on or off for an app
+      - Outputs 'on' or 'off'
+      - Specify the one-off workload through `one_off_workload` in the `.controlplane/controlplane.yml` file
+      - Optionally specify the maintenance workload through `maintenance_workload` in the `.controlplane/controlplane.yml` file (defaults to 'maintenance')
+      - Maintenance mode is only supported for domains that use path based routing mode and have a route configured for the prefix '/' on either port 80 or 443
+    DESC
+
+    def call # rubocop:disable Metrics/MethodLength
+      one_off_workload = config[:one_off_workload]
+      maintenance_workload = config.current[:maintenance_workload] || "maintenance"
+
+      domain_data = cp.find_domain_for([one_off_workload, maintenance_workload])
+      unless domain_data
+        raise "Can't find domain. " \
+              "Maintenance mode is only supported for domains that use path based routing mode " \
+              "and have a route configured for the prefix '/' on either port 80 or 443."
+      end
+
+      domain_workload = cp.get_domain_workload(domain_data)
+      if domain_workload == maintenance_workload
+        puts "on"
+      else
+        puts "off"
+      end
+    end
+  end
+end